@companion-module/tools 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [2.2.0](https://github.com/bitfocus/companion-module-tools/compare/v2.1.1...v2.2.0) (2025-03-06)
+
+
+### Features
+
+* add --prerelease flag ([de5cf7d](https://github.com/bitfocus/companion-module-tools/commit/de5cf7d29c81fd8695773b38dcb560a814d311af))
+* changed default output of build script to ${package}-${version}.tgz. Added flag -l keeping the legacy behaviour with fileoutput pkg.tgz ([#57](https://github.com/bitfocus/companion-module-tools/issues/57)) ([260a0ff](https://github.com/bitfocus/companion-module-tools/commit/260a0ff61c66611821fc66a5dfbd45c44ec08de6))
+* user definable build filename ([199a9bd](https://github.com/bitfocus/companion-module-tools/commit/199a9bd11c01d0b0e6c8007ca951cc00591b9fad))
+
+## [2.1.1](https://github.com/bitfocus/companion-module-tools/compare/v2.1.0...v2.1.1) (2024-12-17)
+
+
+### Bug Fixes
+
+* add tsconfig for node22 ([8e0a7b1](https://github.com/bitfocus/companion-module-tools/commit/8e0a7b1d29e5f17d7df18d20f487c452797b7d38))
+
 ## [2.1.0](https://github.com/bitfocus/companion-module-tools/compare/v2.0.4...v2.1.0) (2024-09-23)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@companion-module/tools",
-	"version": "2.1.0",
+	"version": "2.2.0",
 	"type": "module",
 	"main": "index.js",
 	"license": "MIT",
@@ -26,16 +26,17 @@
 		"webpack.*"
 	],
 	"dependencies": {
-		"@eslint/js": "^9.10.0",
-		"eslint-config-prettier": "^9.1.0",
-		"eslint-plugin-n": "^17.10.2",
-		"eslint-plugin-prettier": "^5.2.1",
+		"@eslint/js": "^9.19.0",
+		"eslint-config-prettier": "^10.0.1",
+		"eslint-plugin-n": "^17.15.1",
+		"eslint-plugin-prettier": "^5.2.3",
 		"find-up": "^7.0.0",
 		"parse-author": "^2.0.0",
+		"semver": "^7.7.1",
 		"tar": "^7.4.3",
-		"webpack": "^5.94.0",
-		"webpack-cli": "^5.1.4",
-		"zx": "^8.1.6"
+		"webpack": "^5.97.1",
+		"webpack-cli": "^6.0.1",
+		"zx": "^8.3.2"
 	},
 	"peerDependencies": {
 		"@companion-module/base": "^1.11.0",
@@ -56,9 +57,9 @@
 	},
 	"devDependencies": {
 		"@types/eslint": "^9.6.1",
-		"eslint": "^9.10.0",
-		"prettier": "^3.3.3",
-		"typescript-eslint": "^8.5.0"
+		"eslint": "^9.19.0",
+		"prettier": "^3.4.2",
+		"typescript-eslint": "^8.23.0"
 	},
-	"packageManager": "yarn@4.4.1"
+	"packageManager": "yarn@4.5.3"
 }

package/scripts/build.js

@@ -8,11 +8,21 @@ import { findUp } from 'find-up'
 import * as tar from 'tar'
 import { validateManifest } from '@companion-module/base'
 import { createRequire } from 'module'
+import * as semver from 'semver'
 
 if (process.platform === 'win32') {
 	usePowerShell() // to enable powershell
 }
 
+if (argv.help) {
+	console.log('Usage: build.js [--dev] [--prerelease]')
+	console.log('Builds the companion module')
+	console.log('  --dev: Build in development mode. This will not minify the code, making it easier to debug.')
+	console.log('  --prerelease: Build in prerelease mode. This gets added as metadata to the manifest')
+	console.log('  --output <filename>: Output to a specific filename, without a file extension')
+	process.exit(0)
+}
+
 const require = createRequire(import.meta.url)
 
 async function findModuleDir(cwd) {
@@ -35,6 +45,11 @@ console.log(`Framework path: ${frameworkDir}`)
 // clean old
 await fs.remove('pkg')
 
+// create new
+await fs.mkdir(`pkg`)
+
+const packageBaseDir = path.join('pkg')
+
 const webpackArgs = {
 	ROOT: moduleDir,
 }
@@ -53,7 +68,7 @@ await $`npx webpack -c ${webpackConfig} ${webpackArgsArray}`
 $.cwd = undefined
 
 // copy in the metadata
-await fs.copy('companion', 'pkg/companion')
+await fs.copy('companion', path.join(packageBaseDir, 'companion'))
 
 const srcPackageJson = JSON.parse(await fs.readFile(path.resolve('./package.json')))
 const frameworkPackageJson = JSON.parse(await fs.readFile(path.join(frameworkDir, 'package.json')))
@@ -64,7 +79,13 @@ manifestJson.runtime.entrypoint = '../main.js'
 manifestJson.version = srcPackageJson.version
 manifestJson.runtime.api = 'nodejs-ipc'
 manifestJson.runtime.apiVersion = frameworkPackageJson.version
-await fs.writeFile(path.resolve('./pkg/companion/manifest.json'), JSON.stringify(manifestJson))
+
+// Bake in the prerelease flag if using module-base which is new enough
+if (semver.gt(manifestJson.runtime.apiVersion, '1.12.0-0')) {
+	manifestJson.isPreRelease = !!argv.prerelease
+}
+
+await fs.writeFile(path.join(packageBaseDir, 'companion/manifest.json'), JSON.stringify(manifestJson))
 
 // Make sure the manifest is valid
 try {
@@ -113,13 +134,13 @@ if (fs.existsSync(webpackExtPath)) {
 
 	// Copy across any prebuilds that can be loaded corectly
 	if (webpackExt.prebuilds) {
-		await fs.mkdir('pkg/prebuilds')
+		await fs.mkdir(path.join(packageBaseDir, 'prebuilds'))
 
 		for (const lib of webpackExt.prebuilds) {
 			const srcDir = await findModuleDir(require.resolve(lib))
 			const dirs = await fs.readdir(path.join(srcDir, 'prebuilds'))
 			for (const dir of dirs) {
-				await fs.copy(path.join(srcDir, 'prebuilds', dir), path.join('pkg/prebuilds', dir))
+				await fs.copy(path.join(srcDir, 'prebuilds', dir), path.join(packageBaseDir, 'prebuilds', dir))
 			}
 		}
 	}
@@ -132,7 +153,7 @@ if (fs.existsSync(webpackExtPath)) {
 		})
 
 		for (const file of files) {
-			await fs.copy(file, path.join('pkg', path.basename(file)), {
+			await fs.copy(file, path.join(packageBaseDir, path.basename(file)), {
 				overwrite: false,
 			})
 		}
@@ -158,8 +179,8 @@ if (webpackConfigJson.node?.__dirname === true) {
 
 			const prebuildsDir = path.join(thisPath, 'prebuilds')
 			if (dirPkgJson.dependencies?.['node-gyp-build'] && fs.existsSync(prebuildsDir)) {
-				fs.mkdirpSync(path.join('pkg', thisPath))
-				fs.copySync(prebuildsDir, path.join('pkg', prebuildsDir))
+				fs.mkdirpSync(path.join(packageBaseDir, thisPath))
+				fs.copySync(prebuildsDir, path.join(packageBaseDir, prebuildsDir))
 
 				console.log('copying node-gyp-build prebuilds from', thisPath)
 			}
@@ -171,20 +192,28 @@ if (webpackConfigJson.node?.__dirname === true) {
 
 // Write the package.json
 // packageJson.bundleDependencies = Object.keys(packageJson.dependencies)
-await fs.writeFile('pkg/package.json', JSON.stringify(packageJson))
+await fs.writeFile(path.join(packageBaseDir, 'package.json'), JSON.stringify(packageJson))
 
 // If we found any depenendencies for the pkg, install them
 if (Object.keys(packageJson.dependencies).length) {
-	await fs.writeFile('pkg/yarn.lock', '')
-	await $`yarn --cwd pkg install --no-immutable`
+	await fs.writeFile(path.join(packageBaseDir, 'yarn.lock'), '')
+	await $`yarn --cwd ${packageBaseDir} install --no-immutable`
 }
 
 // Create tgz of the build
+let tgzFile = `${manifestJson.name}-${manifestJson.version}`
+if (typeof argv['output'] === 'string') {
+	// -o flag, to allow legacy behaviour creating pkg.tgz output
+	tgzFile = argv['output']
+}
+tgzFile += '.tgz'
+console.log('Writing compressed package output to', tgzFile)
+
 await tar
 	.create(
 		{
 			gzip: true,
 		},
-		['pkg'],
+		[packageBaseDir],
 	)
 	.pipe(fs.createWriteStream('pkg.tgz'))

package/tsconfig/node22/recommended.json

@@ -0,0 +1,30 @@
+{
+	"compilerOptions": {
+		"module": "commonjs",
+		"target": "es2022",
+		"noImplicitAny": true,
+		"moduleResolution": "node",
+		"sourceMap": true,
+		"paths": {
+			"*": ["../node_modules/*"]
+		},
+		"declaration": false,
+		"importHelpers": false,
+		"listFiles": false,
+		"traceResolution": false,
+		"pretty": true,
+		"lib": ["es2023"],
+		"types": ["node"],
+		"strict": true,
+		"alwaysStrict": false,
+		"forceConsistentCasingInFileNames": true,
+		"noFallthroughCasesInSwitch": true,
+		"noImplicitReturns": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+		"skipLibCheck": true,
+		"allowSyntheticDefaultImports": true,
+		"esModuleInterop": true
+	},
+	"compileOnSave": false
+}

package/webpack.config.cjs

@@ -41,7 +41,7 @@ module.exports = async (env) => {
 		experiments: {
 			topLevelAwait: true,
 		},
-optimization: {
+		optimization: {
 			minimize: !webpackExt.disableMinifier,
 		},
 		module: {
@@ -66,7 +66,7 @@ optimization: {
 		node: webpackExt.useOriginalStructureDirname
 			? {
 					__dirname: true,
-			  }
+				}
 			: undefined,
 	}
 }