fs.glob is stable as of v24 but lacks any documentation regarding `pattern` argument

[iamstarkov]

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?

[juanarbol]

PRs are more than welcomed

[iamstarkov]

PRs are more than welcomed

@juanarbol oh man, I wish I could help

I lack the knowledge of implementation details, so I can't contribute, that's why I've raised the issue in the first place

[iamstarkov]

looks like @mag123c suggested a change #58988

@juanarbol, can you proof read it?