@companion-module/tools 2.0.0 → 2.0.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.0.2](https://github.com/bitfocus/companion-module-tools/compare/v2.0.1...v2.0.2) (2024-09-08)
+
+
+### Bug Fixes
+
+* build script bad webpack path for some projects ([a35529b](https://github.com/bitfocus/companion-module-tools/commit/a35529b042ff0a93dc281da2a85ef77ff002b503))
+
+## [2.0.1](https://github.com/bitfocus/companion-module-tools/compare/v2.0.0...v2.0.1) (2024-09-08)
+
+
+### Bug Fixes
+
+* avoid `yarn` calls inside build script ([d8086c0](https://github.com/bitfocus/companion-module-tools/commit/d8086c0dda9907a387a3eb57690077f0af4459da))
+
 ## [2.0.0](https://github.com/bitfocus/companion-module-tools/compare/v1.5.1...v2.0.0) (2024-08-25)
 
 

package/README.md

@@ -1,41 +1,42 @@
 # @companion-module/tools
 
-This is a collection of tools, used for developing and verifying Companion modules
+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
+When used, this will build a module ready for distribution.
 
-More information on this command is available [on the wiki](https://github.com/bitfocus/companion-module-base/wiki/Module-packaging)
+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
+Generate the new format manifest from an old `package.json`.
 
 
 ## Upgrading from v1.x to v2.0
 
-v2.0 of this library includes some breaking changes to how eslint and prettier handled.
-Instead of it being installed as a dependency, and being directly usable by modules it has to be explicitly installed by modules.
+v2.0 of this library includes some breaking changes to how eslint and prettier handled. Instead of it being installed as a dependency and being directly usable by modules, it has to be explicitly installed by modules.
 
 This change was done for two reasons:
-1) Very few modules use eslint, making this extra weight for them for no gain
+
+1) Very few modules use eslint, making this extra weight for them for no gain.
 2) Recent versions of yarn do not expose these binaries in a way which is easily callable by modules, requiring tricks to be able to execute them.
 
 To resolve this, you will need to do a `yarn add --dev eslint prettier` in your modules to install the dependencies, and update any scripts to remove the invocation hacks.
 
-This also allows for eslint to be updated to v9, which requires a new config format. This unfortonately means that your config file needs to be replaced.
+This also allows for eslint to be updated to v9, which requires a new config format. This unfortunately means that your config file needs to be replaced.
+
+A new basic config should be called `eslint.config.mjs` (remove any existing `.eslintrc.json` or `.eslintrc.cjs`) and could contain:
 
-A new basic config should be called `eslint.config.mjs` (remove any existing `.eslintrc.json` or `.eslintrc.cjs`), and could contain:
 ```js
 import { generateEslintConfig } from '@companion-module/tools/eslint/config.mjs'
 
 export default generateEslintConfig({})
 ```
 
-If using typescript, you should specify a `typescriprRoot`
+If using TypeScript, you should specify a `typescriptRoot`:
 
 ```js
 import { generateEslintConfig } from '@companion-module/tools/eslint/config.mjs'
@@ -46,6 +47,7 @@ export default generateEslintConfig({
 ```
 
 You can easily override rules in this setup with:
+
 ```js
 import { generateEslintConfig } from '@companion-module/tools/eslint/config.mjs'
 

package/package.json

@@ -1,10 +1,13 @@
 {
 	"name": "@companion-module/tools",
-	"version": "2.0.0",
+	"version": "2.0.2",
 	"type": "module",
 	"main": "index.js",
 	"license": "MIT",
-	"repository": "https://github.com/bitfocus/companion-module-tools",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/bitfocus/companion-module-tools.git"
+	},
 	"bin": {
 		"companion-generate-manifest": "scripts/generate-manifest.js",
 		"companion-module-build": "scripts/build.js",

package/scripts/build.js

@@ -44,7 +44,11 @@ for (const [k, v] of Object.entries(webpackArgs)) {
 // build the code
 $.cwd = toolsDir
 const webpackConfig = path.join(toolsDir, 'webpack.config.cjs').replace(/\\/g, '/') // Fix slashes because windows is a pain
-await $`yarn run -B webpack -c ${webpackConfig} ${webpackArgsArray}`
+let webpackPath = path.join(toolsDir, 'node_modules', '.bin', 'webpack').replace(/\\/g, '/') // Fix slashes because windows is a pain
+// Try the level above too
+if (!fs.existsSync(webpackPath)) webpackPath = path.join(toolsDir, '../../.bin/webpack').replace(/\\/g, '/') // Fix slashes because windows is a pain
+// Use a manual path to the webpack binary to avoid issues with yarn versions
+await $`${webpackPath} -c ${webpackConfig} ${webpackArgsArray}`
 $.cwd = undefined
 
 // copy in the metadata