Skip to content

Commit

Permalink
Fix documentation concerning glob expansion on UNIX.
Browse files Browse the repository at this point in the history
Fixes #4868.
  • Loading branch information
binki committed Apr 11, 2022
1 parent 3946453 commit ead1635
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/index.md
Expand Up @@ -2332,9 +2332,12 @@ $ 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.
use double quotes or single quotes, the [`node-glob`][npm-glob] module will
handle its expansion. Single quotes are not supported on Windows, so you should
avoid them. Note that UNIX shells will perform
[parameter expansion](https://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_02_03)
within double quotes, so avoid using a dollar sign or backslash in any of your
paths if you want to support UNIX.

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

Expand Down

0 comments on commit ead1635

Please sign in to comment.