@companion-module/tools 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.3.0](https://github.com/bitfocus/companion-module-tools/compare/v0.2.0...v0.3.0) (2022-10-01)
+
+
+### Features
+
+* validateManifest before building module ([0166c7d](https://github.com/bitfocus/companion-module-tools/commit/0166c7da0ed725de77e3c71bc7992f8fd9deba94))
+
+
+### Bug Fixes
+
+* generating of manifest incorrectly processing 'products' field ([5f5ad9e](https://github.com/bitfocus/companion-module-tools/commit/5f5ad9e802249e4c9fe60ad8eb2278c715fa0a15))
+* update runtime.api in conversion script ([ce95e96](https://github.com/bitfocus/companion-module-tools/commit/ce95e96626023e11ec7fe460278a3418dc6f0eaf))
+
 ## [0.2.0](https://github.com/bitfocus/companion-module-tools/compare/v0.1.1...v0.2.0) (2022-09-04)
 
 

package/package.json

@@ -1,11 +1,13 @@
 {
 	"name": "@companion-module/tools",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"type": "module",
 	"main": "index.js",
 	"license": "MIT",
+	"repository": "https://github.com/bitfocus/companion-module-tools",
 	"bin": {
 		"companion-module-build": "scripts/build.js",
+		"companion-module-check": "scripts/check.js",
 		"companion-generate-manifest": "scripts/generate-manifest.js"
 	},
 	"files": [
@@ -18,9 +20,9 @@
 		"webpack.*"
 	],
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "^5.36.1",
-		"@typescript-eslint/parser": "^5.36.1",
-		"eslint": "^8.23.0",
+		"@typescript-eslint/eslint-plugin": "^5.38.1",
+		"@typescript-eslint/parser": "^5.38.1",
+		"eslint": "^8.24.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-node": "^11.1.0",
 		"eslint-plugin-prettier": "^4.2.1",
@@ -32,6 +34,6 @@
 		"zx": "^4.3.0"
 	},
 	"peerDependencies": {
-		"@companion-module/base": "^0.2.0"
+		"@companion-module/base": "^0.3.0"
 	}
 }

package/scripts/build.js

@@ -37,9 +37,18 @@ const frameworkPackageJson = JSON.parse(await fs.readFile(path.join(frameworkDir
 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
 await fs.writeFile(path.resolve('./pkg/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: manifestJson.name,

package/scripts/check.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env zx
+
+import path from 'path'
+import { fs } from 'zx'
+import { findUp } from 'find-up'
+import { validateManifest } from '@companion-module/base'
+
+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/generate-manifest.js

@@ -35,6 +35,9 @@ if (Array.isArray(pkgJson.contributors)) {
 	}
 }
 
+let products = pkgJson.products || pkgJson.product || []
+if (typeof products === 'string') products = [products]
+
 const manifest = {
 	id: pkgJson.name,
 	name: pkgJson.name,
@@ -49,7 +52,7 @@ const manifest = {
 
 	runtime: {
 		type: 'node14',
-		api: 'socket.io',
+		api: 'nodejs-ipc',
 		apiVersion: '0.0.0',
 
 		entrypoint: path.join('../', pkgJson.main || 'index.js'),
@@ -57,7 +60,7 @@ const manifest = {
 	},
 
 	manufacturer: pkgJson.manufacturer ?? '',
-	products: pkgJson.products ?? (pkgJson.product ? [pkgJson.product] : []),
+	products: products,
 	keywords: pkgJson.keywords || [],
 }