@hiiretail/gcp-infra-generators 1.1.2 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/dist/node_modules/.package-lock.json +9 -13
  2. package/dist/node_modules/glob/LICENSE.md +63 -0
  3. package/dist/node_modules/glob/README.md +126 -97
  4. package/dist/node_modules/glob/dist/commonjs/has-magic.d.ts.map +1 -1
  5. package/dist/node_modules/glob/dist/commonjs/index.d.ts +2 -2
  6. package/dist/node_modules/glob/dist/esm/bin.mjs +104 -34
  7. package/dist/node_modules/glob/dist/esm/bin.mjs.map +1 -1
  8. package/dist/node_modules/glob/dist/esm/has-magic.d.ts.map +1 -1
  9. package/dist/node_modules/glob/dist/esm/index.d.ts +2 -2
  10. package/dist/node_modules/glob/node_modules/minimatch/LICENSE.md +55 -0
  11. package/dist/node_modules/glob/node_modules/minimatch/README.md +2 -3
  12. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/assert-valid-pattern.js.map +1 -1
  13. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/ast.d.ts.map +1 -1
  14. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/ast.js +4 -5
  15. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/ast.js.map +1 -1
  16. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/brace-expressions.js.map +1 -1
  17. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/escape.d.ts +5 -2
  18. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/escape.d.ts.map +1 -1
  19. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/escape.js +10 -2
  20. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/escape.js.map +1 -1
  21. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/index.d.ts +4 -4
  22. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/index.d.ts.map +1 -1
  23. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/index.js +18 -3
  24. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/index.js.map +1 -1
  25. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/unescape.d.ts +11 -6
  26. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/unescape.d.ts.map +1 -1
  27. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/unescape.js +22 -8
  28. package/dist/node_modules/glob/node_modules/minimatch/dist/commonjs/unescape.js.map +1 -1
  29. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/assert-valid-pattern.js.map +1 -1
  30. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/ast.d.ts.map +1 -1
  31. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/ast.js +4 -5
  32. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/ast.js.map +1 -1
  33. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/brace-expressions.js.map +1 -1
  34. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/escape.d.ts +5 -2
  35. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/escape.d.ts.map +1 -1
  36. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/escape.js +10 -2
  37. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/escape.js.map +1 -1
  38. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/index.d.ts +4 -4
  39. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/index.d.ts.map +1 -1
  40. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/index.js +18 -3
  41. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/index.js.map +1 -1
  42. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/unescape.d.ts +11 -6
  43. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/unescape.d.ts.map +1 -1
  44. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/unescape.js +22 -8
  45. package/dist/node_modules/glob/node_modules/minimatch/dist/esm/unescape.js.map +1 -1
  46. package/dist/node_modules/glob/node_modules/minimatch/package.json +6 -7
  47. package/dist/node_modules/glob/package.json +11 -11
  48. package/dist/package.json +2 -2
  49. package/package.json +2 -2
  50. package/dist/node_modules/glob/LICENSE +0 -15
  51. package/dist/node_modules/glob/node_modules/minimatch/LICENSE +0 -15
@@ -877,7 +877,6 @@
877
877
  "version": "4.0.1",
878
878
  "resolved": "https://registry.npmjs.org/@isaacs/balanced-match/-/balanced-match-4.0.1.tgz",
879
879
  "integrity": "sha512-yzMTt9lEb8Gv7zRioUilSglI0c0smZ9k5D65677DLWLtWJaXIS3CqcGyUFByYKlnUj6TkjLVs54fBl6+TiGQDQ==",
880
- "license": "MIT",
881
880
  "engines": {
882
881
  "node": "20 || >=22"
883
882
  }
@@ -886,7 +885,6 @@
886
885
  "version": "5.0.0",
887
886
  "resolved": "https://registry.npmjs.org/@isaacs/brace-expansion/-/brace-expansion-5.0.0.tgz",
