@companion-module/tools 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [2.7.0](https://github.com/bitfocus/companion-module-tools/compare/v2.6.1...v2.7.0) (2026-02-22)
+
+
+### Features
+
+* support module-api 2.0 ([034bbf2](https://github.com/bitfocus/companion-module-tools/commit/034bbf2da1ce34c6499819146d7be71b5233d230))
+
+
+### Bug Fixes
+
+* refuse to run if yarn pnp is enabled ([91593ba](https://github.com/bitfocus/companion-module-tools/commit/91593bad3e6464e658748a67af2d5caf94b2e405))
+* restrict the allowed versions of api libraries this will build ([bcbeb87](https://github.com/bitfocus/companion-module-tools/commit/bcbeb87b9018146cff0deb9a4411050d63402ec4))
+
+## [2.6.1](https://github.com/bitfocus/companion-module-tools/compare/v2.6.0...v2.6.1) (2026-01-29)
+
+
+### Bug Fixes
+
+* downgrade find-up for nodejs 18 suppport ([2c35333](https://github.com/bitfocus/companion-module-tools/commit/2c35333b067c30b80e54c9c91e4d3a497dad67b5))
+
 ## [2.6.0](https://github.com/bitfocus/companion-module-tools/compare/v2.5.0...v2.6.0) (2026-01-28)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@companion-module/tools",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "type": "module",
   "main": "index.js",
   "license": "MIT",
@@ -28,20 +28,20 @@
     "webpack.*"
   ],
   "dependencies": {
-    "@eslint/js": "^9.39.2",
+    "@eslint/js": "^9.39.3",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-n": "^17.23.2",
+    "eslint-plugin-n": "^17.24.0",
     "eslint-plugin-prettier": "^5.5.5",
-    "find-up": "^8.0.0",
+    "find-up": "^7.0.0",
     "parse-author": "^2.0.0",
-    "semver": "^7.7.3",
-    "tar": "^7.5.7",
-    "webpack": "^5.104.1",
+    "semver": "^7.7.4",
+    "tar": "^7.5.9",
+    "webpack": "^5.105.2",
     "webpack-cli": "^6.0.1",
     "zx": "^8.8.5"
   },
   "peerDependencies": {
-    "@companion-module/base": "^1.12.0",
+    "@companion-module/base": "^1.12.0 || ^2.0.0",
     "@companion-surface/base": "^1.0.0",
     "eslint": "^9.36.0",
     "prettier": "^3.6.2",
@@ -66,9 +66,9 @@
   },
   "devDependencies": {
     "@types/eslint": "^9.6.1",
-    "eslint": "^9.39.2",
+    "eslint": "^9.39.3",
     "prettier": "^3.8.1",
-    "typescript-eslint": "^8.54.0"
+    "typescript-eslint": "^8.56.0"
   },
   "packageManager": "yarn@4.12.0"
 }

package/scripts/build-connection.js

@@ -17,6 +17,11 @@ if (argv.help) {
 	process.exit(0)
 }
 
-const { validateManifest } = await import('@companion-module/base')
+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')
+await buildPackage('@companion-module/base', validateManifest, 'connection', '>=1.4.0 <3.0.0')

package/scripts/build-surface.js

@@ -19,4 +19,4 @@ if (argv.help) {
 
 const { validateSurfaceManifest } = await import('@companion-surface/base')
 
-await buildPackage('@companion-surface/base', validateSurfaceManifest, 'surface')
+await buildPackage('@companion-surface/base', validateSurfaceManifest, 'surface', '>=1.0.0 <2.0.0')

package/scripts/lib/build-util.js

@@ -21,7 +21,7 @@ async function findModuleDir(cwd) {
 	return path.dirname(pkgJsonPath)
 }
 
-export async function buildPackage(frameworkPackageName, validateManifest, moduleType) {
+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'))
@@ -31,6 +31,26 @@ export async function buildPackage(frameworkPackageName, validateManifest, modul
 	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)) {
+		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')
 
@@ -60,9 +80,6 @@ export async function buildPackage(frameworkPackageName, validateManifest, modul
 	// copy in the metadata
 	await fs.copy('companion', path.join(packageBaseDir, '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'