fs.glob is stable as of v24 but lacks any documentation regarding `pattern` argument
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 122k
- Forks
- 37.3k
- Ø Merge
- 4 T. 2 Std.
- Gemergte PRs (30 T.)
- 283
Beschreibung
Affected URL(s)
https://nodejs.org/docs/latest/api/fs.html#fsglobpattern-options-callback
Description of the problem
Love that native glob support came to node, however fs.glob is stable as of v24 but lacks documentation regarding pattern argument which is confusing, unhelpful and deterring adoption if you come from plethora of user land implementations. For once it prevents me from using it in my cli (edit files by glob patterns), because I can't tell to my cli's users how to write the patterns.
I'm looking for documentation for glob's aspects: platform support, performance, supported features.
I'd love to see following popular features mentioned. It will help to know if feature is supported or not, if there any caveats and examples showcasing how feature works.
- Brace Expansion (
foo/{1..5}.md,bar/{a,b,c}.js) - Extended glob matching, extglobs (
+(x|y),!(a|b)) - "Globstar" ** matching, wildcards (
**,*.js) - Posix character classes (
[[:alpha:][:digit:]]) - Support for multiple glob patterns
- Negation (
'!a/*.js','*!(b).js') - regex character classes (
foo-[1-5].js) - regex logical "or" (
foo/(abc|xyz).js)
Comparison examples with user land libraries like glob, minimatch, micromatch, fast-glob will be helpful too.
Maybe text based matching (without fs or path involved) can be moved to global or utils packages and documented in depth there?
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Start at the affected fs.glob(pattern, options, callback) documentation URL and review the current pattern argument section. Use the requested feature list, platform support, performance, and user-land library comparisons as a checklist; the work is done when supported behavior, caveats, and representative examples are documented.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, node.js
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Aktiv
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 64/100