fs.glob is stable as of v24 but lacks any documentation regarding `pattern` argument
还没有人认领这个 Issue。
- 主要语言
- JavaScript
- 星标
- 122k
- 派生
- 37.4k
- 平均合并
- 4 天 3 小时
- 30 天内合并 PR
- 272
描述
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?
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
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.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, node.js
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 活跃
- 描述清晰度
- 基本清楚
- 新手友好度
- 64/100