Skip to content

Commit 2276f2d

Browse files
committed
docs: Clarify --out argument
1 parent c171a50 commit 2276f2d

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

packages/website/src/app/docs/getting-started/cli/page.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,11 @@ Warnings and errors will still be written to `stderr`.
9898
react-docgen -o output.json ./src/components/Button.tsx
9999
```
100100

101+
<Callout type="warning" emoji="">
102+
The output path is used as provided and may overwrite an existing file, so
103+
only pass trusted paths to this option.
104+
</Callout>
105+
101106
The CLI supports a lot more advanced options and for a full list checkout the
102107
[reference page](../reference/cli)
103108

packages/website/src/app/docs/reference/cli/page.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,11 @@ Enabling this option will disable any of the default ignores specified in the
130130
Store extracted information in the specified file instead of printing to
131131
`stdout`. If the file exists it will be overwritten.
132132

133+
<Callout type="warning" emoji="">
134+
The output path is used as provided and may overwrite an existing file, so
135+
only pass trusted paths to this option.
136+
</Callout>
137+
133138
**Examples**
134139

135140
```shell filename="Terminal"

0 commit comments

Comments
 (0)