Skip to content

docs: fix documentation concerning glob expansion on UNIX #4869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 12, 2024
Merged

docs: fix documentation concerning glob expansion on UNIX #4869

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ead1635
Fix documentation concerning glob expansion on UNIX.
binki Apr 11, 2022
d5c86e2
Increase concision.
binki Mar 5, 2024
ab6bed3
Remove reference to misleading article and any platforms
binki Mar 12, 2024
7129fbf
Accept wording change
binki Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2331,10 +2331,11 @@ Some shells support recursive matching by using the globstar (`**`) wildcard. Ba
$ mocha "./spec/**/*.js"
```

[You should _always_ quote your globs in npm scripts][article-globbing]. If you
use double quotes, it's the shell on UNIX that will expand the glob. On the
other hand, if you use single quotes, the [`node-glob`][npm-glob] module will
handle its expansion.
You should _always_ quote your globs in npm scripts. If you
use quotes, the [`node-glob`][npm-glob] module will
handle its expansion. To support popular platforms, you must
surround the entire expression with double quotes and refrain
from `$`, `"`, `^`, and `\` within your expression.

See this [tutorial][gist-globbing-tutorial] on using globs.

Expand Down Expand Up @@ -2427,7 +2428,6 @@ For discussions join the [Google Group][google-mocha]. For a running example of
or the [source](https://github.com/mochajs/mocha/blob/master/lib/mocha.js).

[//]: # 'Cross reference section'
[article-globbing]: https://medium.com/@jakubsynowiec/you-should-always-quote-your-globs-in-npm-scripts-621887a2a784
[bash-globbing]: https://www.gnu.org/software/bash/manual/html_node/The-Shopt-Builtin.html
[better-assert]: https://github.com/visionmedia/better-assert
[caniuse-notifications]: https://caniuse.com/#feat=notifications
Expand Down