@companion-module/tools 2.7.1 → 3.0.0

package/eslint/config.mjs

@@ -1,155 +0,0 @@
-// @ts-check
-
-import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
-import eslint from '@eslint/js'
-import neslint from 'eslint-plugin-n'
-
-/**
- *
- * @template T
- * @param {Record<string, T | null | undefined>} obj
- * @returns {Record<string, T>}
- */
-function compactObj(obj) {
-	/** @type {Record<string, T>} */
-	const result = {}
-
-	for (const [key, value] of Object.entries(obj)) {
-		if (value) result[key] = value
-	}
-
-	return result
-}
-
-/***
- * @param {{
- *   enableJest?: boolean,
- *   enableTypescript?: boolean,
- *   ignores?: string[],
- *   commonRules?: Readonly<import('eslint').Linter.RulesRecord>,
- *   typescriptRules?: Readonly<import('eslint').Linter.RulesRecord>,
- * }} [options={}] - Options to customize the config
- * @returns {Promise<import('eslint').Linter.Config[]>}
- */
-export async function generateEslintConfig(options = {}) {
-	const tseslint = options.enableTypescript ? await import('typescript-eslint') : null
-
-	/** @type {import('eslint').Linter.Config} */
-	const result = {
-		// extends: commonExtends,
-		plugins: compactObj({
-			'@typescript-eslint': tseslint ? tseslint.plugin : null,
-		}),
-		rules: {
-			// Default rules to be applied everywhere
-			'prettier/prettier': 'error',
-
-			...eslint.configs.recommended.rules,
-
-			'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',
-
-			...(options.commonRules || {}),
-		},
-	}
-
-	return [
-		// setup the parser first
-		tseslint
-			? {
-					languageOptions: {
-						parser: tseslint.parser,
-						parserOptions: {
-							project: true,
-						},
-					},
-				}
-			: null,
-
-		neslint.configs['flat/recommended-script'],
-		result,
-		...(tseslint ? tseslint.configs.recommendedTypeChecked : []),
-		{
-			// disable type-aware linting on JS files
-			files: ['**/*.js', '**/*.cjs', '**/*.mjs'],
-			...(tseslint ? tseslint.configs.disableTypeChecked : {}),
-		},
-		{
-			files: ['*.mjs'],
-			languageOptions: {
-				sourceType: 'module',
-			},
-		},
-		tseslint
-			? {
-					files: ['**/*.ts', '**/*.cts', '**/*.mts'],
-					rules: {
-						'@typescript-eslint/no-explicit-any': 'off',
-						'@typescript-eslint/interface-name-prefix': 'off',
-						'@typescript-eslint/no-unused-vars': [
-							'error',
-							{ argsIgnorePattern: '^_', caughtErrorsIgnorePattern: '^_', 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,
-						'@typescript-eslint/no-redundant-type-constituents': 0,
-						/** End 'recommended-requiring-type-checking' overrides */
-
-						...(options.typescriptRules || {}),
-					},
-				}
-			: null,
-		tseslint
-			? {
-					files: ['**/__tests__/**/*', 'test/**/*'],
-					rules: {
-						'@typescript-eslint/ban-ts-ignore': 'off',
-						'@typescript-eslint/ban-ts-comment': 'off',
-					},
-				}
-			: null,
-		{
-			// disable type-aware linting on JS files
-			files: [
-				'examples/**/*.js',
-				'examples/**/*.cjs',
-				'examples/**/*.mjs',
-				'examples/**/*.ts',
-				'examples/**/*.cts',
-				'examples/**/*.mts',
-			],
-			rules: {
-				'no-process-exit': 'off',
-				'n/no-missing-import': 'off',
-			},
-		},
-
-		// Add prettier at the end to give it final say on formatting
-		eslintPluginPrettierRecommended,
-		{
-			// But lastly, ensure that we ignore certain paths
-			ignores: ['**/dist/*', '/dist', '**/pkg/*', '**/docs/*', '**/generated/*', ...(options.ignores || [])],
-		},
-		{
-			files: ['eslint.config.*'],
-			rules: {
-				'n/no-unpublished-import': 'off',
-			},
-		},
-	].filter((v) => !!v)
-}

package/index.js

@@ -1 +0,0 @@
-throw new Error('Not importable!')

package/scripts/build-connection.js

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-// The zx shebang doesn't resolve dependencies correctly
-import 'zx/globals'
-
-import { buildPackage } from './lib/build-util.js'
-
-if (process.platform === 'win32') {
-	usePowerShell() // to enable powershell
-}
-
-if (argv.help) {
-	console.log('Usage: companion-module-build [--dev] [--prerelease]')
-	console.log('Builds the companion connection 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)
-}
-
-let { validateManifest } = await import('@companion-module/base')
-if (!validateManifest) {
-	// If a v2.x version of @companion-module/base is being used, it exports the function as a subpath export
-	const manifestPkg = await import('@companion-module/base/manifest')
-	validateManifest = manifestPkg.validateManifest
-}
-
-await buildPackage('@companion-module/base', validateManifest, 'connection', '>=1.4.0 <3.0.0')

package/scripts/build-surface.js

@@ -1,22 +0,0 @@
-#!/usr/bin/env node
-// The zx shebang doesn't resolve dependencies correctly
-import 'zx/globals'
-
-import { buildPackage } from './lib/build-util.js'
-
-if (process.platform === 'win32') {
-	usePowerShell() // to enable powershell
-}
-
-if (argv.help) {
-	console.log('Usage: companion-module-build [--dev] [--prerelease]')
-	console.log('Builds the companion connection 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 { validateSurfaceManifest } = await import('@companion-surface/base')
-
-await buildPackage('@companion-surface/base', validateSurfaceManifest, 'surface', '>=1.0.0 <2.0.0')

package/scripts/check-connection.js

@@ -1,40 +0,0 @@
-#!/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 { validateManifest } from '@companion-module/base'
-import { createRequire } from 'module'
-
-if (process.platform === 'win32') {
-	usePowerShell() // to enable powershell
-}
-
-const require = createRequire(import.meta.url)
-
-async function findModuleDir(cwd) {
-	const stat = await fs.stat(cwd)
-	if (stat.isFile()) cwd = path.dirname(cwd)
-
-	const pkgJsonPath = await findUp('package.json', { cwd })
-	return path.dirname(pkgJsonPath)
-}
-
-// const toolsDir = path.join(__dirname, '..')
-const toolsDir = await findModuleDir(require.resolve('@companion-module/tools'))
-const frameworkDir = await findModuleDir(require.resolve('@companion-module/base'))
-console.log(`Checking for: ${process.cwd()}`)
-
-console.log(`Tools path: ${toolsDir}`)
-console.log(`Framework path: ${frameworkDir}`)
-
-const manifestJson = JSON.parse(await fs.readFile(path.resolve('./companion/manifest.json')))
-
-try {
-	validateManifest(manifestJson)
-} catch (e) {
-	console.error('Manifest validation failed', e)
-	process.exit(1)
-}

package/scripts/check-surface.js

@@ -1,40 +0,0 @@
-#!/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 { validateSurfaceManifest } from '@companion-surface/base'
-import { createRequire } from 'module'
-
-if (process.platform === 'win32') {
-	usePowerShell() // to enable powershell
-}
-
-const require = createRequire(import.meta.url)
-
-async function findModuleDir(cwd) {
-	const stat = await fs.stat(cwd)
-	if (stat.isFile()) cwd = path.dirname(cwd)
-
-	const pkgJsonPath = await findUp('package.json', { cwd })
-	return path.dirname(pkgJsonPath)
-}
-
-// const toolsDir = path.join(__dirname, '..')
-const toolsDir = await findModuleDir(require.resolve('@companion-module/tools'))
-const frameworkDir = await findModuleDir(require.resolve('@companion-surface/base'))
-console.log(`Checking for: ${process.cwd()}`)
-
-console.log(`Tools path: ${toolsDir}`)
-console.log(`Framework path: ${frameworkDir}`)
-
-const manifestJson = JSON.parse(await fs.readFile(path.resolve('./companion/manifest.json')))
-
-try {
-	validateSurfaceManifest(manifestJson)
-} catch (e) {
-	console.error('Manifest validation failed', e)
-	process.exit(1)
-}

package/scripts/generate-connection-manifest.js

@@ -1,83 +0,0 @@
-#!/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'
-
-if (process.platform === 'win32') {
-	usePowerShell() // to enable powershell
-}
-
-if (await fs.pathExists('companion/manifest.json')) {
-	throw new Error('Manifest has already been created')
-}
-
-const pkgJsonStr = await fs.readFile('package.json')
-const pkgJson = JSON.parse(pkgJsonStr.toString())
-
-const maintainers = []
-
-function tryParsePerson(person) {
-	try {
-		if (person) {
-			const rawAuthor = typeof person === 'string' ? parseAuthor(person) : person
-			if (rawAuthor.name) {
-				maintainers.push({
-					name: rawAuthor.name,
-					email: rawAuthor.email,
-				})
-			}
-		}
-	} catch (e) {
-		// Ignore
-	}
-}
-
-tryParsePerson(pkgJson.author)
-if (Array.isArray(pkgJson.contributors)) {
-	for (const person of pkgJson.contributors) {
-		tryParsePerson(person)
-	}
-}
-
-let products = pkgJson.products || pkgJson.product || []
-if (typeof products === 'string') products = [products]
-
-const manifest = {
-	id: pkgJson.name,
-	name: pkgJson.name,
-	shortname: pkgJson.shortname ?? pkgJson.name,
-	description: pkgJson.description ?? pkgJson.name,
-	version: '0.0.0',
-	license: pkgJson.license,
-	repository: pkgJson.repository?.url ?? `https://github.com/bitfocus/companion-module-${pkgJson.name}.git`,
-	bugs: pkgJson.bugs?.url ?? `https://github.com/bitfocus/companion-module-${pkgJson.name}/issues`,
-	maintainers: maintainers,
-	legacyIds: [...(pkgJson.legacy || [])],
-
-	runtime: {
-		type: 'node22',
-		api: 'nodejs-ipc',
-		apiVersion: '0.0.0',
-
-		entrypoint: path.join('../', pkgJson.main || 'index.js'),
-		// universal: boolean
-	},
-
-	manufacturer: pkgJson.manufacturer ?? '',
-	products: products,
-	keywords: pkgJson.keywords || [],
-}
-
-const manifestDir = './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.move('HELP.md', path.join(manifestDir, 'HELP.md'))
-
-	// guess at what images might be needed by the help
-	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'))
-}

package/scripts/lib/build-util.js

@@ -1,254 +0,0 @@
-import 'zx/globals'
-
-import path from 'path'
-import { fs } from 'zx'
-import { findUp } from 'find-up'
-import * as tar from 'tar'
-import { createRequire } from 'module'
-import * as semver from 'semver'
-
-function toSanitizedDirname(name) {
-	return name.replace(/[^a-zA-Z0-9-\.]/g, '-').replace(/[-+]/g, '-')
-}
-
-const require = createRequire(import.meta.url)
-
-async function findModuleDir(cwd) {
-	const stat = await fs.stat(cwd)
-	if (stat.isFile()) cwd = path.dirname(cwd)
-
-	const pkgJsonPath = await findUp('package.json', { cwd })
-	return path.dirname(pkgJsonPath)
-}
-
-export async function buildPackage(frameworkPackageName, validateManifest, moduleType, versionRange) {
-	// const toolsDir = path.join(__dirname, '..')
-	const moduleDir = process.cwd()
-	const toolsDir = await findModuleDir(require.resolve('@companion-module/tools'))
-	const frameworkDir = await findModuleDir(require.resolve(frameworkPackageName))
-	console.log(`Building for: ${process.cwd()}`)
-
-	console.log(`Tools path: ${toolsDir}`)
-	console.log(`Framework path: ${frameworkDir}`)
-
-	// Check for Yarn PnP
-	const pnpFile = path.join(moduleDir, '.pnp.cjs')
-	const pnpFileAlt = path.join(moduleDir, '.pnp.js')
-	if ((await fs.pathExists(pnpFile)) || (await fs.pathExists(pnpFileAlt))) {
-		console.error("❌ Error: Yarn PnP (Plug'n'Play) is not supported.")
-		console.error('   The companion module build process requires a traditional node_modules structure.')
-		console.error('   Please add "nodeLinker: node-modules" to your .yarnrc.yml file and run "yarn install".')
-		process.exit(1)
-	}
-
-	const srcPackageJson = JSON.parse(await fs.readFile(path.resolve('./package.json')))
-	const frameworkPackageJson = JSON.parse(await fs.readFile(path.join(frameworkDir, 'package.json')))
-
-	// Check framework version if range is specified
-	if (versionRange && !semver.satisfies(frameworkPackageJson.version, versionRange, { includePrerelease: true })) {
-		console.error(`Error: ${frameworkPackageName} version ${frameworkPackageJson.version} is not supported.`)
-		console.error(`Required version range: ${versionRange}`)
-		process.exit(1)
-	}
-
-	// clean old
-	await fs.remove('pkg')
-
-	// create new
-	await fs.mkdir(`pkg`)
-
-	const packageBaseDir = path.join('pkg')
-
-	const webpackArgs = {
-		ROOT: moduleDir,
-		MODULETYPE: moduleType,
-	}
-	if (argv.dev || argv.debug) webpackArgs['dev'] = true
-
-	const webpackArgsArray = []
-	for (const [k, v] of Object.entries(webpackArgs)) {
-		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
-	// use npx to invoke. manual paths does not work on windows, and using `yarn` requires corepack
-	await $`npx webpack -c ${webpackConfig} ${webpackArgsArray}`
-	$.cwd = undefined
-
-	// copy in the metadata
-	await fs.copy('companion', path.join(packageBaseDir, 'companion'))
-
-	// 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
-	manifestJson.runtime.api = 'nodejs-ipc'
-	manifestJson.runtime.apiVersion = frameworkPackageJson.version
-
-	// 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 {
-		validateManifest(manifestJson)
-	} catch (e) {
-		console.error('Manifest validation failed', e)
-		process.exit(1)
-	}
-
-	// Generate a minimal package.json
-	const packageJson = {
-		name: moduleType === 'connection' ? manifestJson.name : manifestJson.id,
-		version: manifestJson.version,
-		license: manifestJson.license,
-		// Minimal content
-		type: 'commonjs',
-		dependencies: {},
-	}
-
-	// Ensure that any externals are added as dependencies
-	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) {
-				if (typeof extGroup === 'object') {
-					// TODO - does this need to be a stricter object check?
-
-					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
-					}
-				}
-			}
-		}
-
-		if (webpackExt.forceRemoveNodeGypFromPkg) {
-			packageJson.resolutions = {
-				'node-gyp': 'npm:empty-npm-package@1.0.0',
-			}
-		}
-
-		// Copy across any prebuilds that can be loaded corectly
-		if (webpackExt.prebuilds) {
-			await fs.mkdir(path.join(packageBaseDir, 'prebuilds'))
-
-			for (const lib of webpackExt.prebuilds) {
-				const srcDir = await findModuleDir(require.resolve(lib))
-				const filesOrDirs = await fs.readdir(path.join(srcDir, 'prebuilds'))
-				for (const fileOrDir of filesOrDirs) {
-					await fs.copy(path.join(srcDir, 'prebuilds', fileOrDir), path.join(packageBaseDir, 'prebuilds', fileOrDir))
-				}
-			}
-		}
-
-		// copy extra files
-		if (Array.isArray(webpackExt.extraFiles)) {
-			const files = await globby(webpackExt.extraFiles, {
-				expandDirectories: false,
-				onlyFiles: false,
-			})
-
-			for (const file of files) {
-				await fs.copy(file, path.join(packageBaseDir, path.basename(file)), {
-					overwrite: false,
-				})
-			}
-		}
-	}
-
-	// 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(packageBaseDir, thisPath))
-					fs.copySync(prebuildsDir, path.join(packageBaseDir, prebuildsDir))
-
-					console.log('copying node-gyp-build prebuilds from', thisPath)
-				}
-			}
-		}
-
-		copyNodeGypBuildPrebuilds('')
-	}
-
-	// Write the package.json
-	// packageJson.bundleDependencies = Object.keys(packageJson.dependencies)
-	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(path.join(packageBaseDir, 'yarn.lock'), '')
-		await $`yarn --cwd ${packageBaseDir} install --no-immutable`
-	}
-
-	// Prune any excessive prebuilds
-	const prebuildDirName = path.join(packageBaseDir, 'prebuilds')
-	if (fs.existsSync(prebuildDirName)) {
-		const prebuildDirs = await fs.readdir(prebuildDirName)
-		for (const dir of prebuildDirs) {
-			let keepDir = true
-			if (dir.match(/freebsd/) || dir.match(/android/)) {
-				// Unsupported platforms
-				keepDir = false
-			} else if (dir.match(/win32-ia32/)) {
-				// 32bit windows is not supported
-				keepDir = false
-			} else if (dir.match(/linux(.+)musl/)) {
-				// linux musl is not supported
-				keepDir = false
-			} else if (dir.match(/linux-arm$/) || dir.match(/linux-arm-gnueabihf/)) {
-				// linux arm (non arm64) is not supported
-				keepDir = false
-			}
-
-			if (!keepDir) {
-				console.log('Removing unneeded prebuild dir:', dir)
-				await fs.rm(path.join(prebuildDirName, dir), { recursive: true, force: true })
-			}
-		}
-	}
-
-	// Create tgz of the build
-	let tgzFile = toSanitizedDirname(`${manifestJson.id}-${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,
-			},
-			[packageBaseDir],
-		)
-		.pipe(fs.createWriteStream(tgzFile))
-}

package/tsconfig/node18/recommended.json

@@ -1,30 +0,0 @@
-{
-	"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": ["es2022"],
-		"types": ["node"],
-		"strict": true,
-		"alwaysStrict": false,
-		"forceConsistentCasingInFileNames": true,
-		"noFallthroughCasesInSwitch": true,
-		"noImplicitReturns": true,
-		"noUnusedLocals": true,
-		"noUnusedParameters": true,
-		"skipLibCheck": true,
-		"allowSyntheticDefaultImports": true,
-		"esModuleInterop": true
-	},
-	"compileOnSave": false
-}