parent
d5e5d66407
commit
71f5d185a7
24
README.md
24
README.md
|
@ -670,6 +670,30 @@ Default | CLI Override | API Override
|
|||
--------|--------------|-------------
|
||||
None | `--stdin-filepath <string>` | `filepath: "<string>"`
|
||||
|
||||
### Require pragma
|
||||
Prettier can restrict itself to only format files that contain a special comment, called a pragma, at the top of the file. This is very useful
|
||||
when gradually transitioning large, unformatted codebases to prettier.
|
||||
|
||||
For example, a file with the following as its first comment will be formatted when `--require-pragma` is supplied:
|
||||
|
||||
```js
|
||||
/**
|
||||
* @prettier
|
||||
*/
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```js
|
||||
/**
|
||||
* @format
|
||||
*/
|
||||
```
|
||||
|
||||
Default | CLI Override | API Override
|
||||
--------|--------------|-------------
|
||||
`false` | `--require-pragma` | `requirePragma`
|
||||
|
||||
## Configuration File
|
||||
|
||||
Prettier uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for configuration file support.
|
||||
|
|
|
@ -155,4 +155,4 @@ or
|
|||
|
||||
Default | CLI Override | API Override
|
||||
--------|--------------|-------------
|
||||
None | `--require-pragma` | `requirePragma`
|
||||
`false` | `--require-pragma` | `requirePragma`
|
||||
|
|
Loading…
Reference in New Issue