feat: Remove support for npm scripts #390
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Update `findBin` to only resolve binaries installed locally or globally. Also
add simple caching.
- Update readme.
- Remove dependency `app-root-path`.
- Update tests.
BREAKING CHANGE: Remove implicit support for running npm scripts.
Consider example `lint-staged` config:
{
"name": "My project",
"version": "0.1.0",
"scripts": {
"my-custom-script": "linter --arg1 --arg2",
"precommit": "lint-staged"
},
"lint-staged": {
"*.js": ["my-custom-script", "git add"]
}
}
The list of commands should be changed to the following:
"*.js": ["npm run my-custom-script --", "git add"]
Merged
Codecov Report
@@ Coverage Diff @@
## next #390 +/- ##
=========================================
+ Coverage 98.11% 98.22% +0.1%
=========================================
Files 10 11 +1
Lines 212 225 +13
Branches 23 24 +1
=========================================
+ Hits 208 221 +13
Misses 4 4
Continue to review full report at Codecov.
|
okonet
approved these changes
Feb 1, 2018
src/findBin.js
Outdated
| } catch (err) { | ||
| throw new Error(`${bin} could not be found. Try \`npm install ${bin}\`.`) | ||
| throw new Error(`${binName} could not be found. Try \`npm install ${binName}\`.`) |
There was a problem hiding this comment.
Could we try smoothen the migration for users who rely on this feature by checking if it exists in package.json and throwing a different error you think?
There was a problem hiding this comment.
My apologies, it slipped my mind.
|
Hey @okonet, I have done the changes for the helpful message. Could you take a look? |
okonet
approved these changes
Feb 5, 2018
sudo-suhas
added a commit
that referenced
this pull request
Feb 17, 2018
- Update `findBin` to only resolve binaries installed locally or globally. Also
add simple caching.
- Check pkg scripts when `findBin` fails and print useful message to aid users
in migration to newer version config.
- Update readme.
- Remove dependency `app-root-path`.
- Update tests.
BREAKING CHANGE: Remove implicit support for running npm scripts.
Consider example `lint-staged` config:
{
"name": "My project",
"version": "0.1.0",
"scripts": {
"my-custom-script": "linter --arg1 --arg2",
"precommit": "lint-staged"
},
"lint-staged": {
"*.js": ["my-custom-script", "git add"]
}
}
The list of commands should be changed to the following:
"*.js": ["npm run my-custom-script --", "git add"]
sudo-suhas
added a commit
that referenced
this pull request
Feb 17, 2018
- Update `findBin` to only resolve binaries installed locally or globally. Also
add simple caching.
- Check pkg scripts when `findBin` fails and print useful message to aid users
in migration to newer version config.
- Update readme.
- Remove dependency `app-root-path`.
- Update tests.
BREAKING CHANGE: Remove implicit support for running npm scripts.
Consider example `lint-staged` config:
{
"name": "My project",
"version": "0.1.0",
"scripts": {
"my-custom-script": "linter --arg1 --arg2",
"precommit": "lint-staged"
},
"lint-staged": {
"*.js": ["my-custom-script", "git add"]
}
}
The list of commands should be changed to the following:
"*.js": ["npm run my-custom-script --", "git add"]
sudo-suhas
added a commit
that referenced
this pull request
Feb 21, 2018
- Update `findBin` to only resolve binaries installed locally or globally. Also
add simple caching.
- Check pkg scripts when `findBin` fails and print useful message to aid users
in migration to newer version config.
- Update readme.
- Remove dependency `app-root-path`.
- Update tests.
BREAKING CHANGE: Remove implicit support for running npm scripts.
Consider example `lint-staged` config:
{
"name": "My project",
"version": "0.1.0",
"scripts": {
"my-custom-script": "linter --arg1 --arg2",
"precommit": "lint-staged"
},
"lint-staged": {
"*.js": ["my-custom-script", "git add"]
}
}
The list of commands should be changed to the following:
"*.js": ["npm run my-custom-script --", "git add"]
This was referenced Feb 21, 2018
This was referenced Mar 15, 2018
This was referenced Apr 1, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This removes support for running scripts defined in package.json using
lint-staged. The same can be done by specifying the command asnpm run script-name --. This also adds a slight perf improvement forfindbinby introducing simple caching to avoid repeatedly resolving binaries(ex:git).Closes #376.