From 71f5d185a702b147b70b886979bbfa8c8c330ff0 Mon Sep 17 00:00:00 2001 From: Ika Date: Thu, 14 Sep 2017 11:26:43 +0800 Subject: [PATCH] docs(readme): port requirePragma docs to README.md (#2812) * fix default value --- README.md | 24 ++++++++++++++++++++++++ docs/options.md | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3d6d85313..be0784540 100644 --- a/README.md +++ b/README.md @@ -670,6 +670,30 @@ Default | CLI Override | API Override --------|--------------|------------- None | `--stdin-filepath ` | `filepath: ""` +### 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. diff --git a/docs/options.md b/docs/options.md index 67c339da8..5c9868be2 100644 --- a/docs/options.md +++ b/docs/options.md @@ -155,4 +155,4 @@ or Default | CLI Override | API Override --------|--------------|------------- -None | `--require-pragma` | `requirePragma` +`false` | `--require-pragma` | `requirePragma`