Skip to content

Instantly share code, notes, and snippets.

@luiguild
Last active February 27, 2024 22:11
Show Gist options
  • Save luiguild/a473226af1e64b1429e14602421fb19a to your computer and use it in GitHub Desktop.
Save luiguild/a473226af1e64b1429e14602421fb19a to your computer and use it in GitHub Desktop.
NS 7 + Vue - webpack.config.js with HMR in <template> and <style>
const { join, relative, resolve, sep } = require('path')
const webpack = require('webpack')
const { CleanWebpackPlugin } = require('clean-webpack-plugin')
const CopyWebpackPlugin = require('copy-webpack-plugin')
const { BundleAnalyzerPlugin } = require('webpack-bundle-analyzer')
const TerserPlugin = require('terser-webpack-plugin')
const VueLoaderPlugin = require('vue-loader/lib/plugin')
const NsVueTemplateCompiler = require('nativescript-vue-template-compiler')
const nsWebpack = require('@nativescript/webpack')
const nativescriptTarget = require('@nativescript/webpack/nativescript-target')
const { NativeScriptWorkerPlugin } = require('nativescript-worker-loader/NativeScriptWorkerPlugin')
const hashSalt = Date.now().toString()
module.exports = env => {
// Add your custom Activities, Services and other android app components here.
const appComponents = env.appComponents || []
appComponents.push(...[
'@nativescript/core/ui/frame',
'@nativescript/core/ui/frame/activity'
])
const platform = env && ((env.android && 'android') || (env.ios && 'ios') || env.platform)
if (!platform) {
throw new Error('You need to provide a target platform!')
}
const platforms = ['ios', 'android']
const projectRoot = __dirname
if (env.platform) {
platforms.push(env.platform)
}
// Default destination inside platforms/<platform>/...
const dist = resolve(projectRoot, nsWebpack.getAppPath(platform, projectRoot))
const {
// The 'appPath' and 'appResourcesPath' values are fetched from
// the nsconfig.json configuration file.
appPath = 'src',
appResourcesPath = 'src/App_Resources',
// You can provide the following flags when running 'tns run android|ios'
snapshot, // --env.snapshot
production, // --env.production
report, // --env.report
hmr, // --env.hmr
sourceMap, // --env.sourceMap
hiddenSourceMap, // --env.hiddenSourceMap
unitTesting, // --env.unitTesting
testing, // --env.testing
verbose, // --env.verbose
snapshotInDocker, // --env.snapshotInDocker
skipSnapshotTools, // --env.skipSnapshotTools
compileSnapshot // --env.compileSnapshot
} = env
const useLibs = compileSnapshot
const isAnySourceMapEnabled = !!sourceMap || !!hiddenSourceMap
const externals = nsWebpack.getConvertedExternals(env.externals)
const mode = production ? 'production' : 'development'
const appFullPath = resolve(projectRoot, appPath)
const hasRootLevelScopedModules = nsWebpack.hasRootLevelScopedModules({ projectDir: projectRoot })
let coreModulesPackageName = 'tns-core-modules'
const alias = env.alias || {}
alias['~/package.json'] = resolve(projectRoot, 'package.json')
alias['~'] = appFullPath
alias['@'] = appFullPath
alias['vue'] = 'nativescript-vue'
if (hasRootLevelScopedModules) {
coreModulesPackageName = '@nativescript/core'
alias['tns-core-modules'] = coreModulesPackageName
}
const appResourcesFullPath = resolve(projectRoot, appResourcesPath)
const copyIgnore = { ignore: [`${relative(appPath, appResourcesFullPath)}/**`] }
const entryModule = nsWebpack.getEntryModule(appFullPath, platform)
const entryPath = `.${sep}${entryModule}`
const entries = env.entries || {}
entries.bundle = entryPath
const areCoreModulesExternal = Array.isArray(env.externals) && env.externals.some(e => e.indexOf('@nativescript') > -1)
if (platform === 'ios' && !areCoreModulesExternal && !testing) {
entries['tns_modules/@nativescript/core/inspector_modules'] = 'inspector_modules'
}
console.log(`Bundling application for entryPath ${entryPath}...`)
let sourceMapFilename = nsWebpack.getSourceMapFilename(hiddenSourceMap, __dirname, dist)
const itemsToClean = [`${dist}/**/*`]
if (platform === 'android') {
itemsToClean.push(`${join(projectRoot, 'platforms', 'android', 'src', 'main', 'assets', 'snapshots')}`)
itemsToClean.push(`${join(projectRoot, 'platforms', 'android', 'src', 'build', 'configurations', 'nativescript-android-snapshot')}`)
}
nsWebpack.processAppComponents(appComponents, platform)
const config = {
mode: mode,
context: appFullPath,
externals,
watchOptions: {
ignored: [
appResourcesFullPath,
// Don't watch hidden files
'**/.*'
]
},
target: nativescriptTarget,
// target: nativeScriptVueTarget,
entry: entries,
output: {
pathinfo: false,
path: dist,
sourceMapFilename,
libraryTarget: 'commonjs2',
filename: '[name].js',
globalObject: 'global',
hashSalt
},
resolve: {
extensions: ['.vue', '.ts', '.js', '.scss', '.sass', '.css', '.pug'],
// Resolve {N} system modules from @nativescript/core
modules: [
resolve(__dirname, `node_modules/${coreModulesPackageName}`),
resolve(__dirname, 'node_modules'),
`node_modules/${coreModulesPackageName}`,
'node_modules'
],
alias,
// resolve symlinks to symlinked modules
symlinks: true
},
resolveLoader: {
// don't resolve symlinks to symlinked loaders
symlinks: false
},
node: {
// Disable node shims that conflict with NativeScript
'http': false,
'timers': false,
'setImmediate': false,
'fs': 'empty',
'__dirname': false
},
devtool: hiddenSourceMap ? 'hidden-source-map' : (sourceMap ? 'inline-source-map' : 'none'),
optimization: {
runtimeChunk: 'single',
noEmitOnErrors: true,
splitChunks: {
cacheGroups: {
vendor: {
name: 'vendor',
chunks: 'all',
test: (module) => {
const moduleName = module.nameForCondition ? module.nameForCondition() : ''
return /[\\/]node_modules[\\/]/.test(moduleName) ||
appComponents.some(comp => comp === moduleName)
},
enforce: true
}
}
},
minimize: Boolean(production),
minimizer: [
new TerserPlugin({
parallel: true,
cache: true,
sourceMap: isAnySourceMapEnabled,
terserOptions: {
output: {
comments: false,
semicolons: !isAnySourceMapEnabled
},
compress: {
// The Android SBG has problems parsing the output
// when these options are enabled
'collapse_vars': platform !== 'android',
sequences: platform !== 'android'
},
keep_fnames: true
}
})
]
},
module: {
rules: [
{
include: [join(appFullPath, entryPath + '.js'), join(appFullPath, entryPath + '.ts')],
use: [
// Require all Android app components
platform === 'android' && {
loader: '@nativescript/webpack/helpers/android-app-components-loader',
options: { modules: appComponents }
},
{
loader: '@nativescript/webpack/bundle-config-loader',
options: {
registerPages: true, // applicable only for non-angular apps
loadCss: !snapshot, // load the application css if in debug mode
unitTesting,
appFullPath,
projectRoot,
ignoredFiles: nsWebpack.getUserDefinedEntries(entries, platform)
}
}
].filter(loader => Boolean(loader))
},
{
test: /\.(sass|scss)$/,
use: [
'@nativescript/webpack/helpers/style-hot-loader',
'@nativescript/webpack/helpers/apply-css-loader',
{
loader: 'css-loader',
options: {
url: false
}
},
{
loader: 'sass-loader',
options: {
sassOptions: {
indentedSyntax: true
}
}
}
]
},
{
test: /\.css$/,
use: [
'@nativescript/webpack/helpers/style-hot-loader',
'@nativescript/webpack/helpers/apply-css-loader',
{
loader: 'css-loader',
options: {
url: false
}
}
]
},
{
test: /\.js$/,
use: [
'babel-loader',
'@nativescript/webpack/helpers/script-hot-loader'
]
},
{
test: /\.pug$/,
oneOf: [
{
resourceQuery: /^\?vue/,
use: [
'pug-plain-loader'
]
},
{
use: [
'raw-loader',
'pug-plain-loader'
]
}
]
},
{
test: /\.vue$/,
loader: 'vue-loader',
options: {
compiler: NsVueTemplateCompiler
}
},
{
test: /\.ts$/,
use: [
'@nativescript/webpack/helpers/script-hot-loader',
{
loader: 'ts-loader',
options: {
appendTsSuffixTo: [/\.vue$/],
allowTsInNodeModules: true,
compilerOptions: {
declaration: false
},
getCustomTransformers: (program) => ({
before: [
require(
'@nativescript/webpack/transformers/ns-transform-native-classes'
).default
]
})
}
}
]
}
]
},
plugins: [
// ... Vue Loader plugin omitted
// make sure to include the plugin!
new VueLoaderPlugin(),
// Define useful constants like TNS_WEBPACK
new webpack.DefinePlugin({
'global.TNS_WEBPACK': 'true',
'global.isAndroid': platform === 'android',
'global.isIOS': platform === 'ios',
'TNS_ENV': JSON.stringify(mode),
'process': 'global.process'
}),
// Remove all files from the out dir.
new CleanWebpackPlugin({
cleanOnceBeforeBuildPatterns: itemsToClean,
verbose: !!verbose
}),
// Copy assets
new CopyWebpackPlugin([
{ from: { glob: 'assets/**', dot: false } },
{ from: { glob: 'fonts/**', dot: false } },
{ from: { glob: '**/*.+(jpg|png)', dot: false } }
], copyIgnore),
new nsWebpack.GenerateNativeScriptEntryPointsPlugin('bundle'),
// For instructions on how to set up workers with webpack
// check out https://github.com/nativescript/worker-loader
new NativeScriptWorkerPlugin(),
new nsWebpack.PlatformFSPlugin({
platform,
platforms
}),
// Does IPC communication with the {N} CLI to notify events when running in watch mode.
new nsWebpack.WatchStateLoggerPlugin()
]
}
if (unitTesting) {
config.module.rules.push(
{
test: /\.js$/,
use: '@nativescript/webpack/helpers/script-hot-loader'
},
{
test: /\.(html|xml)$/,
use: '@nativescript/webpack/helpers/markup-hot-loader'
},
{ test: /\.(html|xml)$/, use: '@nativescript/webpack/helpers/xml-namespace-loader' }
)
}
if (report) {
// Generate report files for bundles content
config.plugins.push(new BundleAnalyzerPlugin({
analyzerMode: 'static',
openAnalyzer: false,
generateStatsFile: true,
reportFilename: resolve(projectRoot, 'report', `report.html`),
statsFilename: resolve(projectRoot, 'report', `stats.json`)
}))
}
if (snapshot) {
config.plugins.push(new nsWebpack.NativeScriptSnapshotPlugin({
chunk: 'vendor',
requireModules: [
'@nativescript/core/bundle-entry-points'
],
projectRoot,
webpackConfig: config,
snapshotInDocker,
skipSnapshotTools,
useLibs
}))
}
if (hmr) {
config.plugins.push(new webpack.HotModuleReplacementPlugin())
}
return config
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment