@companion-module/tools 1.3.2 → 1.4.1

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.4.1](https://github.com/bitfocus/companion-module-tools/compare/v1.4.0...v1.4.1) (2023-09-11)
+
+
+### Bug Fixes
+
+* support for yarn3 ([6ab2458](https://github.com/bitfocus/companion-module-tools/commit/6ab2458c6148da0b1a305e377408b4cb64399dce))
+
+## [1.4.0](https://github.com/bitfocus/companion-module-tools/compare/v1.3.2...v1.4.0) (2023-08-22)
+
+
+### Features
+
+* add option to disable minification. ([9f626f6](https://github.com/bitfocus/companion-module-tools/commit/9f626f69b82b9dc10b195ed076e01f794246f85b))
+
 ## [1.3.2](https://github.com/bitfocus/companion-module-tools/compare/v1.3.1...v1.3.2) (2023-06-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@companion-module/tools",
-	"version": "1.3.2",
+	"version": "1.4.1",
 	"type": "module",
 	"main": "index.js",
 	"license": "MIT",
@@ -25,17 +25,17 @@
 	"dependencies": {
 		"@typescript-eslint/eslint-plugin": "^5.59.9",
 		"@typescript-eslint/parser": "^5.59.9",
-		"eslint": "^8.42.0",
+		"eslint": "^8.47.0",
 		"eslint-config-prettier": "^8.8.0",
-		"eslint-plugin-n": "^16.0.0",
+		"eslint-plugin-n": "^16.0.2",
 		"eslint-plugin-prettier": "^4.2.1",
 		"find-up": "^6.3.0",
 		"parse-author": "^2.0.0",
 		"prettier": "^2.8.8",
 		"tar": "^6.1.15",
-		"webpack": "^5.86.0",
+		"webpack": "^5.88.2",
 		"webpack-cli": "^5.1.4",
-		"zx": "^7.2.2"
+		"zx": "^7.2.3"
 	},
 	"peerDependencies": {
 		"@companion-module/base": "^1.4.1"

package/scripts/build.js

@@ -20,6 +20,7 @@ async function findModuleDir(cwd) {
 }
 
 // const toolsDir = path.join(__dirname, '..')
+const moduleDir = process.cwd()
 const toolsDir = await findModuleDir(require.resolve('@companion-module/tools'))
 const frameworkDir = await findModuleDir(require.resolve('@companion-module/base'))
 console.log(`Building for: ${process.cwd()}`)
@@ -30,17 +31,21 @@ console.log(`Framework path: ${frameworkDir}`)
 // clean old
 await fs.remove('pkg')
 
-const webpackArgs = {}
-if (argv.dev || argv.debug) webpackArgs['env']= 'dev'
+const webpackArgs = {
+	ROOT: moduleDir,
+}
+if (argv.dev || argv.debug) webpackArgs['dev'] = true
 
 const webpackArgsArray = []
 for (const [k, v] of Object.entries(webpackArgs)) {
-	webpackArgsArray.push(`--${k}`, v)
+	webpackArgsArray.push(`--env`, v === true ? k : `${k}=${v}`)
 }
 
 // build the code
+$.cwd = toolsDir
 const webpackConfig = path.join(toolsDir, 'webpack.config.cjs').replace(/\\/g, '/') // Fix slashes because windows is a pain
-await $`yarn webpack -c ${webpackConfig} ${webpackArgsArray}`
+await $`yarn run -B webpack -c ${webpackConfig} ${webpackArgsArray}`
+$.cwd = undefined
 
 // copy in the metadata
 await fs.copy('companion', 'pkg/companion')
@@ -140,16 +145,15 @@ if (webpackConfigJson.node?.__dirname === true) {
 			if (dirPkgJson.dependencies?.['node-gyp-build'] && fs.existsSync(prebuildsDir)) {
 				fs.mkdirpSync(path.join('pkg', thisPath))
 				fs.copySync(prebuildsDir, path.join('pkg', prebuildsDir))
-				
+
 				console.log('copying node-gyp-build prebuilds from', thisPath)
 			}
 		}
 	}
-	
+
 	copyNodeGypBuildPrebuilds('')
 }
 
-
 // Write the package.json
 // packageJson.bundleDependencies = Object.keys(packageJson.dependencies)
 await fs.writeFile('pkg/package.json', JSON.stringify(packageJson))

package/scripts/generate-manifest.js

@@ -77,44 +77,3 @@ if (await fs.pathExists('HELP.md')) {
 	if (await fs.pathExists('images')) await fs.move('images', path.join(manifestDir, 'images'))
 	if (await fs.pathExists('documentation')) await fs.move('documentation', path.join(manifestDir, 'documentation'))
 }
-
-// for (const folder of dirs) {
-// 	if (folder.match(/companion-module-/) && !ignoreNames.includes(folder)) {
-// 		const moduleDir = path.join(outerDir, folder)
-// 		const moduleNewDir = path.join(outerManifest, folder)
-// 		const manifestDir = path.join(moduleNewDir, 'companion')
-
-//
-// 		await fs.mkdirp(manifestDir)
-// 		await fs.writeFile(path.join(manifestDir, 'manifest.json'), JSON.stringify(manifest, undefined, '\t'))
-
-// 		if (await fs.pathExists(( 'HELP.md'))) {
-// 			await fs.copy(( 'HELP.md'), path.join(manifestDir, 'HELP.md'))
-
-// 			// guess at what images might be needed by the help
-// 			if (await fs.pathExists(( 'images')))
-// 				await fs.copy(( 'images'), path.join(manifestDir, 'images'))
-// 			if (await fs.pathExists(( 'documentation')))
-// 				await fs.copy(( 'documentation'), path.join(manifestDir, 'documentation'))
-// 		}
-
-// 		await fs.writeFile(
-// 			path.join(outerEntrypoints, `${pkgJson.name}.cjs`),
-// 			`
-// global.modulePkg = require('companion-module-${pkgJson.name}/package.json')
-// global.moduleFactory = require('companion-module-${pkgJson.name}')
-// global.moduleName = "${pkgJson.name}"
-// import('../../dist/index.js')
-// 			`
-// 		)
-// 	}
-// }
-
-// console.log('Bundling code. This will take a couple of minutes')
-// await $`yarn webpack`
-
-// // trick node into treating them all as cjs
-// await fs.writeFile(`manifests/package.json`, '')
-
-// // const useDir = await fs.pathExists('./module/legacy')
-// // const baseDir = useDir ? './module/legacy' : './node_modules/companion-wrapped-module'

package/webpack.config.cjs

@@ -1,24 +1,26 @@
 const path = require('path')
 
-const frameworkDir = path.relative(process.cwd(), path.resolve('@companion-module/base'))
-const pkgJson = require(path.join(process.cwd(), 'package.json'))
+module.exports = async (env) => {
+	if (!env.ROOT) throw new Error(`Missing ROOT`)
 
-if (!pkgJson.main) throw new Error(`Missing main in package.json`)
+	const frameworkDir = path.relative(env.ROOT, path.resolve('@companion-module/base'))
+	const pkgJson = require(path.join(env.ROOT, 'package.json'))
 
-let webpackExt = {}
-try {
-	webpackExt = require(path.join(process.cwd(), 'build-config.cjs'))
+	if (!pkgJson.main) throw new Error(`Missing main in package.json`)
 
-	console.log('Found additional webpack configuration')
-} catch (e) {
-	// Ignore
-}
+	let webpackExt = {}
+	try {
+		webpackExt = require(path.join(env.ROOT, 'build-config.cjs'))
+
+		console.log('Found additional webpack configuration')
+	} catch (e) {
+		// Ignore
+	}
 
-let externalsExt = []
-if (Array.isArray(webpackExt.externals)) externalsExt = webpackExt.externals
-else if (webpackExt.externals) externalsExt = [webpackExt.externals]
+	let externalsExt = []
+	if (Array.isArray(webpackExt.externals)) externalsExt = webpackExt.externals
+	else if (webpackExt.externals) externalsExt = [webpackExt.externals]
 
-module.exports = async (env) => {
 	return {
 		entry: {
 			main: './' + pkgJson.main, // path.join(frameworkDir, 'dist/entrypoint.js'),
@@ -28,9 +30,9 @@ module.exports = async (env) => {
 		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'),
+			path: path.resolve(env.ROOT, 'pkg'),
 		},
-		context: path.resolve(process.cwd(), '.'),
+		context: path.resolve(env.ROOT, '.'),
 		target: 'node',
 		externals: [
 			// Allow for custom externals
@@ -39,6 +41,9 @@ module.exports = async (env) => {
 		experiments: {
 			topLevelAwait: true,
 		},
+optimization: {
+			minimize: !webpackExt.disableMinifier,
+		},
 		module: {
 			rules: [
 				// {
@@ -58,8 +63,10 @@ module.exports = async (env) => {
 			// Let modules define additional plugins. Hopefully this won't conflict with anything we add
 			...(webpackExt.plugins || []),
 		],
-		node: webpackExt.useOriginalStructureDirname ? {
-			__dirname: true
-		} : undefined,
+		node: webpackExt.useOriginalStructureDirname
+			? {
+					__dirname: true,
+			  }
+			: undefined,
 	}
 }