Skip to content

Commit 10c325e

Browse files
committed
docs: say how buildReport() resolves outDir and what config takes
1 parent 2e9cdbe commit 10c325e

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

  • apps/docs/src/content/getting-started

‎apps/docs/src/content/getting-started/cli.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -181,14 +181,14 @@ import {buildReport} from '@pangular-inspector/devtools/cli';
181181
const {outDir} = await buildReport({outDir: 'dist/devtools-report'});
182182
```
183183

184-
| Option | What it does |
185-
| --------- | ------------------------------------------------------------------------------------------------------------------- |
186-
| `outDir` | Output directory, relative to the working directory. The default is `dist-static`. It is emptied first. |
187-
| `root` | The project folder to scan. The default is the working directory. `PANGULAR_ROOT` is not read. |
188-
| `config` | The devtools config. Without it, `pangular.config.json` in `root` is read when it exists. `PANGULAR_CONFIG` is not. |
189-
| `pretty` | Pretty-print the data files. |
190-
| `force` | Empty `outDir` even when it holds files that are not a previous report. |
191-
| `distDir` | A folder with a panel build to copy instead of the one the package ships. |
184+
| Option | What it does |
185+
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
186+
| `outDir` | Output directory, relative to the working directory, not to `root` as with `pangular build --root`. The default is `dist-static`. It is emptied first. |
187+
| `root` | The project folder to scan. The default is the working directory. `PANGULAR_ROOT` is not read. |
188+
| `config` | The devtools config as an object, not a file path. Without it, `pangular.config.json` in `root` is read when it exists. `PANGULAR_CONFIG` is not. |
189+
| `pretty` | Pretty-print the data files. |
190+
| `force` | Empty `outDir` even when it holds files that are not a previous report. |
191+
| `distDir` | A folder with a panel build to copy instead of the one the package ships. |
192192

193193
It resolves to `{outDir, root}`, both absolute paths.
194194

0 commit comments

Comments
 (0)