Support singular 'script' dirname convention #72
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
I can't find any documentation or any source that finds either of 'scripts' or 'script' to be more common in practice. Absent any data, I lean only on anecdotal experience when I find 'script' to be more common in the wild than 'scripts'. To further defend this, GitHub has [blogged](https://githubengineering.com/scripts-to-rule-them-all/) their "Scripts to Rule Them All" pattern, and for it they use 'script' singular. This change adds 'script' (and 'script-win') as fallbacks if the plural version does not exist. This _should_ be a semver minor change. Any users who may incidentally already have both scripts and script directories, `scripts` will continue to be preferred (as long as it exists). The singular 'script' is only used as a fallback when `scripts` does _not_ exist. The same is true for Windows users. `scripts-win` is preferred if both `scripts-win` and `script-win` exist. The _only_ users who may experience an issue are Windows users who do not have a `scripts-win` directory but do have a `script-win` directory, for some reason. In this case, what _would_ have fallen back to `scripts` will now be preempted by `script-win`.
jasonkarns
force-pushed
the
scripts-to-rule-them-all
branch
from
a16a1c2 to
753ac33
Compare
These directories were all empty so they were implicitly ignored by git. Include any empty .gitignore file so they'll be explicitly tracked.
|
seems legit |
Refactors script-dirs tests to stub fs.existsSync instead of stubbing process.cwd. (This removes the need to have fixtures of the various script directory combinations.) Additionally, this adds a test asserting that module script lookup supports both scripts and script. (The latter being the default if the former doesn't exist.)
jasonkarns
force-pushed
the
scripts-to-rule-them-all
branch
from
aaf126e to
f5e55b4
Compare
|
@searls latest commit refactors the tests to stub Also adds a test to cover the scripts -> script fallback behavior for modules as well. I've removed the Do Not Merge flag, so it's merge-ready if tests/code are 👍 |
|
Skimmed and merged |
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.
I can't find any documentation or any source that finds either of 'scripts' or 'script' to be more common in practice.
Absent any data, I lean only on anecdotal experience when I find 'script' to be more common in the wild than 'scripts'.
To further defend this, GitHub has blogged their "Scripts to Rule Them All" pattern, and for it they use 'script' singular.
This change adds 'script' (and 'script-win') as fallbacks if the plural version does not exist.
This should be a semver minor change.
Any users who may incidentally already have both scripts and script directories,
scriptswill continue to be preferred (as long as it exists). The singular 'script' is only used as a fallback whenscriptsdoes not exist.The same is true for Windows users.
scripts-winis preferred if bothscripts-winandscript-winexist.The only users who may experience an issue are Windows users who do not have a
scripts-windirectory but do have ascript-windirectory, for some reason. In this case, what would have fallen back toscriptswill now be preempted byscript-win.closes #52