Skip to content

docs: explain CLI ignore glob alternatives #1150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
blueDaydreaming725 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: explain CLI ignore glob alternatives #1150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions packages/website/src/app/docs/reference/cli/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Specify at least one glob pattern which will be used to search for files.
react-docgen ./src/components/Button.tsx

# All .ts or .tsx files in src/ or any .js files in components/
react-docgen "src/**/*.ts?(x) components/**/*.js"
react-docgen "src/**/*.ts?(x)" "components/**/*.js"
```

If you want to know more about glob patterns, check the documentation of
Expand Down Expand Up @@ -91,7 +91,24 @@ Displays the help for the command with the current default values.
**Default**: `["**/node_modules/**", "**/__tests__/**", "**/__mocks__/**"]`

Specify glob patterns of path or files, which should not be used to search for
react components.
react components. Pass a comma-separated list or repeat the option:

```shell filename="Examples"
react-docgen "src/**/*.tsx" --ignore "**/*.test.tsx,**/*.stories.tsx"

react-docgen "src/**/*.tsx" --ignore "**/*.test.tsx" --ignore "**/*.stories.tsx"
```

Commas are always treated as separators, even inside a quoted pattern. For
example, `--ignore "**/*.{test,stories}.tsx"` is split into two incomplete
patterns. Use the separate patterns above or an extglob without commas:

```shell filename="Example"
react-docgen "src/**/*.tsx" --ignore "**/*.@(test|stories).tsx"
```

Quote glob patterns so the shell passes them to the CLI without expanding them.
The comma separator applies to `--ignore` values, not positional glob arguments.

### `--importer <importer>`

Expand Down