@companion-module/tools 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [1.1.0](https://github.com/bitfocus/companion-module-tools/compare/v1.0.2...v1.1.0) (2023-02-22)
+
+
+### Features
+
+* add `--dev` parameter to produce a `development` webpack build ([ffb36bc](https://github.com/bitfocus/companion-module-tools/commit/ffb36bcd9cb5109eed0bbb05da22b4ea00745b34))
+* allow modules to specify additional webpack plugins ([3dc1f5f](https://github.com/bitfocus/companion-module-tools/commit/3dc1f5f0da879c31dab0395ac6d012ad810ad4ad))
+
 ## [1.0.2](https://github.com/bitfocus/companion-module-tools/compare/v1.0.1...v1.0.2) (2023-02-19)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@companion-module/tools",
-	"version": "1.0.2",
+	"version": "1.1.0",
 	"type": "module",
 	"main": "index.js",
 	"license": "MIT",

package/scripts/build.js

@@ -30,9 +30,12 @@ console.log(`Framework path: ${frameworkDir}`)
 // clean old
 await fs.remove('pkg')
 
+const webpackArgs = []
+if (argv.dev) webpackArgs.push('--env', 'dev')
+
 // build the code
 const webpackConfig = path.join(toolsDir, 'webpack.config.cjs').replace(/\\/g, '/') // Fix slashes because windows is a pain
-await $`yarn webpack -c ${webpackConfig}`
+await $`yarn webpack -c ${webpackConfig} ${webpackArgs}`
 
 // copy in the metadata
 await fs.copy('companion', 'pkg/companion')

package/webpack.config.cjs

@@ -18,40 +18,45 @@ let externalsExt = []
 if (Array.isArray(webpackExt.externals)) externalsExt = webpackExt.externals
 else if (webpackExt.externals) externalsExt = [webpackExt.externals]
 
-module.exports = {
-	entry: {
-		main: './' + pkgJson.main, // path.join(frameworkDir, 'dist/entrypoint.js'),
-		// Allow for custom entrypoints
-		...webpackExt.entry,
-	},
-	mode: 'production',
-	// devtool: 'source-map', // TODO - this would be nice, but I think the files have to be uploaded directly to sentry which is problematic...
-	// mode: 'development',
-	output: {
-		path: path.resolve(process.cwd(), 'pkg'),
-	},
-	context: path.resolve(process.cwd(), '.'),
-	target: 'node',
-	externals: [
-		// Allow for custom externals
-		...externalsExt,
-	],
-	experiments: {
-		topLevelAwait: true,
-	},
-	module: {
-		rules: [
-			// {
-			// 	test: /\.json$/,
-			// 	type: 'asset/source',
-			// },
-			// {
-			// 	test: /BUILD$/,
-			// 	type: 'asset/resource',
-			// 	generator: {
-			// 		filename: 'BUILD',
-			// 	},
-			// },
+module.exports = async (env) => {
+	return {
+		entry: {
+			main: './' + pkgJson.main, // path.join(frameworkDir, 'dist/entrypoint.js'),
+			// Allow for custom entrypoints
+			...webpackExt.entry,
+		},
+		mode: env.dev ? 'development' : 'production',
+		// devtool: env.dev ? undefined : 'source-map', // TODO - this would be nice, but I think the files have to be uploaded directly to sentry which is problematic...
+		output: {
+			path: path.resolve(process.cwd(), 'pkg'),
+		},
+		context: path.resolve(process.cwd(), '.'),
+		target: 'node',
+		externals: [
+			// Allow for custom externals
+			...externalsExt,
 		],
-	},
+		experiments: {
+			topLevelAwait: true,
+		},
+		module: {
+			rules: [
+				// {
+				// 	test: /\.json$/,
+				// 	type: 'asset/source',
+				// },
+				// {
+				// 	test: /BUILD$/,
+				// 	type: 'asset/resource',
+				// 	generator: {
+				// 		filename: 'BUILD',
+				// 	},
+				// },
+			],
+		},
+		plugins: [
+			// Let modules define additional plugins. Hopefully this won't conflict with anything we add
+			...(webpackExt.plugins || []),
+		],
+	}
 }