dragonfly_chrome_headless 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +10 -0
- data/.travis.yml +12 -0
- data/Gemfile +4 -0
- data/README.md +53 -0
- data/Rakefile +10 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/dragonfly_chrome_headless.gemspec +27 -0
- data/lib/dragonfly_chrome_headless.rb +9 -0
- data/lib/dragonfly_chrome_headless/plugin.rb +17 -0
- data/lib/dragonfly_chrome_headless/processors/rasterize.rb +33 -0
- data/lib/dragonfly_chrome_headless/version.rb +3 -0
- data/node_modules/.bin/chrome-remote-interface +1 -0
- data/node_modules/.bin/mkdirp +1 -0
- data/node_modules/.bin/rimraf +1 -0
- data/node_modules/@types/core-js/LICENSE +21 -0
- data/node_modules/@types/core-js/README.md +16 -0
- data/node_modules/@types/core-js/index.d.ts +2452 -0
- data/node_modules/@types/core-js/package.json +85 -0
- data/node_modules/@types/mkdirp/README.md +18 -0
- data/node_modules/@types/mkdirp/index.d.ts +14 -0
- data/node_modules/@types/mkdirp/package.json +77 -0
- data/node_modules/@types/mkdirp/types-metadata.json +25 -0
- data/node_modules/@types/node/README.md +16 -0
- data/node_modules/@types/node/index.d.ts +4132 -0
- data/node_modules/@types/node/package.json +84 -0
- data/node_modules/balanced-match/.npmignore +5 -0
- data/node_modules/balanced-match/LICENSE.md +21 -0
- data/node_modules/balanced-match/README.md +91 -0
- data/node_modules/balanced-match/index.js +59 -0
- data/node_modules/balanced-match/package.json +112 -0
- data/node_modules/brace-expansion/README.md +123 -0
- data/node_modules/brace-expansion/index.js +201 -0
- data/node_modules/brace-expansion/package.json +114 -0
- data/node_modules/chrome-launcher/.clang-format +6 -0
- data/node_modules/chrome-launcher/.npmignore +11 -0
- data/node_modules/chrome-launcher/README.md +123 -0
- data/node_modules/chrome-launcher/ask.js +32 -0
- data/node_modules/chrome-launcher/ask.ts +35 -0
- data/node_modules/chrome-launcher/chrome-finder.js +157 -0
- data/node_modules/chrome-launcher/chrome-finder.ts +186 -0
- data/node_modules/chrome-launcher/chrome-launcher.js +245 -0
- data/node_modules/chrome-launcher/chrome-launcher.ts +312 -0
- data/node_modules/chrome-launcher/compiled-check.js +14 -0
- data/node_modules/chrome-launcher/flags.js +27 -0
- data/node_modules/chrome-launcher/flags.ts +26 -0
- data/node_modules/chrome-launcher/index.js +7 -0
- data/node_modules/chrome-launcher/index.ts +1 -0
- data/node_modules/chrome-launcher/manual-chrome-launcher.js +30 -0
- data/node_modules/chrome-launcher/package.json +116 -0
- data/node_modules/chrome-launcher/random-port.js +24 -0
- data/node_modules/chrome-launcher/random-port.ts +23 -0
- data/node_modules/chrome-launcher/tsconfig.json +19 -0
- data/node_modules/chrome-launcher/utils.js +52 -0
- data/node_modules/chrome-launcher/utils.ts +44 -0
- data/node_modules/chrome-launcher/yarn.lock +1486 -0
- data/node_modules/chrome-remote-interface/LICENSE +18 -0
- data/node_modules/chrome-remote-interface/README.md +849 -0
- data/node_modules/chrome-remote-interface/bin/client.js +337 -0
- data/node_modules/chrome-remote-interface/chrome-remote-interface.js +11 -0
- data/node_modules/chrome-remote-interface/index.js +39 -0
- data/node_modules/chrome-remote-interface/lib/api.js +84 -0
- data/node_modules/chrome-remote-interface/lib/chrome.js +307 -0
- data/node_modules/chrome-remote-interface/lib/defaults.js +4 -0
- data/node_modules/chrome-remote-interface/lib/devtools.js +245 -0
- data/node_modules/chrome-remote-interface/lib/external-request.js +28 -0
- data/node_modules/chrome-remote-interface/lib/protocol.json +13780 -0
- data/node_modules/chrome-remote-interface/lib/websocket-wrapper.js +32 -0
- data/node_modules/chrome-remote-interface/package.json +128 -0
- data/node_modules/chrome-remote-interface/webpack.config.js +55 -0
- data/node_modules/commander/Readme.md +195 -0
- data/node_modules/commander/index.js +851 -0
- data/node_modules/commander/package.json +92 -0
- data/node_modules/concat-map/.travis.yml +4 -0
- data/node_modules/concat-map/LICENSE +18 -0
- data/node_modules/concat-map/README.markdown +62 -0
- data/node_modules/concat-map/example/map.js +6 -0
- data/node_modules/concat-map/index.js +13 -0
- data/node_modules/concat-map/package.json +117 -0
- data/node_modules/concat-map/test/map.js +39 -0
- data/node_modules/debug/.coveralls.yml +1 -0
- data/node_modules/debug/.eslintrc +11 -0
- data/node_modules/debug/.npmignore +9 -0
- data/node_modules/debug/.travis.yml +14 -0
- data/node_modules/debug/CHANGELOG.md +357 -0
- data/node_modules/debug/LICENSE +19 -0
- data/node_modules/debug/Makefile +50 -0
- data/node_modules/debug/Readme.md +312 -0
- data/node_modules/debug/component.json +19 -0
- data/node_modules/debug/karma.conf.js +70 -0
- data/node_modules/debug/node.js +1 -0
- data/node_modules/debug/package.json +124 -0
- data/node_modules/debug/src/browser.js +185 -0
- data/node_modules/debug/src/debug.js +202 -0
- data/node_modules/debug/src/index.js +10 -0
- data/node_modules/debug/src/node.js +246 -0
- data/node_modules/fs.realpath/LICENSE +43 -0
- data/node_modules/fs.realpath/README.md +33 -0
- data/node_modules/fs.realpath/index.js +66 -0
- data/node_modules/fs.realpath/old.js +303 -0
- data/node_modules/fs.realpath/package.json +94 -0
- data/node_modules/glob/LICENSE +15 -0
- data/node_modules/glob/README.md +368 -0
- data/node_modules/glob/changelog.md +67 -0
- data/node_modules/glob/common.js +240 -0
- data/node_modules/glob/glob.js +790 -0
- data/node_modules/glob/package.json +112 -0
- data/node_modules/glob/sync.js +486 -0
- data/node_modules/html-pdf-chrome/.npmignore +9 -0
- data/node_modules/html-pdf-chrome/LICENSE +21 -0
- data/node_modules/html-pdf-chrome/README.md +165 -0
- data/node_modules/html-pdf-chrome/lib/src/ChromePrintOptions.d.ts +87 -0
- data/node_modules/html-pdf-chrome/lib/src/ChromePrintOptions.js +4 -0
- data/node_modules/html-pdf-chrome/lib/src/ChromePrintOptions.js.map +1 -0
- data/node_modules/html-pdf-chrome/lib/src/CompletionTrigger.d.ts +120 -0
- data/node_modules/html-pdf-chrome/lib/src/CompletionTrigger.js +206 -0
- data/node_modules/html-pdf-chrome/lib/src/CompletionTrigger.js.map +1 -0
- data/node_modules/html-pdf-chrome/lib/src/CreateResult.d.ts +70 -0
- data/node_modules/html-pdf-chrome/lib/src/CreateResult.js +98 -0
- data/node_modules/html-pdf-chrome/lib/src/CreateResult.js.map +1 -0
- data/node_modules/html-pdf-chrome/lib/src/index.d.ts +72 -0
- data/node_modules/html-pdf-chrome/lib/src/index.js +123 -0
- data/node_modules/html-pdf-chrome/lib/src/index.js.map +1 -0
- data/node_modules/html-pdf-chrome/package.json +133 -0
- data/node_modules/html-pdf-chrome/src/ChromePrintOptions.ts +99 -0
- data/node_modules/html-pdf-chrome/src/CompletionTrigger.ts +201 -0
- data/node_modules/html-pdf-chrome/src/CreateResult.ts +100 -0
- data/node_modules/html-pdf-chrome/src/index.ts +179 -0
- data/node_modules/inflight/LICENSE +15 -0
- data/node_modules/inflight/README.md +37 -0
- data/node_modules/inflight/inflight.js +54 -0
- data/node_modules/inflight/package.json +105 -0
- data/node_modules/inherits/LICENSE +16 -0
- data/node_modules/inherits/README.md +42 -0
- data/node_modules/inherits/inherits.js +7 -0
- data/node_modules/inherits/inherits_browser.js +23 -0
- data/node_modules/inherits/package.json +97 -0
- data/node_modules/lighthouse-logger/README.md +4 -0
- data/node_modules/lighthouse-logger/index.js +212 -0
- data/node_modules/lighthouse-logger/package.json +69 -0
- data/node_modules/lighthouse-logger/yarn.lock +13 -0
- data/node_modules/minimatch/LICENSE +15 -0
- data/node_modules/minimatch/README.md +209 -0
- data/node_modules/minimatch/minimatch.js +923 -0
- data/node_modules/minimatch/package.json +99 -0
- data/node_modules/minimist/.travis.yml +4 -0
- data/node_modules/minimist/LICENSE +18 -0
- data/node_modules/minimist/example/parse.js +2 -0
- data/node_modules/minimist/index.js +187 -0
- data/node_modules/minimist/package.json +101 -0
- data/node_modules/minimist/readme.markdown +73 -0
- data/node_modules/minimist/test/dash.js +24 -0
- data/node_modules/minimist/test/default_bool.js +20 -0
- data/node_modules/minimist/test/dotted.js +16 -0
- data/node_modules/minimist/test/long.js +31 -0
- data/node_modules/minimist/test/parse.js +318 -0
- data/node_modules/minimist/test/parse_modified.js +9 -0
- data/node_modules/minimist/test/short.js +67 -0
- data/node_modules/minimist/test/whitespace.js +8 -0
- data/node_modules/mkdirp/.travis.yml +8 -0
- data/node_modules/mkdirp/LICENSE +21 -0
- data/node_modules/mkdirp/bin/cmd.js +33 -0
- data/node_modules/mkdirp/bin/usage.txt +12 -0
- data/node_modules/mkdirp/examples/pow.js +6 -0
- data/node_modules/mkdirp/index.js +98 -0
- data/node_modules/mkdirp/package.json +93 -0
- data/node_modules/mkdirp/readme.markdown +100 -0
- data/node_modules/mkdirp/test/chmod.js +41 -0
- data/node_modules/mkdirp/test/clobber.js +38 -0
- data/node_modules/mkdirp/test/mkdirp.js +28 -0
- data/node_modules/mkdirp/test/opts_fs.js +29 -0
- data/node_modules/mkdirp/test/opts_fs_sync.js +27 -0
- data/node_modules/mkdirp/test/perm.js +32 -0
- data/node_modules/mkdirp/test/perm_sync.js +36 -0
- data/node_modules/mkdirp/test/race.js +37 -0
- data/node_modules/mkdirp/test/rel.js +32 -0
- data/node_modules/mkdirp/test/return.js +25 -0
- data/node_modules/mkdirp/test/return_sync.js +24 -0
- data/node_modules/mkdirp/test/root.js +19 -0
- data/node_modules/mkdirp/test/sync.js +32 -0
- data/node_modules/mkdirp/test/umask.js +28 -0
- data/node_modules/mkdirp/test/umask_sync.js +32 -0
- data/node_modules/ms/README.md +51 -0
- data/node_modules/ms/index.js +152 -0
- data/node_modules/ms/license.md +21 -0
- data/node_modules/ms/package.json +109 -0
- data/node_modules/once/LICENSE +15 -0
- data/node_modules/once/README.md +79 -0
- data/node_modules/once/once.js +42 -0
- data/node_modules/once/package.json +101 -0
- data/node_modules/path-is-absolute/index.js +20 -0
- data/node_modules/path-is-absolute/license +21 -0
- data/node_modules/path-is-absolute/package.json +111 -0
- data/node_modules/path-is-absolute/readme.md +59 -0
- data/node_modules/rimraf/LICENSE +15 -0
- data/node_modules/rimraf/README.md +101 -0
- data/node_modules/rimraf/bin.js +50 -0
- data/node_modules/rimraf/package.json +99 -0
- data/node_modules/rimraf/rimraf.js +363 -0
- data/node_modules/ultron/LICENSE +22 -0
- data/node_modules/ultron/index.js +138 -0
- data/node_modules/ultron/package.json +112 -0
- data/node_modules/wrappy/LICENSE +15 -0
- data/node_modules/wrappy/README.md +36 -0
- data/node_modules/wrappy/package.json +97 -0
- data/node_modules/wrappy/wrappy.js +33 -0
- data/node_modules/ws/LICENSE +21 -0
- data/node_modules/ws/README.md +259 -0
- data/node_modules/ws/SECURITY.md +33 -0
- data/node_modules/ws/index.js +15 -0
- data/node_modules/ws/lib/BufferUtil.fallback.js +56 -0
- data/node_modules/ws/lib/BufferUtil.js +15 -0
- data/node_modules/ws/lib/ErrorCodes.js +28 -0
- data/node_modules/ws/lib/EventTarget.js +158 -0
- data/node_modules/ws/lib/Extensions.js +69 -0
- data/node_modules/ws/lib/PerMessageDeflate.js +339 -0
- data/node_modules/ws/lib/Receiver.js +520 -0
- data/node_modules/ws/lib/Sender.js +438 -0
- data/node_modules/ws/lib/Validation.fallback.js +9 -0
- data/node_modules/ws/lib/Validation.js +17 -0
- data/node_modules/ws/lib/WebSocket.js +705 -0
- data/node_modules/ws/lib/WebSocketServer.js +336 -0
- data/node_modules/ws/package.json +122 -0
- data/package.json +26 -0
- data/samples/sample.html +13 -0
- data/script/rasterize.js +18 -0
- metadata +325 -0
@@ -0,0 +1,94 @@
|
|
1
|
+
{
|
2
|
+
"_args": [
|
3
|
+
[
|
4
|
+
{
|
5
|
+
"raw": "fs.realpath@^1.0.0",
|
6
|
+
"scope": null,
|
7
|
+
"escapedName": "fs.realpath",
|
8
|
+
"name": "fs.realpath",
|
9
|
+
"rawSpec": "^1.0.0",
|
10
|
+
"spec": ">=1.0.0 <2.0.0",
|
11
|
+
"type": "range"
|
12
|
+
},
|
13
|
+
"/Users/tomascelizna/Devel/dragonfly_chrome_headless/node_modules/glob"
|
14
|
+
]
|
15
|
+
],
|
16
|
+
"_from": "fs.realpath@>=1.0.0 <2.0.0",
|
17
|
+
"_id": "fs.realpath@1.0.0",
|
18
|
+
"_inCache": true,
|
19
|
+
"_location": "/fs.realpath",
|
20
|
+
"_nodeVersion": "4.4.4",
|
21
|
+
"_npmOperationalInternal": {
|
22
|
+
"host": "packages-16-east.internal.npmjs.com",
|
23
|
+
"tmp": "tmp/fs.realpath-1.0.0.tgz_1466015941059_0.3332864767871797"
|
24
|
+
},
|
25
|
+
"_npmUser": {
|
26
|
+
"name": "isaacs",
|
27
|
+
"email": "i@izs.me"
|
28
|
+
},
|
29
|
+
"_npmVersion": "3.9.1",
|
30
|
+
"_phantomChildren": {},
|
31
|
+
"_requested": {
|
32
|
+
"raw": "fs.realpath@^1.0.0",
|
33
|
+
"scope": null,
|
34
|
+
"escapedName": "fs.realpath",
|
35
|
+
"name": "fs.realpath",
|
36
|
+
"rawSpec": "^1.0.0",
|
37
|
+
"spec": ">=1.0.0 <2.0.0",
|
38
|
+
"type": "range"
|
39
|
+
},
|
40
|
+
"_requiredBy": [
|
41
|
+
"/glob"
|
42
|
+
],
|
43
|
+
"_resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
|
44
|
+
"_shasum": "1504ad2523158caa40db4a2787cb01411994ea4f",
|
45
|
+
"_shrinkwrap": null,
|
46
|
+
"_spec": "fs.realpath@^1.0.0",
|
47
|
+
"_where": "/Users/tomascelizna/Devel/dragonfly_chrome_headless/node_modules/glob",
|
48
|
+
"author": {
|
49
|
+
"name": "Isaac Z. Schlueter",
|
50
|
+
"email": "i@izs.me",
|
51
|
+
"url": "http://blog.izs.me/"
|
52
|
+
},
|
53
|
+
"bugs": {
|
54
|
+
"url": "https://github.com/isaacs/fs.realpath/issues"
|
55
|
+
},
|
56
|
+
"dependencies": {},
|
57
|
+
"description": "Use node's fs.realpath, but fall back to the JS implementation if the native one fails",
|
58
|
+
"devDependencies": {},
|
59
|
+
"directories": {},
|
60
|
+
"dist": {
|
61
|
+
"shasum": "1504ad2523158caa40db4a2787cb01411994ea4f",
|
62
|
+
"tarball": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz"
|
63
|
+
},
|
64
|
+
"files": [
|
65
|
+
"old.js",
|
66
|
+
"index.js"
|
67
|
+
],
|
68
|
+
"gitHead": "03e7c884431fe185dfebbc9b771aeca339c1807a",
|
69
|
+
"homepage": "https://github.com/isaacs/fs.realpath#readme",
|
70
|
+
"keywords": [
|
71
|
+
"realpath",
|
72
|
+
"fs",
|
73
|
+
"polyfill"
|
74
|
+
],
|
75
|
+
"license": "ISC",
|
76
|
+
"main": "index.js",
|
77
|
+
"maintainers": [
|
78
|
+
{
|
79
|
+
"name": "isaacs",
|
80
|
+
"email": "i@izs.me"
|
81
|
+
}
|
82
|
+
],
|
83
|
+
"name": "fs.realpath",
|
84
|
+
"optionalDependencies": {},
|
85
|
+
"readme": "ERROR: No README data found!",
|
86
|
+
"repository": {
|
87
|
+
"type": "git",
|
88
|
+
"url": "git+https://github.com/isaacs/fs.realpath.git"
|
89
|
+
},
|
90
|
+
"scripts": {
|
91
|
+
"test": "tap test/*.js --cov"
|
92
|
+
},
|
93
|
+
"version": "1.0.0"
|
94
|
+
}
|
@@ -0,0 +1,15 @@
|
|
1
|
+
The ISC License
|
2
|
+
|
3
|
+
Copyright (c) Isaac Z. Schlueter and Contributors
|
4
|
+
|
5
|
+
Permission to use, copy, modify, and/or distribute this software for any
|
6
|
+
purpose with or without fee is hereby granted, provided that the above
|
7
|
+
copyright notice and this permission notice appear in all copies.
|
8
|
+
|
9
|
+
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
10
|
+
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
11
|
+
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
12
|
+
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
13
|
+
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
14
|
+
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
15
|
+
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
@@ -0,0 +1,368 @@
|
|
1
|
+
# Glob
|
2
|
+
|
3
|
+
Match files using the patterns the shell uses, like stars and stuff.
|
4
|
+
|
5
|
+
[](https://travis-ci.org/isaacs/node-glob/) [](https://ci.appveyor.com/project/isaacs/node-glob) [](https://coveralls.io/github/isaacs/node-glob?branch=master)
|
6
|
+
|
7
|
+
This is a glob implementation in JavaScript. It uses the `minimatch`
|
8
|
+
library to do its matching.
|
9
|
+
|
10
|
+

|
11
|
+
|
12
|
+
## Usage
|
13
|
+
|
14
|
+
Install with npm
|
15
|
+
|
16
|
+
```
|
17
|
+
npm i glob
|
18
|
+
```
|
19
|
+
|
20
|
+
```javascript
|
21
|
+
var glob = require("glob")
|
22
|
+
|
23
|
+
// options is optional
|
24
|
+
glob("**/*.js", options, function (er, files) {
|
25
|
+
// files is an array of filenames.
|
26
|
+
// If the `nonull` option is set, and nothing
|
27
|
+
// was found, then files is ["**/*.js"]
|
28
|
+
// er is an error object or null.
|
29
|
+
})
|
30
|
+
```
|
31
|
+
|
32
|
+
## Glob Primer
|
33
|
+
|
34
|
+
"Globs" are the patterns you type when you do stuff like `ls *.js` on
|
35
|
+
the command line, or put `build/*` in a `.gitignore` file.
|
36
|
+
|
37
|
+
Before parsing the path part patterns, braced sections are expanded
|
38
|
+
into a set. Braced sections start with `{` and end with `}`, with any
|
39
|
+
number of comma-delimited sections within. Braced sections may contain
|
40
|
+
slash characters, so `a{/b/c,bcd}` would expand into `a/b/c` and `abcd`.
|
41
|
+
|
42
|
+
The following characters have special magic meaning when used in a
|
43
|
+
path portion:
|
44
|
+
|
45
|
+
* `*` Matches 0 or more characters in a single path portion
|
46
|
+
* `?` Matches 1 character
|
47
|
+
* `[...]` Matches a range of characters, similar to a RegExp range.
|
48
|
+
If the first character of the range is `!` or `^` then it matches
|
49
|
+
any character not in the range.
|
50
|
+
* `!(pattern|pattern|pattern)` Matches anything that does not match
|
51
|
+
any of the patterns provided.
|
52
|
+
* `?(pattern|pattern|pattern)` Matches zero or one occurrence of the
|
53
|
+
patterns provided.
|
54
|
+
* `+(pattern|pattern|pattern)` Matches one or more occurrences of the
|
55
|
+
patterns provided.
|
56
|
+
* `*(a|b|c)` Matches zero or more occurrences of the patterns provided
|
57
|
+
* `@(pattern|pat*|pat?erN)` Matches exactly one of the patterns
|
58
|
+
provided
|
59
|
+
* `**` If a "globstar" is alone in a path portion, then it matches
|
60
|
+
zero or more directories and subdirectories searching for matches.
|
61
|
+
It does not crawl symlinked directories.
|
62
|
+
|
63
|
+
### Dots
|
64
|
+
|
65
|
+
If a file or directory path portion has a `.` as the first character,
|
66
|
+
then it will not match any glob pattern unless that pattern's
|
67
|
+
corresponding path part also has a `.` as its first character.
|
68
|
+
|
69
|
+
For example, the pattern `a/.*/c` would match the file at `a/.b/c`.
|
70
|
+
However the pattern `a/*/c` would not, because `*` does not start with
|
71
|
+
a dot character.
|
72
|
+
|
73
|
+
You can make glob treat dots as normal characters by setting
|
74
|
+
`dot:true` in the options.
|
75
|
+
|
76
|
+
### Basename Matching
|
77
|
+
|
78
|
+
If you set `matchBase:true` in the options, and the pattern has no
|
79
|
+
slashes in it, then it will seek for any file anywhere in the tree
|
80
|
+
with a matching basename. For example, `*.js` would match
|
81
|
+
`test/simple/basic.js`.
|
82
|
+
|
83
|
+
### Empty Sets
|
84
|
+
|
85
|
+
If no matching files are found, then an empty array is returned. This
|
86
|
+
differs from the shell, where the pattern itself is returned. For
|
87
|
+
example:
|
88
|
+
|
89
|
+
$ echo a*s*d*f
|
90
|
+
a*s*d*f
|
91
|
+
|
92
|
+
To get the bash-style behavior, set the `nonull:true` in the options.
|
93
|
+
|
94
|
+
### See Also:
|
95
|
+
|
96
|
+
* `man sh`
|
97
|
+
* `man bash` (Search for "Pattern Matching")
|
98
|
+
* `man 3 fnmatch`
|
99
|
+
* `man 5 gitignore`
|
100
|
+
* [minimatch documentation](https://github.com/isaacs/minimatch)
|
101
|
+
|
102
|
+
## glob.hasMagic(pattern, [options])
|
103
|
+
|
104
|
+
Returns `true` if there are any special characters in the pattern, and
|
105
|
+
`false` otherwise.
|
106
|
+
|
107
|
+
Note that the options affect the results. If `noext:true` is set in
|
108
|
+
the options object, then `+(a|b)` will not be considered a magic
|
109
|
+
pattern. If the pattern has a brace expansion, like `a/{b/c,x/y}`
|
110
|
+
then that is considered magical, unless `nobrace:true` is set in the
|
111
|
+
options.
|
112
|
+
|
113
|
+
## glob(pattern, [options], cb)
|
114
|
+
|
115
|
+
* `pattern` `{String}` Pattern to be matched
|
116
|
+
* `options` `{Object}`
|
117
|
+
* `cb` `{Function}`
|
118
|
+
* `err` `{Error | null}`
|
119
|
+
* `matches` `{Array<String>}` filenames found matching the pattern
|
120
|
+
|
121
|
+
Perform an asynchronous glob search.
|
122
|
+
|
123
|
+
## glob.sync(pattern, [options])
|
124
|
+
|
125
|
+
* `pattern` `{String}` Pattern to be matched
|
126
|
+
* `options` `{Object}`
|
127
|
+
* return: `{Array<String>}` filenames found matching the pattern
|
128
|
+
|
129
|
+
Perform a synchronous glob search.
|
130
|
+
|
131
|
+
## Class: glob.Glob
|
132
|
+
|
133
|
+
Create a Glob object by instantiating the `glob.Glob` class.
|
134
|
+
|
135
|
+
```javascript
|
136
|
+
var Glob = require("glob").Glob
|
137
|
+
var mg = new Glob(pattern, options, cb)
|
138
|
+
```
|
139
|
+
|
140
|
+
It's an EventEmitter, and starts walking the filesystem to find matches
|
141
|
+
immediately.
|
142
|
+
|
143
|
+
### new glob.Glob(pattern, [options], [cb])
|
144
|
+
|
145
|
+
* `pattern` `{String}` pattern to search for
|
146
|
+
* `options` `{Object}`
|
147
|
+
* `cb` `{Function}` Called when an error occurs, or matches are found
|
148
|
+
* `err` `{Error | null}`
|
149
|
+
* `matches` `{Array<String>}` filenames found matching the pattern
|
150
|
+
|
151
|
+
Note that if the `sync` flag is set in the options, then matches will
|
152
|
+
be immediately available on the `g.found` member.
|
153
|
+
|
154
|
+
### Properties
|
155
|
+
|
156
|
+
* `minimatch` The minimatch object that the glob uses.
|
157
|
+
* `options` The options object passed in.
|
158
|
+
* `aborted` Boolean which is set to true when calling `abort()`. There
|
159
|
+
is no way at this time to continue a glob search after aborting, but
|
160
|
+
you can re-use the statCache to avoid having to duplicate syscalls.
|
161
|
+
* `cache` Convenience object. Each field has the following possible
|
162
|
+
values:
|
163
|
+
* `false` - Path does not exist
|
164
|
+
* `true` - Path exists
|
165
|
+
* `'FILE'` - Path exists, and is not a directory
|
166
|
+
* `'DIR'` - Path exists, and is a directory
|
167
|
+
* `[file, entries, ...]` - Path exists, is a directory, and the
|
168
|
+
array value is the results of `fs.readdir`
|
169
|
+
* `statCache` Cache of `fs.stat` results, to prevent statting the same
|
170
|
+
path multiple times.
|
171
|
+
* `symlinks` A record of which paths are symbolic links, which is
|
172
|
+
relevant in resolving `**` patterns.
|
173
|
+
* `realpathCache` An optional object which is passed to `fs.realpath`
|
174
|
+
to minimize unnecessary syscalls. It is stored on the instantiated
|
175
|
+
Glob object, and may be re-used.
|
176
|
+
|
177
|
+
### Events
|
178
|
+
|
179
|
+
* `end` When the matching is finished, this is emitted with all the
|
180
|
+
matches found. If the `nonull` option is set, and no match was found,
|
181
|
+
then the `matches` list contains the original pattern. The matches
|
182
|
+
are sorted, unless the `nosort` flag is set.
|
183
|
+
* `match` Every time a match is found, this is emitted with the specific
|
184
|
+
thing that matched. It is not deduplicated or resolved to a realpath.
|
185
|
+
* `error` Emitted when an unexpected error is encountered, or whenever
|
186
|
+
any fs error occurs if `options.strict` is set.
|
187
|
+
* `abort` When `abort()` is called, this event is raised.
|
188
|
+
|
189
|
+
### Methods
|
190
|
+
|
191
|
+
* `pause` Temporarily stop the search
|
192
|
+
* `resume` Resume the search
|
193
|
+
* `abort` Stop the search forever
|
194
|
+
|
195
|
+
### Options
|
196
|
+
|
197
|
+
All the options that can be passed to Minimatch can also be passed to
|
198
|
+
Glob to change pattern matching behavior. Also, some have been added,
|
199
|
+
or have glob-specific ramifications.
|
200
|
+
|
201
|
+
All options are false by default, unless otherwise noted.
|
202
|
+
|
203
|
+
All options are added to the Glob object, as well.
|
204
|
+
|
205
|
+
If you are running many `glob` operations, you can pass a Glob object
|
206
|
+
as the `options` argument to a subsequent operation to shortcut some
|
207
|
+
`stat` and `readdir` calls. At the very least, you may pass in shared
|
208
|
+
`symlinks`, `statCache`, `realpathCache`, and `cache` options, so that
|
209
|
+
parallel glob operations will be sped up by sharing information about
|
210
|
+
the filesystem.
|
211
|
+
|
212
|
+
* `cwd` The current working directory in which to search. Defaults
|
213
|
+
to `process.cwd()`.
|
214
|
+
* `root` The place where patterns starting with `/` will be mounted
|
215
|
+
onto. Defaults to `path.resolve(options.cwd, "/")` (`/` on Unix
|
216
|
+
systems, and `C:\` or some such on Windows.)
|
217
|
+
* `dot` Include `.dot` files in normal matches and `globstar` matches.
|
218
|
+
Note that an explicit dot in a portion of the pattern will always
|
219
|
+
match dot files.
|
220
|
+
* `nomount` By default, a pattern starting with a forward-slash will be
|
221
|
+
"mounted" onto the root setting, so that a valid filesystem path is
|
222
|
+
returned. Set this flag to disable that behavior.
|
223
|
+
* `mark` Add a `/` character to directory matches. Note that this
|
224
|
+
requires additional stat calls.
|
225
|
+
* `nosort` Don't sort the results.
|
226
|
+
* `stat` Set to true to stat *all* results. This reduces performance
|
227
|
+
somewhat, and is completely unnecessary, unless `readdir` is presumed
|
228
|
+
to be an untrustworthy indicator of file existence.
|
229
|
+
* `silent` When an unusual error is encountered when attempting to
|
230
|
+
read a directory, a warning will be printed to stderr. Set the
|
231
|
+
`silent` option to true to suppress these warnings.
|
232
|
+
* `strict` When an unusual error is encountered when attempting to
|
233
|
+
read a directory, the process will just continue on in search of
|
234
|
+
other matches. Set the `strict` option to raise an error in these
|
235
|
+
cases.
|
236
|
+
* `cache` See `cache` property above. Pass in a previously generated
|
237
|
+
cache object to save some fs calls.
|
238
|
+
* `statCache` A cache of results of filesystem information, to prevent
|
239
|
+
unnecessary stat calls. While it should not normally be necessary
|
240
|
+
to set this, you may pass the statCache from one glob() call to the
|
241
|
+
options object of another, if you know that the filesystem will not
|
242
|
+
change between calls. (See "Race Conditions" below.)
|
243
|
+
* `symlinks` A cache of known symbolic links. You may pass in a
|
244
|
+
previously generated `symlinks` object to save `lstat` calls when
|
245
|
+
resolving `**` matches.
|
246
|
+
* `sync` DEPRECATED: use `glob.sync(pattern, opts)` instead.
|
247
|
+
* `nounique` In some cases, brace-expanded patterns can result in the
|
248
|
+
same file showing up multiple times in the result set. By default,
|
249
|
+
this implementation prevents duplicates in the result set. Set this
|
250
|
+
flag to disable that behavior.
|
251
|
+
* `nonull` Set to never return an empty set, instead returning a set
|
252
|
+
containing the pattern itself. This is the default in glob(3).
|
253
|
+
* `debug` Set to enable debug logging in minimatch and glob.
|
254
|
+
* `nobrace` Do not expand `{a,b}` and `{1..3}` brace sets.
|
255
|
+
* `noglobstar` Do not match `**` against multiple filenames. (Ie,
|
256
|
+
treat it as a normal `*` instead.)
|
257
|
+
* `noext` Do not match `+(a|b)` "extglob" patterns.
|
258
|
+
* `nocase` Perform a case-insensitive match. Note: on
|
259
|
+
case-insensitive filesystems, non-magic patterns will match by
|
260
|
+
default, since `stat` and `readdir` will not raise errors.
|
261
|
+
* `matchBase` Perform a basename-only match if the pattern does not
|
262
|
+
contain any slash characters. That is, `*.js` would be treated as
|
263
|
+
equivalent to `**/*.js`, matching all js files in all directories.
|
264
|
+
* `nodir` Do not match directories, only files. (Note: to match
|
265
|
+
*only* directories, simply put a `/` at the end of the pattern.)
|
266
|
+
* `ignore` Add a pattern or an array of glob patterns to exclude matches.
|
267
|
+
Note: `ignore` patterns are *always* in `dot:true` mode, regardless
|
268
|
+
of any other settings.
|
269
|
+
* `follow` Follow symlinked directories when expanding `**` patterns.
|
270
|
+
Note that this can result in a lot of duplicate references in the
|
271
|
+
presence of cyclic links.
|
272
|
+
* `realpath` Set to true to call `fs.realpath` on all of the results.
|
273
|
+
In the case of a symlink that cannot be resolved, the full absolute
|
274
|
+
path to the matched entry is returned (though it will usually be a
|
275
|
+
broken symlink)
|
276
|
+
* `absolute` Set to true to always receive absolute paths for matched
|
277
|
+
files. Unlike `realpath`, this also affects the values returned in
|
278
|
+
the `match` event.
|
279
|
+
|
280
|
+
## Comparisons to other fnmatch/glob implementations
|
281
|
+
|
282
|
+
While strict compliance with the existing standards is a worthwhile
|
283
|
+
goal, some discrepancies exist between node-glob and other
|
284
|
+
implementations, and are intentional.
|
285
|
+
|
286
|
+
The double-star character `**` is supported by default, unless the
|
287
|
+
`noglobstar` flag is set. This is supported in the manner of bsdglob
|
288
|
+
and bash 4.3, where `**` only has special significance if it is the only
|
289
|
+
thing in a path part. That is, `a/**/b` will match `a/x/y/b`, but
|
290
|
+
`a/**b` will not.
|
291
|
+
|
292
|
+
Note that symlinked directories are not crawled as part of a `**`,
|
293
|
+
though their contents may match against subsequent portions of the
|
294
|
+
pattern. This prevents infinite loops and duplicates and the like.
|
295
|
+
|
296
|
+
If an escaped pattern has no matches, and the `nonull` flag is set,
|
297
|
+
then glob returns the pattern as-provided, rather than
|
298
|
+
interpreting the character escapes. For example,
|
299
|
+
`glob.match([], "\\*a\\?")` will return `"\\*a\\?"` rather than
|
300
|
+
`"*a?"`. This is akin to setting the `nullglob` option in bash, except
|
301
|
+
that it does not resolve escaped pattern characters.
|
302
|
+
|
303
|
+
If brace expansion is not disabled, then it is performed before any
|
304
|
+
other interpretation of the glob pattern. Thus, a pattern like
|
305
|
+
`+(a|{b),c)}`, which would not be valid in bash or zsh, is expanded
|
306
|
+
**first** into the set of `+(a|b)` and `+(a|c)`, and those patterns are
|
307
|
+
checked for validity. Since those two are valid, matching proceeds.
|
308
|
+
|
309
|
+
### Comments and Negation
|
310
|
+
|
311
|
+
Previously, this module let you mark a pattern as a "comment" if it
|
312
|
+
started with a `#` character, or a "negated" pattern if it started
|
313
|
+
with a `!` character.
|
314
|
+
|
315
|
+
These options were deprecated in version 5, and removed in version 6.
|
316
|
+
|
317
|
+
To specify things that should not match, use the `ignore` option.
|
318
|
+
|
319
|
+
## Windows
|
320
|
+
|
321
|
+
**Please only use forward-slashes in glob expressions.**
|
322
|
+
|
323
|
+
Though windows uses either `/` or `\` as its path separator, only `/`
|
324
|
+
characters are used by this glob implementation. You must use
|
325
|
+
forward-slashes **only** in glob expressions. Back-slashes will always
|
326
|
+
be interpreted as escape characters, not path separators.
|
327
|
+
|
328
|
+
Results from absolute patterns such as `/foo/*` are mounted onto the
|
329
|
+
root setting using `path.join`. On windows, this will by default result
|
330
|
+
in `/foo/*` matching `C:\foo\bar.txt`.
|
331
|
+
|
332
|
+
## Race Conditions
|
333
|
+
|
334
|
+
Glob searching, by its very nature, is susceptible to race conditions,
|
335
|
+
since it relies on directory walking and such.
|
336
|
+
|
337
|
+
As a result, it is possible that a file that exists when glob looks for
|
338
|
+
it may have been deleted or modified by the time it returns the result.
|
339
|
+
|
340
|
+
As part of its internal implementation, this program caches all stat
|
341
|
+
and readdir calls that it makes, in order to cut down on system
|
342
|
+
overhead. However, this also makes it even more susceptible to races,
|
343
|
+
especially if the cache or statCache objects are reused between glob
|
344
|
+
calls.
|
345
|
+
|
346
|
+
Users are thus advised not to use a glob result as a guarantee of
|
347
|
+
filesystem state in the face of rapid changes. For the vast majority
|
348
|
+
of operations, this is never a problem.
|
349
|
+
|
350
|
+
## Contributing
|
351
|
+
|
352
|
+
Any change to behavior (including bugfixes) must come with a test.
|
353
|
+
|
354
|
+
Patches that fail tests or reduce performance will be rejected.
|
355
|
+
|
356
|
+
```
|
357
|
+
# to run tests
|
358
|
+
npm test
|
359
|
+
|
360
|
+
# to re-generate test fixtures
|
361
|
+
npm run test-regen
|
362
|
+
|
363
|
+
# to benchmark against bash/zsh
|
364
|
+
npm run bench
|
365
|
+
|
366
|
+
# to profile javascript
|
367
|
+
npm run prof
|
368
|
+
```
|