doc: enhance glob pattern documentation in fs.md

[mag123c]

This PR improves the documentation for fs.glob, fs.globSync, and fsPromises.glob by adding comprehensive pattern syntax explanations and practical examples.

In the current docs, the pattern parameter is mentioned but not explained clearly, making it difficult for developers to understand what glob patterns are supported and how to use them effectively.

The updated docs now include:

• Detailed pattern syntax section covering basic wildcards (*, ?, [abc]), globstar (**), brace expansion ({a,b,c}), and
  extended glob patterns (+(pattern), !(pattern))
• Comprehensive examples demonstrating recursive searches, multiple patterns, exclusion patterns, and different use cases
• Platform considerations explaining case sensitivity, path separators, symlink handling, and hidden file behavior
• Performance notes covering memory efficiency, internal caching, and optimization tips
• Improved parameter documentation with clearer descriptions and cross-references between API variants

This change resolves #58981

[iamstarkov]

thank you, looks good to me

should it be mentioned for path.matchesGlob(path, pattern) as well?

[mag123c]

I’ve added a note referencing path.matchesGlob() to indicate it uses the same glob pattern syntax.
Let me know if that's sufficient here or if you'd prefer a separate section in path.md for that function instead.

[mizulu]

path.matchesGlob() is nice to have, but how do we use this to mimic the exclude rules
which do not strictly exclude by matching (as noted on the PR code comment)

and path.matchesGlob() does not support exclude?

[mag123c]

@mizulu
path.matchesGlob() only performs simple pattern matching; the exclude functionality would need to be implemented separately.

@jasnell @lpinca
I’ve updated the comment to clarify that path.matchesGlob() does not support exclude, as this might be confusing to users.
Would you mind taking another look when you have a moment?

[mizulu]

@mag123c ,
thanks, for the confirmation.

I think path.matchesGlob should be extended to mimic the glob functionality
to allow users to mimic similar pattern matching as glob

so one can for example implement globing on an in memory file system ( list of paths )
following the same rules as the node glob. using the path.matchesGlob

This is out side the scope of this PR

I might open an issue for feature request to improve on that.

edit: #59015

[dmichon-msft]

This will match foo.spectest.js, bar.testtesttesttestspecttest.js, etc.
Seems like a bad example of this pattern type?

[dmichon-msft]

Are returned paths relative to options.cwd or absolute?
Are they normalized to the conventions of the current platform or always using / as the directory separator, consistent with how globs are specified?

[mag123c]

@dmichon-msft
Thank you for the valuable feedback. I've reviewed your comments and updated the documentation accordingly.

1. Pattern matching: I've added a clarification that the +(spec|test) pattern also matches unintended files like foo.spectest.js. Additionally, I've included an alternative example using brace expansion {spec,test} for more precise matching.

2. Path format clarification: After examining the implementation and test files, I've corrected the documentation. The returned paths do use platform-specific separators (\ on Windows, / on POSIX), not always forward slashes as previously stated. I've updated all relevant sections to reflect this.

[mb21]

This PR unfortunately seems to have stalled somewhat?

Found it looking for more docs on fs.glob, although the one thing I was most curious about isn't mentioned either: what's the order of the results? Breadth-first-search? and inside one directory, is it alphabetical, or..?

[mag123c]

@louwers Thanks for the review! I've addressed all your feedback.