@companion-module/tools 0.0.1-0

package/.prettierrc.json

@@ -0,0 +1,9 @@
+{
+	"arrowParens": "always",
+	"bracketSpacing": true,
+	"printWidth": 120,
+	"semi": false,
+	"singleQuote": true,
+	"useTabs": true,
+	"endOfLine": "lf"
+}

package/README.md

@@ -0,0 +1,9 @@
+# @companion-module/tools
+
+This is a collection of tools, used for developing and verifying Companion modules
+
+## Scripts
+
+### companion-module-build
+
+When used, this will build a module ready for distibution

package/eslint/fragments.cjs

@@ -0,0 +1,64 @@
+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]),
+
+	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',
+	]),
+
+	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'
+
+		/** 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'],
+			},
+		},
+	},
+}

package/eslint/main.cjs

@@ -0,0 +1,92 @@
+const {
+	commonPlugins,
+	tsPlugins,
+	commonExtends,
+	tsExtends,
+	commonRules,
+	tsRules,
+	tsParser,
+	enableJest,
+} = require('./fragments.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',
+			},
+		},
+	],
+}

package/index.js

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

package/package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@companion-module/tools",
+	"version": "0.0.1-0",
+	"type": "module",
+	"main": "index.js",
+	"license": "MIT",
+	"bin": {
+		"companion-module-build": "scripts/build.js",
+		"companion-generate-manifest": "scripts/generate-manifest.js"
+	},
+	"files": [
+		"eslint",
+		"scripts",
+		"tsconfig",
+		".prettierrc.json",
+		"index.js",
+		"CHANGELOG.md"
+	],
+	"dependencies": {
+		"@typescript-eslint/eslint-plugin": "^5.30.5",
+		"@typescript-eslint/parser": "^5.30.5",
+		"eslint": "^8.19.0",
+		"eslint-config-prettier": "^8.5.0",
+		"eslint-plugin-node": "^11.1.0",
+		"eslint-plugin-prettier": "^4.2.1",
+		"find-up": "^6.3.0",
+		"husky": "^8.0.1",
+		"lint-staged": "^13.0.3",
+		"parse-author": "^2.0.0",
+		"prettier": "^2.7.1",
+		"webpack": "^5.73.0",
+		"webpack-cli": "^4.10.0",
+		"zx": "^4.3.0"
+	},
+	"peerDependencies": {
+		"@companion-module/base": "^0.0.3"
+	}
+}

package/scripts/build.js

@@ -0,0 +1,87 @@
+#!/usr/bin/env zx
+
+import path from 'path'
+import { fs } from 'zx'
+import { findUp } from 'find-up'
+import * as tar from 'tar'
+
+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(`Building for: ${process.cwd()}`)
+
+console.log(`Tools path: ${toolsDir}`)
+console.log(`Framework path: ${frameworkDir}`)
+
+// clean old
+await fs.remove('pkg')
+
+// build the code
+const webpackConfig = path.join(toolsDir, 'webpack.config.cjs')
+await $`yarn webpack -c ${webpackConfig}`
+
+// copy in the metadata
+await fs.copy('companion', 'pkg/companion')
+
+const manifestJson = JSON.parse(await fs.readFile(path.resolve('./companion/manifest.json')))
+manifestJson.runtime.entrypoint = '../main.js'
+await fs.writeFile(path.resolve('./pkg/companion/manifest.json'), JSON.stringify(manifestJson))
+
+// Generate a minimal package.json
+const packageJson = {
+	name: manifestJson.name,
+	version: manifestJson.version,
+	license: manifestJson.license,
+	// Minimal content
+	type: 'commonjs',
+	dependencies: {},
+}
+
+// Ensure that any externals are added as dependencies
+const webpackExtPath = path.resolve('webpack-ext.cjs')
+if (fs.existsSync(webpackExtPath)) {
+	const webpackExt = require(webpackExtPath)
+	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[external] = extJson.version
+				}
+			}
+		}
+	}
+}
+
+// Write the package.json
+// packageJson.bundleDependencies = Object.keys(packageJson.dependencies)
+await fs.writeFile('pkg/package.json', JSON.stringify(packageJson))
+
+if (Object.keys(packageJson.dependencies).length) {
+	await $`yarn --cwd pkg`
+}
+
+// Create tgz of the build
+// await $`yarn --cwd pkg pack --filename pkg/package.tgz`
+
+await tar
+	.c(
+		// or tar.create
+		{
+			gzip: true,
+		},
+		['pkg']
+	)
+	.pipe(fs.createWriteStream('pkg.tgz'))

package/scripts/generate-manifest.js

@@ -0,0 +1,114 @@
+#!/usr/bin/env zx
+
+import { fs, path, $ } from 'zx'
+import parseAuthor from 'parse-author'
+
+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)
+	}
+}
+
+const manifest = {
+	id: `bitfocus.${pkgJson.name}`,
+	name: pkgJson.name,
+	shortname: pkgJson.shortname ?? pkgJson.name,
+	description: pkgJson.description ?? pkgJson.name,
+	version: pkgJson.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 || []), pkgJson.name],
+
+	runtime: {
+		type: 'node14',
+		api: 'socket.io',
+
+		entrypoint: path.join('../', pkgJson.main || 'index.js'),
+		// universal: boolean
+	},
+
+	manufacturer: pkgJson.manufacturer ?? '',
+	products: pkgJson.products ?? (pkgJson.product ? [pkgJson.product] : []),
+	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'))
+}
+
+// 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/tsconfig/node14/recommended.json

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