Unknown argument error when executing CLI with pages glob
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- node.js, typescript
- Domain
- cli, documentation
Research direction
Start with the component-docs serve CLI entry point and inspect the related README and component-docs.config.js references. Reproduce the issue with npx component-docs serve "example/**/*.md"; done means the glob behavior is corrected or the README clearly explains the required configuration.
Written by the indexing model from the issue text.
Description
Environment
- MacOS 10.15.7
- zsh shell
- Node.js 12.18.4
- yarn 1.22.5
Description
When I worked on this PR, and upgraded component-docs to then-latest version 0.23.0, I notice that the npm script component-docs serve "docs/*.{md,mdx}" now return this error:
$ component-docs serve "docs/*.{md,mdx}"
...
Unknown argument: docs/*.{md,mdx}
Event after recent update to 0.24.0, the issue still persists, so I have to resort to component-docs.config.js to define the pages collection.
If pages glob argument is no longer supported in recent update, I think it should be reflected in README to avoid confusion.
Reproducible Demo
Just run below command and observe the error:
npx component-docs serve "example/**/*.md"
- Dominant language
- TypeScript
- Stars
- 141
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from callstack/component-docs
-
callstack/component-docs#49 · 1 comment · 2 reactions · 1 assignee ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
callstack/component-docs#44 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
callstack/component-docs#34 ·
-
Support RNW Open
Difficulty 4/5 3-5 days Newbie friendliness 30/100
callstack/component-docs#30 · 1 reaction ·
-
greenkeeper
Difficulty 4/5 3-5 days Newbie friendliness 25/100
callstack/component-docs#18 ·
All issues in callstack/component-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug v2
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
modelcontextprotocol/inspector#2458 · 1 comment ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
railmapgen/rmp-gallery#4068 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
carbon-design-system/ibm-products#9907 ·