Skip to content

Commit

Permalink
more copy edits
Browse files Browse the repository at this point in the history
  • Loading branch information
winkerVSbecks committed Jul 31, 2024
1 parent 999cfb1 commit 483b1b3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
14 changes: 14 additions & 0 deletions src/content/configuration/cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,20 @@ Note: some options are only available as flags. For a full list of available opt

Flags must be passed as `--kebab-case` whereas options are `camelCase`. Flags take precedence over configuration options. When passing a flag without value, it is treated as `true`. Where an array is accepted, specify the flag multiple times (once for each value).

### Flags

- Flags take precedence over options specified in config file and Github Action.

- When passing a flag without value, it is treated as `true`. e.g.:
```sh
$ npx chromatic --dry-run -t <your-project-token>
```
- Where an `array` is accepted, specify the flag multiple times (once for each value). e.g.:
```sh
$ npx chromatic --externals "my-folder/**" --externals "another-folder/**" -t <your-project-token>
```


### Chromatic Config File

The configuration file is stored in the root of your project folder as `./chromatic.config.json`. You can use the `--config-file` flag to customize the Chromatic configuration file name and path.
Expand Down
17 changes: 7 additions & 10 deletions src/content/configuration/configuration-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,18 @@ import ConfigurationOptions from "../../components/ConfigurationOptions.astro";

# Configuration reference

These options control how Chromatic behaves via the [CLI](/docs/cli), [config file](/docs/cli#chromatic-config-file) and the [Github Action](/docs/github-actions). Refer to [branching docs](/docs/branching-and-baselines) and [diagnosing CLI issues](/docs/cli/#flags-to-help-diagnose-build-issues-with-the-cli) to learn more about when to use some of these flags.
These options control how Chromatic behaves via the [CLI](/docs/cli), [config file](/docs/cli#chromatic-config-file) and the [Github Action](/docs/github-actions). Refer to [branching docs](/docs/branching-and-baselines) and [diagnosing CLI issues](/docs/cli/#flags-to-help-diagnose-build-issues-with-the-cli) for more context on when to use some of these flags.

Note that the config file only supports a subset of these options. Some of the option are exclusive to either the CLI or the config file. The next section tags each option with the appropriate context.

## Options

Flags take precedence over configuration options. When passing a flag without value, it is treated as true. Where an array is accepted, specify the flag multiple times (once for each value).

<ConfigurationOptions />
Note that the config file only supports a subset of these options. Some of the option are exclusive to either the CLI or the config
file. The next section tags each option with the appropriate context.

<div class="aside">
**Glob Types**: Where supported, globs are handled via [picomatch].
</div>

Where supported, globs are handled via [picomatch].
## Options

</div>
<ConfigurationOptions />

## Environment variables

Expand Down

0 comments on commit 483b1b3

Please sign in to comment.