feat(glob): expose config.globOptions. #400
Merged
Conversation
This file contains hidden or 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
src/common.js
Outdated
| if (!Array.isArray(list)) { | ||
| throw new TypeError('must be an array'); | ||
| } | ||
| opts = opts || config.globOptions; |
Contributor
There was a problem hiding this comment.
Should we merge these here, instead of overriding them?
Member
Author
There was a problem hiding this comment.
Actually, we're not using opts anymore (it was added for something, but we refactored the code to not need it). I think it's cleaner to just use config.globOptions instead.
I don't think our code should ever need to pass options to glob.sync(). We experimented with using glob.sync('dirName/*', {dot: true}) for ls -a, but it's much easier to just us fs.readDirSync() instead (it's simple, it's faster, and it actually works correctly for a directory named dir*With?Glob[chars]/).
Contributor
|
One nit, and can we get this rebased off master? Thanks! |
Member
Author
|
Rebased. I changed |
Contributor
|
LGTM! |
Member
Author
|
re- LGTM |
Allow users to customize the settings of `glob.sync()` (if they so-desire). This doesn't change the default behavior.
Member
Author
|
re-re- LGTM (rebased off master) |
nfischer
added a commit
that referenced
this pull request
Feb 18, 2024
This removes support for configuring `config.globOptions`. Exposing this variable makes it difficult to change (or upgrade) our glob library. It's best to consider our choice of glob library to be an implementation detail. As far as I know, this is not a commonly used option: https://github.com/shelljs/shelljs/issues?q=globOptions currently shows no GitHub issues of users using this option, and there was never really a motivation for why this needed to be exposed (#400 exposed the option just because we could, not because we should). This is one step toward supporting Issue #828.
nfischer
added a commit
that referenced
this pull request
Jun 14, 2024
This removes support for configuring `config.globOptions`. Exposing this variable makes it difficult to change (or upgrade) our glob library. It's best to consider our choice of glob library to be an implementation detail. As far as I know, this is not a commonly used option: https://github.com/shelljs/shelljs/issues?q=globOptions currently shows no GitHub issues of users using this option, and there was never really a motivation for why this needed to be exposed (#400 exposed the option just because we could, not because we should). This is one step toward supporting Issue #828.
nfischer
added a commit
that referenced
this pull request
Jun 14, 2024
This deprecates support for configuring `config.globOptions`. Exposing this variable makes it difficult to change (or upgrade) our glob library. This discourages users from depending on this config option going forward. If anyone is using `config.globOptions` then it should continue to function, however this support is not promised for the long-term. As far as I know, this is not a commonly used option: https://github.com/shelljs/shelljs/issues?q=globOptions currently shows no GitHub issues of users using this option, and there was never really a motivation for why this needed to be exposed (#400 exposed the option just because we could, not because we should). This is one step toward supporting Issue #828.
nfischer
added a commit
that referenced
this pull request
Jun 14, 2024
This deprecates support for configuring `config.globOptions`. Exposing this variable makes it difficult to change (or upgrade) our glob library. This discourages users from depending on this config option going forward. If anyone is using `config.globOptions` then it should continue to function, however this support is not promised for the long-term. As far as I know, this is not a commonly used option: https://github.com/shelljs/shelljs/issues?q=globOptions currently shows no GitHub issues of users using this option, and there was never really a motivation for why this needed to be exposed (#400 exposed the option just because we could, not because we should). This is one step toward supporting Issue #828.
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.
Allow users to customize the settings of
glob.sync()(if they so-desire). This doesn't change the default behavior.I imagine this is a feature a few users may want (users wanted something similar for
exec()options in #163, #284, #132 ).