Skip to content

docs: explain CLI ignore glob alternatives - #1150

Open
blueDaydreaming725 wants to merge 1 commit into
reactjs:mainfrom
blueDaydreaming725:docs/962-ignore-glob-examples
Open

blueDaydreaming725 wants to merge 1 commit into
reactjs:mainfrom
blueDaydreaming725:docs/962-ignore-glob-examples

Conversation

@blueDaydreaming725

Copy link
Copy Markdown

Summary

Refs #962.

Document how to exclude multiple file patterns with --ignore: comma-separated values, repeated options, or a comma-free extglob. Explain why quoting a brace list does not stop the CLI from splitting its commas. Also correct the same page's multiple positional globs example so each pattern is passed as a separate argument.

This documents existing alternatives without adding an escaping convention or changing the CLI's argument contract. It does not implement escaped literal commas or close that feature request.

Validation

Built the library and CLI, then ran the documented commands against temporary TSX fixtures. All three ignore forms excluded test/story files; the brace-list example demonstrated the documented limitation. The corrected positional glob command found files in both directories. Prettier and diff checks passed, with independent review.

The website was not rendered; no runtime code changed.

@changeset-bot

changeset-bot Bot commented Oct 23, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b0e0de2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@netlify

netlify Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for react-docgen ready!

Name Link
🔨 Latest commit b0e0de2
🔍 Latest deploy log https://app.netlify.com/projects/react-docgen/deploys/6adafe19788b76d7d71f28eb
😎 Deploy Preview https://deploy-preview-1150--react-docgen.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant