Lucas Azzola
71a5533c4e
* Sync README -> docs/options.md * Sync README -> docs/*.md * Misc fixups * Remove markdown-toc * Remove insert-pragma from ToC * Never again! * Move all docs to ./docs * Remove yarn toc * Fix inter-doc links * Fix links in footer * Clean up README.md * Add basic description to README.md * Use flat badges * Move editor guides to website * Improve prettier-ignore docs * Fixup bad find/replace * Add JSON to README * Fix custom parser API link * Fixup GitHub centering, add downloads badge * Add 1.8 docs * docs(website): mention markdown on homepage (#1) * Add intro * Add watching-files.md * Fix markdown syntax highlighting * Switch back to .md links
86 lines
1.8 KiB
Markdown
86 lines
1.8 KiB
Markdown
---
|
|
id: configuration
|
|
title: Configuration File
|
|
---
|
|
|
|
Prettier uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for configuration file support.
|
|
This means you can configure prettier via:
|
|
|
|
* A `.prettierrc` file, written in YAML or JSON, with optional extensions: `.yaml/.yml/.json/.js`.
|
|
* A `prettier.config.js` file that exports an object.
|
|
* A `"prettier"` key in your `package.json` file.
|
|
|
|
The configuration file will be resolved starting from the location of the file being formatted,
|
|
and searching up the file tree until a config file is (or isn't) found.
|
|
|
|
The options to the configuration file are the same the [API options](options.md).
|
|
|
|
## Basic Configuration
|
|
|
|
JSON:
|
|
|
|
```json
|
|
// .prettierrc
|
|
{
|
|
"printWidth": 100,
|
|
"parser": "flow"
|
|
}
|
|
```
|
|
|
|
YAML:
|
|
|
|
```yaml
|
|
# .prettierrc
|
|
printWidth: 100
|
|
parser: flow
|
|
```
|
|
|
|
## Configuration Overrides
|
|
|
|
Prettier borrows eslint's [override format](http://eslint.org/docs/user-guide/configuring#example-configuration).
|
|
This allows you to apply configuration to specific files.
|
|
|
|
JSON:
|
|
|
|
```json
|
|
{
|
|
"semi": false,
|
|
"overrides": [{
|
|
"files": "*.test.js",
|
|
"options": {
|
|
"semi": true
|
|
}
|
|
}]
|
|
}
|
|
```
|
|
|
|
YAML:
|
|
|
|
```yaml
|
|
semi: false
|
|
overrides:
|
|
- files: "*.test.js"
|
|
options:
|
|
semi: true
|
|
```
|
|
|
|
`files` is required for each override, and may be a string or array of strings.
|
|
`excludeFiles` may be optionally provided to exclude files for a given rule, and may also be a string or array of strings.
|
|
|
|
To get prettier to format its own `.prettierrc` file, you can do:
|
|
|
|
```json
|
|
{
|
|
"overrides": [{
|
|
"files": ".prettierrc",
|
|
"options": { "parser": "json" }
|
|
}]
|
|
}
|
|
```
|
|
|
|
For more information on how to use the CLI to locate a file, see the [CLI](cli.md) section.
|
|
|
|
## Configuration Schema
|
|
|
|
If you'd like a JSON schema to validate your configuration, one is available here: http://json.schemastore.org/prettierrc.
|