@companion-module/tools 1.2.1 → 1.3.2

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## [1.3.2](https://github.com/bitfocus/companion-module-tools/compare/v1.3.1...v1.3.2) (2023-06-20)
+
+
+### Bug Fixes
+
+* `companion-module-check` script ([45fa276](https://github.com/bitfocus/companion-module-tools/commit/45fa2766fdaab7991c7554c40b09792d3eb8bda2))
+
+## [1.3.1](https://github.com/bitfocus/companion-module-tools/compare/v1.3.0...v1.3.1) (2023-06-08)
+
+
+### Bug Fixes
+
+* update readme ([def7f19](https://github.com/bitfocus/companion-module-tools/commit/def7f19ff41412d1b85e13beee277b48247a2c6c))
+
+## [1.3.0](https://github.com/bitfocus/companion-module-tools/compare/v1.2.1...v1.3.0) (2023-06-08)
+
+
+### Features
+
+* add option to build with support for node-gyp-build ([#24](https://github.com/bitfocus/companion-module-tools/issues/24)) ([2a4e311](https://github.com/bitfocus/companion-module-tools/commit/2a4e3115ca26c695d409080d07ef8ad5e6dd840a))
+* rework eslint config to be generated to allow further customisation ([e30ae2b](https://github.com/bitfocus/companion-module-tools/commit/e30ae2b23714e858eb333c9be9396d03f187dbee))
+
 ## [1.2.1](https://github.com/bitfocus/companion-module-tools/compare/v1.2.0...v1.2.1) (2023-05-12)
 
 

package/README.md

@@ -8,6 +8,8 @@ This is a collection of tools, used for developing and verifying Companion modul
 
 When used, this will build a module ready for distibution
 
+More information on this command is available [on the wiki](https://github.com/bitfocus/companion-module-base/wiki/Module-packaging)
+
 ### companion-generate-manifest
 
 Generate the new format manifest from an old package.json

package/eslint/fragments.cjs

@@ -1,64 +1,62 @@
-const enableJest = false // TODO
-
 function compact(arr) {
 	return arr.filter((v) => v !== undefined && v !== null)
 }
 
-module.exports = {
-	enableJest,
-
-	commonPlugins: compact(['prettier', enableJest ? 'jest' : null]),
-	tsPlugins: compact(['@typescript-eslint', 'prettier', enableJest ? 'jest' : null]),
+module.exports = function createFragments(enableJest) {
+	return {
+		commonPlugins: compact(['prettier', enableJest ? 'jest' : null]),
+		tsPlugins: compact(['@typescript-eslint', 'prettier', enableJest ? 'jest' : null]),
 
-	commonExtends: ['eslint:recommended', 'plugin:node/recommended', 'plugin:prettier/recommended'],
-	tsExtends: compact([
-		'eslint:recommended',
-		'plugin:@typescript-eslint/eslint-recommended',
-		'plugin:@typescript-eslint/recommended',
-		'plugin:@typescript-eslint/recommended-requiring-type-checking',
-		'plugin:node/recommended',
-		enableJest ? 'plugin:jest/recommended' : null,
-		'prettier',
-		'plugin:prettier/recommended',
-	]),
+		commonExtends: ['eslint:recommended', 'plugin:n/recommended', 'plugin:prettier/recommended'],
+		tsExtends: compact([
+			'eslint:recommended',
+			'plugin:@typescript-eslint/eslint-recommended',
+			'plugin:@typescript-eslint/recommended',
+			'plugin:@typescript-eslint/recommended-requiring-type-checking',
+			'plugin:n/recommended',
+			enableJest ? 'plugin:jest/recommended' : null,
+			'prettier',
+			'plugin:prettier/recommended',
+		]),
 
-	commonRules: {
-		'prettier/prettier': 'error',
-		'no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_(.+)' }],
-		'no-extra-semi': 'off',
-		'node/no-unsupported-features/es-syntax': ['error', { ignores: ['modules'] }],
-		'no-use-before-define': 'off',
-		'no-warning-comments': ['error', { terms: ['nocommit', '@nocommit', '@no-commit'] }],
-		'jest/no-mocks-import': 'off',
-	},
-	tsRules: {
-		'no-unused-vars': 'off',
-		'@typescript-eslint/no-explicit-any': 'off',
-		'@typescript-eslint/interface-name-prefix': 'off',
-		'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_(.+)' }],
-		'@typescript-eslint/no-floating-promises': 'error',
-		'@typescript-eslint/explicit-module-boundary-types': ['error'],
-		'@typescript-eslint/promise-function-async': 'error',
-		'@typescript-eslint/require-await': 'off', // conflicts with 'promise-function-async'
+		commonRules: {
+			'prettier/prettier': 'error',
+			'no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_(.+)' }],
+			'no-extra-semi': 'off',
+			'n/no-unsupported-features/es-syntax': ['error', { ignores: ['modules'] }],
+			'no-use-before-define': 'off',
+			'no-warning-comments': ['error', { terms: ['nocommit', '@nocommit', '@no-commit'] }],
+			'jest/no-mocks-import': 'off',
+		},
+		tsRules: {
+			'no-unused-vars': 'off',
+			'@typescript-eslint/no-explicit-any': 'off',
+			'@typescript-eslint/interface-name-prefix': 'off',
+			'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_(.+)' }],
+			'@typescript-eslint/no-floating-promises': 'error',
+			'@typescript-eslint/explicit-module-boundary-types': ['error'],
+			'@typescript-eslint/promise-function-async': 'error',
+			'@typescript-eslint/require-await': 'off', // conflicts with 'promise-function-async'
 
-		/** Disable some annoyingly strict rules from the 'recommended-requiring-type-checking' pack */
-		'@typescript-eslint/no-unsafe-assignment': 0,
-		'@typescript-eslint/no-unsafe-member-access': 0,
-		'@typescript-eslint/no-unsafe-argument': 0,
-		'@typescript-eslint/no-unsafe-return': 0,
-		'@typescript-eslint/no-unsafe-call': 0,
-		'@typescript-eslint/restrict-template-expressions': 0,
-		'@typescript-eslint/restrict-plus-operands': 0,
-		/** End 'recommended-requiring-type-checking' overrides */
-	},
+			/** Disable some annoyingly strict rules from the 'recommended-requiring-type-checking' pack */
+			'@typescript-eslint/no-unsafe-assignment': 0,
+			'@typescript-eslint/no-unsafe-member-access': 0,
+			'@typescript-eslint/no-unsafe-argument': 0,
+			'@typescript-eslint/no-unsafe-return': 0,
+			'@typescript-eslint/no-unsafe-call': 0,
+			'@typescript-eslint/restrict-template-expressions': 0,
+			'@typescript-eslint/restrict-plus-operands': 0,
+			/** End 'recommended-requiring-type-checking' overrides */
+		},
 
-	tsParser: {
-		parser: '@typescript-eslint/parser',
-		parserOptions: { project: './tsconfig.json' },
-		settings: {
-			node: {
-				tryExtensions: ['.js', '.json', '.node', '.ts', '.d.ts'],
+		tsParser: {
+			parser: '@typescript-eslint/parser',
+			parserOptions: { project: './tsconfig.json' },
+			settings: {
+				node: {
+					tryExtensions: ['.js', '.json', '.node', '.ts', '.d.ts'],
+				},
 			},
 		},
-	},
+	}
 }

package/eslint/index.cjs

@@ -0,0 +1,96 @@
+const createFragments = require('./fragments.cjs')
+
+module.exports = function generateEslintConfig(options = {}) {
+	const { commonPlugins, tsPlugins, commonExtends, tsExtends, commonRules, tsRules, tsParser } = createFragments(
+		options.enableJest
+	)
+
+	const disableJest = options.enableJest
+		? {
+				'jest/globals': false, // Block jest from this
+		  }
+		: {}
+	const allowJest = options.enableJest
+		? {
+				'jest/globals': true,
+				jest: true,
+		  }
+		: {}
+
+	const result = {
+		extends: commonExtends,
+		plugins: commonPlugins,
+		rules: {
+			'prettier/prettier': 'error',
+		},
+		env: { es2017: true },
+		parserOptions: { sourceType: 'module', ecmaVersion: 2022 },
+		overrides: [
+			// Note: the overrides replace the values defined above, so make sure to extend them if they are needed
+			{
+				files: ['*.js', '*.cjs', '*.mjs'],
+				settings: {
+					node: {
+						tryExtensions: ['.js', '.json', '.node', '.ts'],
+					},
+				},
+				env: {
+					...disableJest,
+				},
+				rules: {
+					...commonRules,
+				},
+			},
+		],
+	}
+
+	if (options.enableTypescript) {
+		result.overrides.push(
+			{
+				files: ['*.ts'],
+				extends: tsExtends,
+				plugins: tsPlugins,
+				...tsParser,
+				env: {
+					...disableJest,
+				},
+				rules: {
+					...commonRules,
+					...tsRules,
+				},
+			},
+			{
+				files: ['src/**/__tests__/**/*.ts'],
+				extends: tsExtends,
+				plugins: tsPlugins,
+				...tsParser,
+				env: {
+					...allowJest,
+				},
+				rules: {
+					...commonRules,
+					...tsRules,
+					'@typescript-eslint/ban-ts-ignore': 'off',
+					'@typescript-eslint/ban-ts-comment': 'off',
+				},
+			},
+			{
+				files: ['examples/**/*.ts'],
+				extends: tsExtends,
+				plugins: tsPlugins,
+				...tsParser,
+				env: {
+					...disableJest,
+				},
+				rules: {
+					...commonRules,
+					...tsRules,
+					'no-process-exit': 'off',
+					'n/no-missing-import': 'off',
+				},
+			}
+		)
+	}
+
+	return result
+}

package/eslint/main.cjs

@@ -1,92 +1,6 @@
-const {
-	commonPlugins,
-	tsPlugins,
-	commonExtends,
-	tsExtends,
-	commonRules,
-	tsRules,
-	tsParser,
-	enableJest,
-} = require('./fragments.cjs')
+const generateEslintConfig = require('./index.cjs')
 
-const disableJest = enableJest
-	? {
-			'jest/globals': false, // Block jest from this
-	  }
-	: {}
-const allowJest = enableJest
-	? {
-			'jest/globals': true,
-			jest: true,
-	  }
-	: {}
-
-module.exports = {
-	extends: commonExtends,
-	plugins: commonPlugins,
-	rules: {
-		'prettier/prettier': 'error',
-	},
-	env: { es2017: true },
-	parserOptions: { sourceType: 'module', ecmaVersion: 2018 },
-	overrides: [
-		// Note: these replace the values defined above, so make sure to extend them if they are needed
-		{
-			files: ['*.ts'],
-			extends: tsExtends,
-			plugins: tsPlugins,
-			...tsParser,
-			env: {
-				...disableJest,
-			},
-			rules: {
-				...commonRules,
-				...tsRules,
-			},
-		},
-		{
-			files: ['*.js'],
-			settings: {
-				node: {
-					tryExtensions: ['.js', '.json', '.node', '.ts'],
-				},
-			},
-			env: {
-				...disableJest,
-			},
-			rules: {
-				...commonRules,
-			},
-		},
-		{
-			files: ['src/**/__tests__/**/*.ts'],
-			extends: tsExtends,
-			plugins: tsPlugins,
-			...tsParser,
-			env: {
-				...allowJest,
-			},
-			rules: {
-				...commonRules,
-				...tsRules,
-				'@typescript-eslint/ban-ts-ignore': 'off',
-				'@typescript-eslint/ban-ts-comment': 'off',
-			},
-		},
-		{
-			files: ['examples/**/*.ts'],
-			extends: tsExtends,
-			plugins: tsPlugins,
-			...tsParser,
-			env: {
-				...disableJest,
-			},
-			rules: {
-				...commonRules,
-				...tsRules,
-				'no-process-exit': 'off',
-				'node/no-missing-import': 'off',
-			},
-		},
-	],
-}
+/**
+ * @deprecated use the line like below to generate your own config
+ */
+module.exports = generateEslintConfig({ enableTypescript: true })

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@companion-module/tools",
-	"version": "1.2.1",
+	"version": "1.3.2",
 	"type": "module",
 	"main": "index.js",
 	"license": "MIT",
@@ -23,21 +23,21 @@
 		"webpack.*"
 	],
 	"dependencies": {
-		"@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",
+		"@typescript-eslint/eslint-plugin": "^5.59.9",
+		"@typescript-eslint/parser": "^5.59.9",
+		"eslint": "^8.42.0",
+		"eslint-config-prettier": "^8.8.0",
+		"eslint-plugin-n": "^16.0.0",
 		"eslint-plugin-prettier": "^4.2.1",
 		"find-up": "^6.3.0",
 		"parse-author": "^2.0.0",
-		"prettier": "^2.8.3",
-		"tar": "^6.1.13",
-		"webpack": "^5.76.0",
-		"webpack-cli": "^5.0.1",
-		"zx": "^7.1.1"
+		"prettier": "^2.8.8",
+		"tar": "^6.1.15",
+		"webpack": "^5.86.0",
+		"webpack-cli": "^5.1.4",
+		"zx": "^7.2.2"
 	},
 	"peerDependencies": {
-		"@companion-module/base": "^1.0.0"
+		"@companion-module/base": "^1.4.1"
 	}
 }

package/scripts/build.js

@@ -30,12 +30,17 @@ console.log(`Framework path: ${frameworkDir}`)
 // clean old
 await fs.remove('pkg')
 
-const webpackArgs = []
-if (argv.dev) webpackArgs.push('--env', 'dev')
+const webpackArgs = {}
+if (argv.dev || argv.debug) webpackArgs['env']= 'dev'
+
+const webpackArgsArray = []
+for (const [k, v] of Object.entries(webpackArgs)) {
+	webpackArgsArray.push(`--${k}`, v)
+}
 
 // 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} ${webpackArgs}`
+await $`yarn webpack -c ${webpackConfig} ${webpackArgsArray}`
 
 // copy in the metadata
 await fs.copy('companion', 'pkg/companion')
@@ -84,7 +89,7 @@ if (fs.existsSync(webpackExtPath)) {
 				for (const external of Object.keys(extGroup)) {
 					const extPath = await findUp('package.json', { cwd: require.resolve(external) })
 					const extJson = JSON.parse(await fs.readFile(extPath))
-					packageJson.dependencies[extJson.name] = extJson.version
+					packageJson.dependencies[external] = extJson.version
 				}
 			}
 		}
@@ -114,6 +119,37 @@ if (fs.existsSync(webpackExtPath)) {
 	}
 }
 
+// Copy node-gyp-build prebulds
+const webpackConfigJson = await require(webpackConfig)(webpackArgs)
+if (webpackConfigJson.node?.__dirname === true) {
+	const copyNodeGypBuildPrebuilds = (thisPath) => {
+		const nodeModPath = path.join(thisPath, 'node_modules')
+		if (fs.existsSync(nodeModPath)) {
+			for (const dir of fs.readdirSync(nodeModPath)) {
+				const modDir = path.join(nodeModPath, dir)
+				copyNodeGypBuildPrebuilds(modDir)
+			}
+		}
+
+		const pkgJsonPath = path.join(thisPath, 'package.json')
+		if (thisPath && fs.existsSync(pkgJsonPath)) {
+			const dirPkgJsonStr = fs.readFileSync(pkgJsonPath)
+			const dirPkgJson = JSON.parse(dirPkgJsonStr.toString())
+
+			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))
+				
+				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/check.js

@@ -6,6 +6,9 @@ import path from 'path'
 import { fs } from 'zx'
 import { findUp } from 'find-up'
 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)

package/webpack.config.cjs

@@ -58,5 +58,8 @@ 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,
 	}
 }