fix: make npm run test scripts work cross-environment (#10) #11
Conversation
There was a problem hiding this comment.
Before this change, the test and test-generators entry points were incompatiable for cmd and mingw (works fine on regular unix including wsl) due to the execution strategy including subfolders. Usage of cross-env addresses this issue. But we should keep in mind that cross-env is now in maintanance mode.
Can you elaborate on this? I'd have thought that if we use the |
For the mentioned entry points, |
package.json
Outdated
| @@ -7,8 +7,8 @@ | |||
| ], | |||
| "scripts": { | |||
| "prepare": "husky install", | |||
| "test": "\"./node_modules/.bin/cucumber-js\" -p default", | |||
| "test:generators": "\"./node_modules/.bin/cucumber-js\" -p generators", | |||
| "test": "cross-env-shell ./node_modules/.bin/cucumber-js -p default", | |||
There was a problem hiding this comment.
It's worth reviewing the docs for the npm run command -
In addition to the shell's pre-existing PATH, npm run adds node_modules/.bin to the PATH provided to scripts. Any binaries provided by locally-installed dependencies can be used without the node_modules/.bin prefix. For example, if there is a devDependency on tap in your package, you should write:
"scripts": {"test": "tap test/*.js"}instead of
"scripts": {"test": "node_modules/.bin/tap test/*.js"}I believe that would remove the need for cross-env and fix this bug.
There was a problem hiding this comment.
This looks like exactly what we need. Thanks :) I've updated the PR(s).
There was a problem hiding this comment.
There can be a side note about the hardcoded usage of node_modules/.bin as well.
Someone might have a custom setup for the node_modules folder location. Currently, test entry points make the assumption of node_modules is in its default place. npm bin command provides the path of locally installed binaries dynamically.
Changing from
"test": "node_modules/.bin/cucumber-js -p default"to
"test": "$(npm bin)/cucumber-js -p default"addresses this and works fine on unix but I'm not sure about its cross-compatibility.
|
🎉 This PR is included in version 1.3.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
No description provided.