888
887
  "integrity": "sha512-ZT55BDLV0yv0RBm2czMiZ+SqCGO7AvmOM3G/w2xhVPH+te0aKgFjmBvGlL1dH+ql2tgGO3MVrbb3jCKyvpgnxA==",
889
- "license": "MIT",
890
888
  "dependencies": {
891
889
  "@isaacs/balanced-match": "^4.0.1"
892
890
  },
@@ -5135,14 +5133,13 @@
5135
5133
  }
5136
5134
  },
5137
5135
  "node_modules/glob": {
5138
- "version": "11.0.3",
5139
- "resolved": "https://registry.npmjs.org/glob/-/glob-11.0.3.tgz",
5140
- "integrity": "sha512-2Nim7dha1KVkaiF4q6Dj+ngPPMdfvLJEOpZk/jKiUAkqKebpGAWQXAq9z1xu9HKu5lWfqw/FASuccEjyznjPaA==",
5141
- "license": "ISC",
5136
+ "version": "11.1.0",
5137
+ "resolved": "https://registry.npmjs.org/glob/-/glob-11.1.0.tgz",
5138
+ "integrity": "sha512-vuNwKSaKiqm7g0THUBu2x7ckSs3XJLXE+2ssL7/MfTGPLLcrJQ/4Uq1CjPTtO5cCIiRxqvN6Twy1qOwhL0Xjcw==",
5142
5139
  "dependencies": {
5143
5140
  "foreground-child": "^3.3.1",
5144
5141
  "jackspeak": "^4.1.1",
5145
- "minimatch": "^10.0.3",
5142
+ "minimatch": "^10.1.1",
5146
5143
  "minipass": "^7.1.2",
5147
5144
  "package-json-from-dist": "^1.0.0",
5148
5145
  "path-scurry": "^2.0.0"
@@ -5198,10 +5195,9 @@
5198
5195
  }
5199
5196
  },
5200
5197
  "node_modules/glob/node_modules/minimatch": {
5201
- "version": "10.0.3",
5202
- "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.3.tgz",
5203
- "integrity": "sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw==",
5204
- "license": "ISC",
5198
+ "version": "10.1.1",
5199
+ "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.1.1.tgz",
5200
+ "integrity": "sha512-enIvLvRAFZYXJzkCYG5RKmPfrFArdLv+R+lbQ53BmIMLIry74bjKzX6iHAm8WYamJkhSSEabrWN5D97XnKObjQ==",
5205
5201
  "dependencies": {
5206
5202
  "@isaacs/brace-expansion": "^5.0.0"
5207
5203
  },
@@ -11541,7 +11537,7 @@
11541
11537
  },
