Removed default values for eslintPath and prettierPath #93
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
These values are not required by prettier-eslint-cli itself. They are only passed to prettier-eslint, and even then, they're optional. When using npm >3, passing the default value is optional, since the node_modules directory is flattened, but for npm 2.x, the default assumptions don't work. People should be running npm >3 today, but for CI scenarios, npm 2 or downwards can still be used in combination with node 4.x (which is going to be supported for a long time still). In any case, not passing a default value seems to align better with node's require algorithm - it will start where it needs to start (in this case wherever the prettier-eslint dependency has been installed), and then mimick find-up's logic.
kentcdodds
reviewed
Aug 20, 2017
| @@ -160,23 +158,6 @@ const parser = yargs | |||
|
|
|||
| export default parser | |||
|
|
|||
| function getPathInHostNodeModules(module) { | |||
| logger.debug(`Looking for a local installation of the module "${module}"`) | |||
| const modulePath = findUp.sync(`node_modules/${module}`) | |||
There was a problem hiding this comment.
Looks like you can remove thefindUp and logger imports from this file 👍
|
Looks like I missed to run |
Codecov Report
@@ Coverage Diff @@
## master #93 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 3 3
Lines 107 107
=====================================
Hits 107 107Continue to review full report at Codecov.
|
|
Would you like to add yourself to the contributors table? |
|
No thanks, that's not necessary! |
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.
What:
Removed default values for eslintPath and prettierPath. This improves compatibility for scenarios where not all dependencies of a project reside in a completely flat node_modules folder (the most common cause for this would be that npm 2.x is still being used)
Why:
These values are not required by prettier-eslint-cli itself. They are only passed to prettier-eslint, and even then, they're optional. When using npm >3, whether we pass the value or not is all the same - the node_modules directory is flattened and both prettier and eslint will reside in the same node_modules folder no matter which other module depends on it. But for npm 2.x, the default assumptions don't work.
It's true that people should be running npm >3 today, but for CI scenarios, npm 2 or downwards can still be used in combination with node 4.x (which is going to be supported for a long time still).
In any case, not passing a default value seems to align better with node's
requirealgorithm - it will start where it needs to start (in this case wherever the prettier-eslint dependency has been installed), and then mimick find-up's logic.How:
I simply removed the default values and the associated helper function.