@companion-module/tools 0.5.1 → 1.0.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [1.0.0](https://github.com/bitfocus/companion-module-tools/compare/v0.5.2...v1.0.0) (2023-02-05)
+
+
+### ⚠ BREAKING CHANGES
+
+* rename webpack-ext.cjs to build-config.cjs
+
+### Features
+
+* rename webpack-ext.cjs to build-config.cjs ([c8864cd](https://github.com/bitfocus/companion-module-tools/commit/c8864cd55306a4ae60c6602cf7c73bf81eb585be))
+* support including 'extraFiles' in the built pkg ([b130f57](https://github.com/bitfocus/companion-module-tools/commit/b130f572a13ddef49596ba0a4103d18d22b8a231))
+
+## [0.5.2](https://github.com/bitfocus/companion-module-tools/compare/v0.5.1...v0.5.2) (2023-01-10)
+
+
+### Bug Fixes
+
+* scripts unable to resolve dependencies ([312caf3](https://github.com/bitfocus/companion-module-tools/commit/312caf36f42bb17965fc010e80bd2184c4bf8a62))
+
 ## [0.5.1](https://github.com/bitfocus/companion-module-tools/compare/v0.5.0...v0.5.1) (2022-12-01)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@companion-module/tools",
-	"version": "0.5.1",
+	"version": "1.0.0",
 	"type": "module",
 	"main": "index.js",
 	"license": "MIT",
@@ -23,18 +23,18 @@
 		"webpack.*"
 	],
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "^5.44.0",
-		"@typescript-eslint/parser": "^5.44.0",
-		"eslint": "^8.28.0",
-		"eslint-config-prettier": "^8.5.0",
+		"@typescript-eslint/eslint-plugin": "^5.50.0",
+		"@typescript-eslint/parser": "^5.50.0",
+		"eslint": "^8.33.0",
+		"eslint-config-prettier": "^8.6.0",
 		"eslint-plugin-node": "^11.1.0",
 		"eslint-plugin-prettier": "^4.2.1",
 		"find-up": "^6.3.0",
 		"parse-author": "^2.0.0",
-		"prettier": "^2.8.0",
-		"tar": "^6.1.12",
+		"prettier": "^2.8.3",
+		"tar": "^6.1.13",
 		"webpack": "^5.75.0",
-		"webpack-cli": "^5.0.0",
+		"webpack-cli": "^5.0.1",
 		"zx": "^7.1.1"
 	},
 	"peerDependencies": {

package/scripts/build.js

@@ -1,10 +1,15 @@
-#!/usr/bin/env zx
+#!/usr/bin/env node
+// The zx shebang doesn't resolve dependencies correctly
+import 'zx/globals'
 
 import path from 'path'
 import { fs } from 'zx'
 import { findUp } from 'find-up'
 import * as tar from 'tar'
 import { validateManifest } from '@companion-module/base'
+import { createRequire } from 'module'
+
+const require = createRequire(import.meta.url)
 
 async function findModuleDir(cwd) {
 	const stat = await fs.stat(cwd)
@@ -35,6 +40,7 @@ await fs.copy('companion', 'pkg/companion')
 const srcPackageJson = JSON.parse(await fs.readFile(path.resolve('./package.json')))
 const frameworkPackageJson = JSON.parse(await fs.readFile(path.join(frameworkDir, 'package.json')))
 
+// Copy the manifest, overriding some properties
 const manifestJson = JSON.parse(await fs.readFile(path.resolve('./companion/manifest.json')))
 manifestJson.runtime.entrypoint = '../main.js'
 manifestJson.version = srcPackageJson.version
@@ -61,9 +67,11 @@ const packageJson = {
 }
 
 // Ensure that any externals are added as dependencies
-const webpackExtPath = path.resolve('webpack-ext.cjs')
+const webpackExtPath = path.resolve('build-config.cjs')
 if (fs.existsSync(webpackExtPath)) {
 	const webpackExt = require(webpackExtPath)
+
+	// Add any external dependencies, with versions matching what is currntly installed
 	if (webpackExt.externals) {
 		const extArray = Array.isArray(webpackExt.externals) ? webpackExt.externals : [webpackExt.externals]
 		for (const extGroup of extArray) {
@@ -79,6 +87,7 @@ if (fs.existsSync(webpackExtPath)) {
 		}
 	}
 
+	// Copy across any prebuilds that can be loaded corectly
 	if (webpackExt.prebuilds) {
 		await fs.mkdir('pkg/prebuilds')
 
@@ -90,22 +99,31 @@ if (fs.existsSync(webpackExtPath)) {
 			}
 		}
 	}
+
+	// copy extra files
+	if (Array.isArray(webpackExt.extraFiles)) {
+		const files = await globby(webpackExt.extraFiles)
+		for (const file of files) {
+			await fs.copy(file, path.join('pkg', file), {
+				recursive: true,
+				overwrite: false,
+			})
+		}
+	}
 }
 
 // Write the package.json
 // packageJson.bundleDependencies = Object.keys(packageJson.dependencies)
 await fs.writeFile('pkg/package.json', JSON.stringify(packageJson))
 
+// If we found any depenendencies for the pkg, install them
 if (Object.keys(packageJson.dependencies).length) {
-	await $`yarn --cwd pkg`
+	await $`yarn --cwd pkg install`
 }
 
 // Create tgz of the build
-// await $`yarn --cwd pkg pack --filename pkg/package.tgz`
-
 await tar
-	.c(
-		// or tar.create
+	.create(
 		{
 			gzip: true,
 		},

package/scripts/check.js

@@ -1,4 +1,6 @@
-#!/usr/bin/env zx
+#!/usr/bin/env node
+// The zx shebang doesn't resolve dependencies correctly
+import 'zx/globals'
 
 import path from 'path'
 import { fs } from 'zx'

package/scripts/generate-manifest.js

@@ -1,4 +1,6 @@
-#!/usr/bin/env zx
+#!/usr/bin/env node
+// The zx shebang doesn't resolve dependencies correctly
+import 'zx/globals'
 
 import { fs, path, $ } from 'zx'
 import parseAuthor from 'parse-author'

package/webpack.config.cjs

@@ -7,7 +7,7 @@ if (!pkgJson.main) throw new Error(`Missing main in package.json`)
 
 let webpackExt = {}
 try {
-	webpackExt = require(path.join(process.cwd(), 'webpack-ext.cjs'))
+	webpackExt = require(path.join(process.cwd(), 'build-config.cjs'))
 
 	console.log('Found additional webpack configuration')
 } catch (e) {