11542
11538
  "packages/generators": {
11543
11539
  "name": "@hiiretail/gcp-infra-generators",
11544
- "version": "1.1.2",
11540
+ "version": "1.1.3",
11545
11541
  "license": "MIT",
11546
11542
  "dependencies": {
11547
11543
  "@google-cloud/storage": "^7.17.0",
@@ -11550,7 +11546,7 @@
11550
11546
  "commander": "^14.0.0",
11551
11547
  "ejs": "^3.1.10",
11552
11548
  "enquirer-separator": "^0.1.0",
11553
- "glob": "^11.0.3",
11549
+ "glob": "^11.1.0",
11554
11550
  "inquirer": "^7.3.3",
11555
11551
  "js-yaml": "^4.1.1",
11556
11552
  "semver": "^7.3.2",
@@ -0,0 +1,63 @@
1
+ All packages under `src/` are licensed according to the terms in
2
+ their respective `LICENSE` or `LICENSE.md` files.
3
+
4
+ The remainder of this project is licensed under the Blue Oak
5
+ Model License, as follows:
6
+
7
+ -----
8
+
9
+ # Blue Oak Model License
10
+
11
+ Version 1.0.0
12
+
13
+ ## Purpose
14
+
15
+ This license gives everyone as much permission to work with
16
+ this software as possible, while protecting contributors
17
+ from liability.
18
+
19
+ ## Acceptance
20
+
21
+ In order to receive this license, you must agree to its
22
+ rules. The rules of this license are both obligations
23
+ under that agreement and conditions to your license.
24
+ You must not do anything with this software that triggers
25
+ a rule that you cannot or will not follow.
26
+
27
+ ## Copyright
28
+
29
+ Each contributor licenses you to do everything with this
30
+ software that would otherwise infringe that contributor's
31
+ copyright in it.
32
+
33
+ ## Notices
34
+
35
+ You must ensure that everyone who gets a copy of
36
+ any part of this software from you, with or without
37
+ changes, also gets the text of this license or a link to
38
+ <https://blueoakcouncil.org/license/1.0.0>.
39
+
40
+ ## Excuse
41
+
42
+ If anyone notifies you in writing that you have not
43
+ complied with [Notices](#notices), you can keep your
44
+ license by taking all practical steps to comply within 30
45
+ days after the notice. If you do not do so, your license
46
+ ends immediately.
47
+
48
+ ## Patent
49
+
50
+ Each contributor licenses you to do everything with this
51
+ software that would otherwise infringe any patent claims
52
+ they can license or become able to license.
53
+
54
+ ## Reliability
55
+
56
+ No contributor can revoke this license.
57
+
58
+ ## No Liability
59
+
60
+ ***As far as the law allows, this software comes as is,
61
+ without any warranty or condition, and no contributor
62
+ will be liable to anyone for any damages related to this
63
+ software or this license, under any kind of legal claim.***
@@ -3,10 +3,12 @@
3
3
  Match files using the patterns the shell uses.
4
4
 
5
5
  The most correct and second fastest glob implementation in
6
- JavaScript. (See **Comparison to Other JavaScript Glob
7
- Implementations** at the bottom of this readme.)
6
+ JavaScript. (See [**Comparison to Other JavaScript Glob
7
+ Implementations**](#comparisons-to-other-fnmatchglob-implementations)
8
+ at the bottom of this readme.)
8
9
 
9
- ![a fun cartoon logo made of glob characters](https://github.com/isaacs/node-glob/raw/main/logo/glob.png)
10
+ ![a fun cartoon logo made of glob
11
+ characters](https://github.com/isaacs/node-glob/raw/main/logo/glob.png)
10
12
 
11
13
  ## Usage
12
14
 
@@ -16,8 +18,9 @@ Install with npm
16
18
  npm i glob
17
19
  ```
18
20
 
19
- **Note** the npm package name is _not_ `node-glob` that's a
20
- different thing that was abandoned years ago. Just `glob`.
21
+ > [!NOTE]
22
+ > The npm package name is _not_ `node-glob` that's a
23
+ > different thing that was abandoned years ago. Just `glob`.
21
24
 
22
25
  ```js
23
26
  // load using import
@@ -69,8 +72,9 @@ for (const file of g2) {
69
72
  }
70
73
 
71
74
  // you can also pass withFileTypes: true to get Path objects
72
- // these are like a Dirent, but with some more added powers
73
- // check out http://npm.im/path-scurry for more info on their API
75
+ // these are like a fs.Dirent, but with some more added powers
76
+ // check out https://isaacs.github.io/path-scurry/classes/PathBase.html
77
+ // for more info on their API
74
78
  const g3 = new Glob('**/baz/**', { withFileTypes: true })
75
79
  g3.stream().on('data', path => {
76
80
  console.log(
@@ -135,13 +139,14 @@ const newFiles = await glob('**', {
135
139
  })
136
140
  ```
137
141
 
138
- **Note** Glob patterns should always use `/` as a path separator,
139
- even on Windows systems, as `\` is used to escape glob
140
- characters. If you wish to use `\` as a path separator _instead
141
- of_ using it as an escape character on Windows platforms, you may
142
- set `windowsPathsNoEscape:true` in the options. In this mode,
143
- special glob characters cannot be escaped, making it impossible
144
- to match a literal `*` `?` and so on in filenames.
142
+ > [!NOTE]
143
+ > Glob patterns should always use `/` as a path separator,
144
+ > even on Windows systems, as `\` is used to escape glob
145
+ > characters. If you wish to use `\` as a path separator _instead
146
+ > of_ using it as an escape character on Windows platforms, you may
147
+ > set `windowsPathsNoEscape:true` in the options. In this mode,
148
+ > special glob characters cannot be escaped, making it impossible
149
+ > to match a literal `*` `?` and so on in filenames.
145
150
 
146
151
  ## Command Line Interface
147
152
 
@@ -187,7 +192,7 @@ paths found.
187
192
  -x --posix Always resolve to posix style paths, using '/' as the
188
193
  directory separator, even on Windows. Drive letter
189
194
  absolute matches on Windows will be expanded to their
190
- full resolved UNC maths, eg instead of 'C:\foo\bar', it
195
+ full resolved UNC paths, eg instead of 'C:\foo\bar', it
191
196
  will expand to '//?/C:/foo/bar'.
192
197
 
193
198
  -f --follow Follow symlinked directories when expanding '**'
@@ -362,16 +367,17 @@ Options object is required.
362
367
 
363
368
  See full options descriptions below.
364
369
 
365
- Note that a previous `Glob` object can be passed as the
366
- `GlobOptions` to another `Glob` instantiation to re-use settings
367
- and caches with a new pattern.
370
+ > [!NOTE]
371
+ > A previous `Glob` object can be passed as the
372
+ > `GlobOptions` to another `Glob` instantiation to re-use settings
373
+ > and caches with a new pattern.
368
374
 
369
375
  Traversal functions can be called multiple times to run the walk
370
376
  again.
371
377
 
372
378
  ### `g.stream()`
373
379
 
374
- Stream results asynchronously,
380
+ Stream results asynchronously.
375
381
 
376
382
  ### `g.streamSync()`
377
383
 
@@ -429,35 +435,37 @@ share the previously loaded cache.
429
435
  is used as the starting point for absolute patterns that start
430
436
  with `/`, (but not drive letters or UNC paths on Windows).
431
437
 
432
- Note that this _doesn't_ necessarily limit the walk to the
433
- `root` directory, and doesn't affect the cwd starting point for
434
- non-absolute patterns. A pattern containing `..` will still be
435
- able to traverse out of the root directory, if it is not an
436
- actual root directory on the filesystem, and any non-absolute
437
- patterns will be matched in the `cwd`. For example, the
438
- pattern `/../*` with `{root:'/some/path'}` will return all
439
- files in `/some`, not all files in `/some/path`. The pattern
440
- `*` with `{root:'/some/path'}` will return all the entries in
441
- the cwd, not the entries in `/some/path`.
442
-
443
- To start absolute and non-absolute patterns in the same
444
- path, you can use `{root:''}`. However, be aware that on
445
- Windows systems, a pattern like `x:/*` or `//host/share/*` will
446
- _always_ start in the `x:/` or `//host/share` directory,
447
- regardless of the `root` setting.
438
+ To start absolute and non-absolute patterns in the same path,
439
+ you can use `{root:''}`. However, be aware that on Windows
440
+ systems, a pattern like `x:/*` or `//host/share/*` will
441
+ _always_ start in the `x:/` or `//host/share` directory,
442
+ regardless of the `root` setting.
443
+
444
+ > [!NOTE] This _doesn't_ necessarily limit the walk to the
445
+ > `root` directory, and doesn't affect the cwd starting point
446
+ > for non-absolute patterns. A pattern containing `..` will
447
+ > still be able to traverse out of the root directory, if it
448
+ > is not an actual root directory on the filesystem, and any
449
+ > non-absolute patterns will be matched in the `cwd`. For
450
+ > example, the pattern `/../*` with `{root:'/some/path'}`
451
+ > will return all files in `/some`, not all files in
452
+ > `/some/path`. The pattern `*` with `{root:'/some/path'}`
453
+ > will return all the entries in the cwd, not the entries in
454
+ > `/some/path`.
448
455
 
449
456
  - `windowsPathsNoEscape` Use `\\` as a path separator _only_, and
450
457
  _never_ as an escape character. If set, all `\\` characters are
451
458
  replaced with `/` in the pattern.
452
459
 
453
- Note that this makes it **impossible** to match against paths
454
- containing literal glob pattern characters, but allows matching
455
- with patterns constructed using `path.join()` and
456
- `path.resolve()` on Windows platforms, mimicking the (buggy!)
457
- behavior of Glob v7 and before on Windows. Please use with
458
- caution, and be mindful of [the caveat below about Windows
459
- paths](#windows). (For legacy reasons, this is also set if
460
- `allowWindowsEscape` is set to the exact value `false`.)
460
+ > [!NOTE]
461
+ > This makes it **impossible** to match against paths
462
+ > containing literal glob pattern characters, but allows matching
463
+ > with patterns constructed using `path.join()` and
464
+ > `path.resolve()` on Windows platforms, mimicking the (buggy!)
465
+ > behavior of Glob v7 and before on Windows. Please use with
466
+ > caution, and be mindful of [the caveat below about Windows
467
+ > paths](#windows). (For legacy reasons, this is also set if
468
+ > `allowWindowsEscape` is set to the exact value `false`.)
461
469
 
462
470
  - `dot` Include `.dot` files in normal matches and `globstar`
463
471
  matches. Note that an explicit dot in a portion of the pattern
@@ -492,11 +500,12 @@ share the previously loaded cache.
492
500
  - `nocase` Perform a case-insensitive match. This defaults to
493
501
  `true` on macOS and Windows systems, and `false` on all others.
494
502
 
495
- **Note** `nocase` should only be explicitly set when it is
496
- known that the filesystem's case sensitivity differs from the
497
- platform default. If set `true` on case-sensitive file
498
- systems, or `false` on case-insensitive file systems, then the
499
- walk may return more or less results than expected.
503
+ > [!NOTE]
504
+ > `nocase` should only be explicitly set when it is
505
+ > known that the filesystem's case sensitivity differs from the
506
+ > platform default. If set `true` on case-sensitive file
507
+ > systems, or `false` on case-insensitive file systems, then the
508
+ > walk may return more or less results than expected.
500
509
 
501
510
  - `maxDepth` Specify a number to limit the depth of the directory
502
511
  traversal to this many levels below the `cwd`.
@@ -509,8 +518,9 @@ share the previously loaded cache.
509
518
  - `nodir` Do not match directories, only files. (Note: to match
510
519
  _only_ directories, put a `/` at the end of the pattern.)
511
520
 
512
- Note: when `follow` and `nodir` are both set, then symbolic
513
- links to directories are also omitted.
521
+ > [!NOTE]
522
+ > When `follow` and `nodir` are both set, then symbolic
523
+ > links to directories are also omitted.
514
524
 
515
525
  - `stat` Call `lstat()` on all entries, whether required or not
516
526
  to determine whether it's a valid match. When used with
@@ -521,19 +531,30 @@ share the previously loaded cache.
521
531
  - `ignore` string or string[], or an object with `ignored` and
522
532
  `childrenIgnored` methods.
523
533
 
524
- If a string or string[] is provided, then this is treated as a
525
- glob pattern or array of glob patterns to exclude from matches.
526
- To ignore all children within a directory, as well as the entry
527
- itself, append `'/**'` to the ignore pattern.
528
-
529
- **Note** `ignore` patterns are _always_ in `dot:true` mode,
530
- regardless of any other settings.
534
+ If a string or string[] is provided, then this is treated as
535
+ a glob pattern or array of glob patterns to exclude from
536
+ matches. To ignore all children within a directory, as well
537
+ as the entry itself, append `'/**'` to the ignore pattern.
531
538
 
532
539
  If an object is provided that has `ignored(path)` and/or
533
540
  `childrenIgnored(path)` methods, then these methods will be
534
- called to determine whether any Path is a match or if its
541
+ called todetermine whether any Path is a match or if its
535
542
  children should be traversed, respectively.
536
543
 
544
+ The `path` argument to the methods will be a
545
+ [`path-scurry`](https://isaacs.github.io/path-scurry/index.html)
546
+ [`Path`](https://isaacs.github.io/path-scurry/classes/PathBase)
547
+ object, which extends
548
+ [`fs.Dirent`](https://nodejs.org/docs/latest/api/fs.html#class-fsdirent)
549
+ with additional useful methods like
550
+ [`.fullpath()`](https://isaacs.github.io/path-scurry/classes/PathBase.html#fullpath),
551
+ [`.relative()`](https://isaacs.github.io/path-scurry/classes/PathBase.html#relative),
552
+ and more.
553
+
554
+ > [!NOTE]
555
+ > `ignore` patterns are _always_ in `dot:true` mode,
556
+ > regardless of any other settings.
557
+
537
558
  - `follow` Follow symlinked directories when expanding `**`
538
559
  patterns. This can result in a lot of duplicate references in
539
560
  the presence of cyclic links, and make performance quite bad.
@@ -542,8 +563,9 @@ share the previously loaded cache.
542
563
  it is not the first item in the pattern, or none if it is the
543
564
  first item in the pattern, following the same behavior as Bash.
544
565
 
545
- Note: when `follow` and `nodir` are both set, then symbolic
546
- links to directories are also omitted.
566
+ > [!NOTE]
567
+ > When `follow` and `nodir` are both set, then symbolic
568
+ > links to directories are also omitted.
547
569
 
548
570
  - `realpath` Set to true to call `fs.realpath` on all of the
549
571
  results. In the case of an entry that cannot be resolved, the
@@ -564,20 +586,21 @@ share the previously loaded cache.
564
586
  `absolute` may not be used along with `withFileTypes`.
565
587
 
566
588
  - `posix` Set to true to use `/` as the path separator in
567
- returned results. On posix systems, this has no effect. On
589
+ returned results. On POSIX systems, this has no effect. On
568
590
  Windows systems, this will return `/` delimited path results,
569
- and absolute paths will be returned in their full resolved UNC
570
- path form, eg insted of `'C:\\foo\\bar'`, it will return
591
+ and absolute paths will be returned in their fully resolved UNC
592
+ path form, e.g. instead of `'C:\\foo\\bar'`, it will return
571
593
  `//?/C:/foo/bar`.
572
594
 
573
- - `platform` Defaults to value of `process.platform` if
595
+ - `platform` Defaults to the value of `process.platform` if
574
596
  available, or `'linux'` if not. Setting `platform:'win32'` on
575
597
  non-Windows systems may cause strange behavior.
576
598
 
577
- - `withFileTypes` Return [PathScurry](http://npm.im/path-scurry)
578
- `Path` objects instead of strings. These are similar to a
579
- NodeJS `Dirent` object, but with additional methods and
580
- properties.
599
+ - `withFileTypes` Return
600
+ [`path-scurry`](http://npm.im/path-scurry)
601
+ [`Path`](https://isaacs.github.io/path-scurry/classes/PathBase.html)
602
+ objects instead of strings. These are similar to a NodeJS
603
+ `fs.Dirent` object, but with additional methods and properties.
581
604
 
582
605
  `withFileTypes` may not be used along with `absolute`.
583
606
 
@@ -585,13 +608,15 @@ share the previously loaded cache.
585
608
  triggered.
586
609
 
587
610
  - `fs` An override object to pass in custom filesystem methods.
588
- See [PathScurry docs](http://npm.im/path-scurry) for what can
589
- be overridden.
611
+ See [`path-scurry`
612
+ docs](https://isaacs.github.io/path-scurry/interfaces/FSOption.html)
613
+ for what can be overridden.
590
614
 
591
- - `scurry` A [PathScurry](http://npm.im/path-scurry) object used
592
- to traverse the file system. If the `nocase` option is set
593
- explicitly, then any provided `scurry` object must match this
594
- setting.
615
+ - `scurry` A
616
+ [`PathScurry`](https://isaacs.github.io/path-scurry/classes/PathScurryBase.html)
617
+ object used to traverse the file system. If the `nocase` option
618
+ is set explicitly, then any provided `scurry` object must match
619
+ this setting.
595
620
 
596
621
  - `includeChildMatches` boolean, default `true`. Do not match any
597
622
  children of any matches. For example, the pattern `**\/foo`
@@ -606,13 +631,6 @@ share the previously loaded cache.
606
631
  `false`, and a custom `Ignore` is provided that does not have
607
632
  an `add()` method, then it will throw an error.
608
633
 
609
- **Caveat** It _only_ ignores matches that would be a descendant
610
- of a previous match, and only if that descendant is matched
611
- _after_ the ancestor is encountered. Since the file system walk
612
- happens in indeterminate order, it's possible that a match will
613
- already be added before its ancestor, if multiple or braced
614
- patterns are used.
615
-
616
634
  For example:
617
635
 
618
636
  ```js
@@ -638,6 +656,15 @@ share the previously loaded cache.
638
656
  one another's file system descendants, or if the occasional
639
657
  included child entry will not cause problems.
640
658
 
659
+ > [!NOTE]
660
+ > It _only_ ignores matches that would be a descendant
661
+ > of a previous match, and only if that descendant is matched
662
+ > _after_ the ancestor is encountered. Since the file system walk
663
+ > happens in indeterminate order, it's possible that a match will
664
+ > already be added before its ancestor, if multiple or braced
665
+ > patterns are used.
666
+
667
+
641
668
  ## Glob Primer
642
669
 
643
670
  Much more information about glob pattern expansion can be found
@@ -737,11 +764,12 @@ bsdglob and bash 5, where `**` only has special significance if
737
764
  it is the only thing in a path part. That is, `a/**/b` will match
738
765
  `a/x/y/b`, but `a/**b` will not.
739
766
 
740
- Note that symlinked directories are not traversed as part of a
741
- `**`, though their contents may match against subsequent portions
742
- of the pattern. This prevents infinite loops and duplicates and
743
- the like. You can force glob to traverse symlinks with `**` by
744
- setting `{follow:true}` in the options.
767
+ > [!NOTE]
768
+ > Symlinked directories are not traversed as part of a
769
+ > `**`, though their contents may match against subsequent portions
770
+ > of the pattern. This prevents infinite loops and duplicates and
771
+ > the like. You can force glob to traverse symlinks with `**` by
772
+ > setting `{follow:true}` in the options.
745
773
 
746
774
  There is no equivalent of the `nonull` option. A pattern that
747
775
  does not find any matches simply resolves to nothing. (An empty
@@ -754,8 +782,8 @@ expanded **first** into the set of `+(a|b)` and `+(a|c)`, and
754
782
  those patterns are checked for validity. Since those two are
755
783
  valid, matching proceeds.
756
784
 
757
- The character class patterns `[:class:]` (posix standard named
758
- classes) style class patterns are supported and unicode-aware,
785
+ The character class patterns `[:class:]` (POSIX standard named
786
+ classes) style class patterns are supported and Unicode-aware,
759
787
  but `[=c=]` (locale-specific character collation weight), and
760
788
  `[.symbol.]` (collating symbol), are not.
761
789
 
@@ -779,13 +807,13 @@ To specify things that should not match, use the `ignore` option.
779
807
 
780
808
  **Please only use forward-slashes in glob expressions.**
781
809
 
782
- Though windows uses either `/` or `\` as its path separator, only
810
+ Though Windows uses either `/` or `\` as its path separator, only
783
811
  `/` characters are used by this glob implementation. You must use
784
812
  forward-slashes **only** in glob expressions. Back-slashes will
785
813
  always be interpreted as escape characters, not path separators.
786
814
 
787
815
  Results from absolute patterns such as `/foo/*` are mounted onto
788
- the root setting using `path.join`. On windows, this will by
816
+ the root setting using `path.join`. On Windows, this will by
789
817
  default result in `/foo/*` matching `C:\foo\bar.txt`.
790
818
 
791
819
  To automatically coerce all `\` characters to `/` in pattern
@@ -795,7 +823,7 @@ characters**, you may set the `windowsPathsNoEscape` option to
795
823
 
796
824
  ### Windows, CWDs, Drive Letters, and UNC Paths
797
825
 
798
- On posix systems, when a pattern starts with `/`, any `cwd`
826
+ On POSIX systems, when a pattern starts with `/`, any `cwd`
799
827
  option is ignored, and the traversal starts at `/`, plus any
800
828
  non-magic path portions specified in the pattern.
801
829
 
@@ -955,10 +983,11 @@ performing a glob pattern expansion as faithfully as possible to
955
983
  the behavior of Bash and other sh-like shells, with as much speed
956
984
  as possible.
957
985
 
958
- Note that prior versions of `node-glob` are _not_ on this list.
959
- Former versions of this module are far too slow for any cases
960
- where performance matters at all, and were designed with APIs
961
- that are extremely dated by current JavaScript standards.
986
+ > [!NOTE]
987
+ > Prior versions of `node-glob` are _not_ on this list.
988
+ > Former versions of this module are far too slow for any cases
989
+ > where performance matters at all, and were designed with APIs
990
+ > that are extremely dated by current JavaScript standards.
962
991
 
963
992
  ---
964
993
 
@@ -970,9 +999,9 @@ course.</small>
970
999
 
971
1000
  ### Benchmark Results
972
1001
 
973
- First number is time, smaller is better.
1002
+ The first number is time, smaller is better.
974
1003
 
975
- Second number is the count of results returned.
1004
+ The second number is the count of results returned.
976
1005
 
977
1006
  ```
978
1007
  --- pattern: '**' ---
@@ -1 +1 @@
1
- {"version":3,"file":"has-magic.d.ts","sourceRoot":"","sources":["../../src/has-magic.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,QAAQ,YACV,MAAM,GAAG,MAAM,EAAE,YACjB,WAAW,KACnB,OAQF,CAAA"}
1
+ {"version":3,"file":"has-magic.d.ts","sourceRoot":"","sources":["../../src/has-magic.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvC;;;;;;;;;;GAUG;AACH,eAAO,MAAM,QAAQ,GACnB,SAAS,MAAM,GAAG,MAAM,EAAE,EAC1B,UAAS,WAAgB,KACxB,OAQF,CAAA"}
@@ -91,7 +91,7 @@ export declare const glob: typeof glob_ & {
91
91
  iterateSync: typeof globIterateSync;
92
92
  Glob: typeof Glob;
93
93
  hasMagic: (pattern: string | string[], options?: GlobOptions) => boolean;
94
- escape: (s: string, { windowsPathsNoEscape, }?: Pick<import("minimatch").MinimatchOptions, "windowsPathsNoEscape">) => string;
95
- unescape: (s: string, { windowsPathsNoEscape, }?: Pick<import("minimatch").MinimatchOptions, "windowsPathsNoEscape">) => string;
94
+ escape: (s: string, { windowsPathsNoEscape, magicalBraces, }?: Pick<import("minimatch").MinimatchOptions, "windowsPathsNoEscape" | "magicalBraces">) => string;
95
+ unescape: (s: string, { windowsPathsNoEscape, magicalBraces, }?: Pick<import("minimatch").MinimatchOptions, "windowsPathsNoEscape" | "magicalBraces">) => string;
96
96
  };
97
97
  //# sourceMappingURL=index.d.ts.map