+
+## Intro
+
+Prettier is an opinionated code formatter. It enforces a consistent style by
+parsing your code and re-printing it with its own rules that take the maximum
+line length into account, wrapping code when necessary.
+
+### Input
```js
foo(reallyLongArg(), omgSoManyParameters(), IShouldRefactorThis(), isThereSeriouslyAnotherOne());
```
-Suddenly our previous format for calling function breaks down because this is too long. Prettier is going to do the painstaking work of reprinting it like that for you:
+### Output
```js
foo(
@@ -110,871 +60,31 @@ foo(
);
```
-Prettier enforces a consistent code **style** (i.e. code formatting that won't affect the AST) across your entire codebase because it disregards the original styling[\*](#styling-footnote) by parsing it away and re-printing the parsed AST with its own rules that take the maximum line length
-into account, wrapping code when necessary.
-
-\*_Well actually, some
-original styling is preserved when practical—see [empty lines] and [multi-line
-objects]._
-
-[empty lines]:Rationale.md#empty-lines
-[multi-line objects]:Rationale.md#multi-line-objects
-
-If you want to learn more, these two conference talks are great introductions:
-
-
-
-
-## Why Prettier?
-
-### Building and enforcing a style guide
-
-By far the biggest reason for adopting Prettier is to stop all the on-going debates over styles. It is generally accepted that having a common style guide is valuable for a project and team but getting there is a very painful and unrewarding process. People get very emotional around particular ways of writing code and nobody likes spending time writing and receiving nits.
-- “We want to free mental threads and end discussions around style. While sometimes fruitful, these discussions are for the most part wasteful.”
-- “Literally had an engineer go through a huge effort of cleaning up all of our code because we were debating ternary style for the longest time and were inconsistent about it. It was dumb, but it was a weird on-going "great debate" that wasted lots of little back and forth bits. It's far easier for us all to agree now: just run Prettier, and go with that style.”
-- “Getting tired telling people how to style their product code.”
-- “Our top reason was to stop wasting our time debating style nits.”
-- “Having a githook set up has reduced the amount of style issues in PRs that result in broken builds due to ESLint rules or things I have to nit-pick or clean up later.”
-- “I don't want anybody to nitpick any other person ever again.”
-- “It reminds me of how Steve Jobs used to wear the same clothes every day because he has a million decisions to make and he didn't want to be bothered to make trivial ones like picking out clothes. I think Prettier is like that.”
-
-### Helping Newcomers
-
-Prettier is usually introduced by people with experience in the current codebase and JavaScript but the people that disproportionally benefit from it are newcomers to the codebase. One may think that it's only useful for people with very limited programming experience, but we've seen it quicken the ramp up time from experienced engineers joining the company, as they likely used a different coding style before, and developers coming from a different programming language.
-- “My motivations for using Prettier are: appearing that I know how to write JavaScript well.”
-- “I always put spaces in the wrong place, now I don't have to worry about it anymore.”
-- “When you're a beginner you're making a lot of mistakes caused by the syntax. Thanks to Prettier, you can reduce these mistakes and save a lot of time to focus on what really matters.”
-- “As a teacher, I will also tell to my students to install Prettier to help them to learn the JS syntax and have readable files.”
-
-### Writing code
-
-What usually happens once people are using Prettier is that they realize that they actually spend a lot of time and mental energy formatting their code. With Prettier editor integration, you can just press that magic key binding and poof, the code is formatted. This is an eye opening experience if anything else.
-- “I want to write code. Not spend cycles on formatting.”
-- “It removed 5% that sucks in our daily life - aka formatting”
-- “We're in 2017 and it's still painful to break a call into multiple lines when you happen to add an argument that makes it go over the 80 columns limit :(“
-
-### Easy to adopt
-
-We've worked very hard to use the least controversial coding styles, went through many rounds of fixing all the edge cases and polished the getting started experience. When you're ready to push Prettier into your codebase, not only should it be painless for you to do it technically but the newly formatted codebase should not generate major controversy and be accepted painlessly by your co-workers.
-- “It's low overhead. We were able to throw Prettier at very different kinds of repos without much work.”
-- “It's been mostly bug free. Had there been major styling issues during the course of implementation we would have been wary about throwing this at our JS codebase. I'm happy to say that's not the case.”
-- “Everyone runs it as part of their pre commit scripts, a couple of us use the editor on save extensions as well.”
-- “It's fast, against one of our larger JS codebases we were able to run Prettier in under 13 seconds.”
-- “The biggest benefit for Prettier for us was being able to format the entire code base at once.”
-
-### Clean up an existing codebase
-
-Since coming up with a coding style and enforcing it is a big undertaking, it often slips through the cracks and you are left working on inconsistent codebases. Running Prettier in this case is a quick win, the codebase is now uniform and easier to read without spending hardly any time.
-- “Take a look at the code :) I just need to restore sanity.”
-- “We inherited a ~2000 module ES6 code base, developed by 20 different developers over 18 months, in a global team. Felt like such a win without much research.”
-
-### Ride the hype train
-
-Purely technical aspects of the projects aren't the only thing people look into when choosing to adopt Prettier. Who built and uses it and how quickly it spreads through the community has a non-trivial impact.
-- “The amazing thing, for me, is: 1) Announced 2 months ago. 2) Already adopted by, it seems, every major JS project. 3) 7000 stars, 100,000 npm downloads/mo”
-- “Was built by the same people as React & React Native.”
-- “I like to be part of the hot new things.”
-- “Because soon enough people are gonna ask for it.”
-
-A few of the [many projects](https://www.npmjs.com/browse/depended/prettier) using Prettier:
-
-
-
-
-## How does it compare to ESLint (or TSLint, stylelint...)?
-
-Linters have two categories of rules:
-
-**Formatting rules**: eg: [max-len](http://eslint.org/docs/rules/max-len), [no-mixed-spaces-and-tabs](http://eslint.org/docs/rules/no-mixed-spaces-and-tabs), [keyword-spacing](http://eslint.org/docs/rules/keyword-spacing), [comma-style](http://eslint.org/docs/rules/comma-style)...
-
-Prettier alleviates the need for this whole category of rules! Prettier is going to reprint the entire program from scratch in a consistent way, so it's not possible for the programmer to make a mistake there anymore :)
-
-**Code-quality rules**: eg [no-unused-vars](http://eslint.org/docs/rules/no-unused-vars), [no-extra-bind](http://eslint.org/docs/rules/no-extra-bind), [no-implicit-globals](http://eslint.org/docs/rules/no-implicit-globals), [prefer-promise-reject-errors](http://eslint.org/docs/rules/prefer-promise-reject-errors)...
-
-Prettier does nothing to help with those kind of rules. They are also the most important ones provided by linters as they are likely to catch real bugs with your code!
-
-
-## Usage
-
-Install:
-
-```
-yarn add prettier --dev --exact
-```
-
-You can install it globally if you like:
-
-```
-yarn global add prettier
-```
-
-*We're using `yarn` but you can use `npm` if you like:*
-
-```
-npm install --save-dev --save-exact prettier
-# or globally
-npm install --global prettier
-```
-
-> We recommend pinning an exact version of prettier in your `package.json`
-> as we introduce stylistic changes in patch releases.
-
-### CLI
-
-Run Prettier through the CLI with this script. Run it without any
-arguments to see the [options](#options).
-
-To format a file in-place, use `--write`. You may want to consider
-committing your code before doing that, just in case.
-
-```bash
-prettier [opts] [filename ...]
-```
-
-In practice, this may look something like:
-
-```bash
-prettier --single-quote --trailing-comma es5 --write "{app,__{tests,mocks}__}/**/*.js"
-```
-
-Don't forget the quotes around the globs! The quotes make sure that Prettier
-expands the globs rather than your shell, for cross-platform usage.
-The [glob syntax from the glob module](https://github.com/isaacs/node-glob/blob/master/README.md#glob-primer)
-is used.
-
-#### `--debug-check`
-
-If you're worried that Prettier will change the correctness of your code, add `--debug-check` to the command.
-This will cause Prettier to print an error message if it detects that code correctness might have changed.
-Note that `--write` cannot be used with `--debug-check`.
-
-#### `--find-config-path` and `--config`
-
-If you are repeatedly formatting individual files with `prettier`, you will incur a small performance cost
-when prettier attempts to look up a [configuration file](#configuration-file). In order to skip this, you may
-ask prettier to find the config file once, and re-use it later on.
-
-```bash
-prettier --find-config-path ./my/file.js
-./my/.prettierrc
-```
-
-This will provide you with a path to the configuration file, which you can pass to `--config`:
-
-```bash
-prettier --config ./my/.prettierrc --write ./my/file.js
-```
-
-You can also use `--config` if your configuration file lives somewhere where prettier cannot find it,
-such as a `config/` directory.
-
-If you don't have a configuration file, or want to ignore it if it does exist,
-you can pass `--no-config` instead.
-
-#### `--ignore-path`
-
-Path to a file containing patterns that describe files to ignore. By default, prettier looks for `./.prettierignore`.
-
-#### `--require-pragma`
-
-Require a special comment, called a pragma, to be present in the file's first docblock comment in order for prettier to format it.
-```js
-/**
- * @prettier
- */
-```
-
-Valid pragmas are `@prettier` and `@format`.
-
-
-#### `--list-different`
-
-Another useful flag is `--list-different` (or `-l`) which prints the filenames of files that are different from Prettier formatting. If there are differences the script errors out, which is useful in a CI scenario.
-
-```bash
-prettier --single-quote --list-different "src/**/*.js"
-```
-
-#### `--no-config`
-
-Do not look for a configuration file. The default settings will be used.
-
-#### `--config-precedence`
-
-Defines how config file should be evaluated in combination of CLI options.
-
-**cli-override (default)**
-
-CLI options take precedence over config file
-
-**file-override**
-
-Config file take precedence over CLI options
-
-**prefer-file**
-
-If a config file is found will evaluate it and ignore other CLI options. If no config file is found CLI options will evaluate as normal.
-
-This option adds support to editor integrations where users define their default configuration but want to respect project specific configuration.
-
-#### `--with-node-modules`
-
-Prettier CLI will ignore files located in `node_modules` directory. To opt-out from this behavior use `--with-node-modules` flag.
-
-#### `--write`
-
-This rewrites all processed files in place. This is comparable to the `eslint --fix` workflow.
-
-
-
-### ESLint
-
-If you are using ESLint, integrating Prettier to your workflow is straightforward:
-
-Just add Prettier as an ESLint rule using [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier).
-
-```js
-yarn add --dev prettier eslint-plugin-prettier
-
-// .eslintrc.json
-{
- "plugins": [
- "prettier"
- ],
- "rules": {
- "prettier/prettier": "error"
- }
-}
-```
-
-We also recommend that you use [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) to disable all the existing formatting rules. It's a one liner that can be added on-top of any existing ESLint configuration.
-
-```
-$ yarn add --dev eslint-config-prettier
-```
-
-.eslintrc.json:
-
-```json
-{
- "extends": [
- "prettier"
- ]
-}
-```
-
-
-### Pre-commit Hook
-
-You can use Prettier with a pre-commit tool. This can re-format your files that are marked as "staged" via `git add` before you commit.
-
-##### Option 1. [lint-staged](https://github.com/okonet/lint-staged)
-
-Install it along with [husky](https://github.com/typicode/husky):
-
-```bash
-yarn add lint-staged husky --dev
-```
-
-and add this config to your `package.json`:
-
-```json
-{
- "scripts": {
- "precommit": "lint-staged"
- },
- "lint-staged": {
- "*.{js,json,css}": [
- "prettier --write",
- "git add"
- ]
- }
-}
-```
-There is a limitation where if you stage specific lines this approach will stage the whole file after regardless. See this [issue](https://github.com/okonet/lint-staged/issues/62) for more info.
-
-See https://github.com/okonet/lint-staged#configuration for more details about how you can configure lint-staged.
-
-
-##### Option 2. [pre-commit](https://github.com/pre-commit/pre-commit)
-
-Copy the following config into your `.pre-commit-config.yaml` file:
-
-```yaml
-
- - repo: https://github.com/prettier/prettier
- sha: '' # Use the sha or tag you want to point at
- hooks:
- - id: prettier
-
-```
-
-Find more info from [here](http://pre-commit.com).
-
-##### Option 3. bash script
-
-Alternately you can save this script as `.git/hooks/pre-commit` and give it execute permission:
-
-```bash
-#!/bin/sh
-jsfiles=$(git diff --cached --name-only --diff-filter=ACM | grep '\.jsx\?$' | tr '\n' ' ')
-[ -z "$jsfiles" ] && exit 0
-
-# Prettify all staged .js files
-echo "$jsfiles" | xargs ./node_modules/.bin/prettier --write
-
-# Add back the modified/prettified files to staging
-echo "$jsfiles" | xargs git add
-
-exit 0
-```
-
-### API
-
-```js
-const prettier = require("prettier");
-```
-
-#### `prettier.format(source [, options])`
-
-`format` is used to format text using Prettier. [Options](#options) may be provided to override the defaults.
-
-```js
-prettier.format("foo ( );", { semi: false });
-// -> "foo()"
-```
-
-#### `prettier.check(source [, options])`
-
-`check` checks to see if the file has been formatted with Prettier given those options and returns a `Boolean`.
-This is similar to the `--list-different` parameter in the CLI and is useful for running Prettier in CI scenarios.
-
-#### `prettier.formatWithCursor(source [, options])`
-
-`formatWithCursor` both formats the code, and translates a cursor position from unformatted code to formatted code.
-This is useful for editor integrations, to prevent the cursor from moving when code is formatted.
-
-The `cursorOffset` option should be provided, to specify where the cursor is. This option cannot be used with `rangeStart` and `rangeEnd`.
-
-```js
-prettier.formatWithCursor(" 1", { cursorOffset: 2 });
-// -> { formatted: '1;\n', cursorOffset: 1 }
-```
-
-#### `prettier.resolveConfig(filePath [, options])`
-
-`resolveConfig` can be used to resolve configuration for a given source file, passing its path as the first argument.
-The config search will start at the file path and continue to search up the directory (you can use `process.cwd()` to start
-searching from the current directory).
-Or you can pass directly the path of the config file as `options.config` if you don't wish to search for it.
-A promise is returned which will resolve to:
-* An options object, providing a [config file](#configuration-file) was found.
-* `null`, if no file was found.
-
-The promise will be rejected if there was an error parsing the configuration file.
-
-If `options.useCache` is `false`, all caching will be bypassed.
-
-```js
-const text = fs.readFileSync(filePath, "utf8");
-prettier.resolveConfig(filePath).then(options => {
- const formatted = prettier.format(text, options);
-})
-```
-
-Use `prettier.resolveConfig.sync(filePath [, options])` if you'd like to use sync version.
-
-#### `prettier.clearConfigCache()`
-
-As you repeatedly call `resolveConfig`, the file system structure will be cached for performance.
-This function will clear the cache. Generally this is only needed for editor integrations that
-know that the file system has changed since the last format took place.
-
-
-
-#### Custom Parser API
-
-If you need to make modifications to the AST (such as codemods), or you want to provide an alternate parser, you can do so by setting the `parser` option to a function. The function signature of the parser function is:
-```js
-(text: string, parsers: object, options: object) => AST;
-```
-
-Prettier's built-in parsers are exposed as properties on the `parsers` argument.
-
-```js
-prettier.format("lodash ( )", {
- parser(text, { babylon }) {
- const ast = babylon(text);
- ast.program.body[0].expression.callee.name = "_";
- return ast;
- }
-});
-// -> "_();\n"
-```
-
-The `--parser` CLI option may be a path to a node.js module exporting a parse function.
-
-### Excluding code from formatting
-
-A JavaScript comment of `// prettier-ignore` will exclude the next node in the abstract syntax tree from formatting.
-
-For example:
-
-```js
-matrix(
- 1, 0, 0,
- 0, 1, 0,
- 0, 0, 1
-)
-
-// prettier-ignore
-matrix(
- 1, 0, 0,
- 0, 1, 0,
- 0, 0, 1
-)
-```
-
-will be transformed to:
-
-```js
-matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);
-
-// prettier-ignore
-matrix(
- 1, 0, 0,
- 0, 1, 0,
- 0, 0, 1
-)
-```
-
-## Options
-Prettier ships with a handful of customizable format options, usable in both the CLI and API.
-
-### Print Width
-Specify the line length that the printer will wrap on.
-
-> **For readability we recommend against using more than 80 characters:**
->
->In code styleguides, maximum line length rules are often set to 100 or 120. However, when humans write code, they don't strive to reach the maximum number of columns on every line. Developers often use whitespace to break up long lines for readability. In practice, the average line length often ends up well below the maximum.
->
-> Prettier, on the other hand, strives to fit the most code into every line. With the print width set to 120, prettier may produce overly compact, or otherwise undesirable code.
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`80` | `--print-width ` | `printWidth: `
-
-### Tab Width
-Specify the number of spaces per indentation-level.
-
-Default | CLI Override | API Override
---------|--------------|-------------
- `2` | `--tab-width ` | `tabWidth: `
-
-### Tabs
-Indent lines with tabs instead of spaces
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`false` | `--use-tabs` | `useTabs: `
-
-### Semicolons
-Print semicolons at the ends of statements.
-
-Valid options:
-
- * `true` - Add a semicolon at the end of every statement.
- * `false` - Only add semicolons at the beginning of lines that may introduce ASI failures.
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`true` | `--no-semi` | `semi: `
-
-### Quotes
-Use single quotes instead of double quotes.
-
-Notes:
-* Quotes in JSX will always be double and ignore this setting.
-* If the number of quotes outweighs the other quote, the quote which is less used will be used to format the string - Example: `"I'm double quoted"` results in `"I'm double quoted"` and `"This \"example\" is single quoted"` results in `'This "example" is single quoted'`.
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`false` | `--single-quote` | `singleQuote: `
-
-### Trailing Commas
-Print trailing commas wherever possible when multi-line. (A single-line array,
-for example, never gets trailing commas.)
-
-Valid options:
- * `"none"` - No trailing commas.
- * `"es5"` - Trailing commas where valid in ES5 (objects, arrays, etc.)
- * `"all"` - Trailing commas wherever possible (including function arguments). This requires node 8 or a [transform](https://babeljs.io/docs/plugins/syntax-trailing-function-commas/).
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`"none"` | --trailing-comma | trailingComma: ""
-
-### Bracket Spacing
-Print spaces between brackets in object literals.
-
-Valid options:
- * `true` - Example: `{ foo: bar }`.
- * `false` - Example: `{foo: bar}`.
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`true` | `--no-bracket-spacing` | `bracketSpacing: `
-
-### JSX Brackets
-Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`false` | `--jsx-bracket-same-line` | `jsxBracketSameLine: `
-
-### Range
-Format only a segment of a file.
-
-These two options can be used to format code starting and ending at a given character offset (inclusive and exclusive, respectively). The range will extend:
-* Backwards to the start of the first line containing the selected statement.
-* Forwards to the end of the selected statement.
-
-These options cannot be used with `cursorOffset`.
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`0` | `--range-start `| `rangeStart: `
-`Infinity` | `--range-end ` | `rangeEnd: `
-
-### Parser
-Specify which parser to use.
-
-Both the `babylon` and `flow` parsers support the same set of JavaScript features (including Flow). Prettier automatically infers the parser from the input file path, so you shouldn't have to change this setting.
-
-Built-in parsers:
- * [`babylon`](https://github.com/babel/babylon/)
- * [`flow`](https://github.com/facebook/flow/tree/master/src/parser)
- * [`typescript`](https://github.com/eslint/typescript-eslint-parser) _Since v1.4.0_
- * [`postcss`](https://github.com/postcss/postcss) _Since v1.4.0_
- * [`json`](https://github.com/babel/babylon/tree/f09eb3200f57ea94d51c2a5b1facf2149fb406bf#babylonparseexpressioncode-options) _Since v1.5.0_
- * [`graphql`](https://github.com/graphql/graphql-js/tree/master/src/language) _Since v1.5.0_
-
-[Custom parsers](#custom-parser-api) are also supported. _Since v1.5.0_
-
-Default | CLI Override | API Override
---------|--------------|-------------
-`babylon` | `--parser ` `--parser ./my-parser` | `parser: ""` `parser: require("./my-parser")`
-
-### Filepath
-Specify the input filepath. This will be used to do parser inference.
-
-For example, the following will use `postcss` parser:
-
-```bash
-cat foo | prettier --stdin-filepath foo.css
-```
-
-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.
-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).
-
-### 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) section.
-
-### Configuration Schema
-
-If you'd like a JSON schema to validate your configuration, one is available here: http://json.schemastore.org/prettierrc.
-
-## Editor Integration
-
-### Atom
-
-Atom users can simply install the [prettier-atom](https://github.com/prettier/prettier-atom) package and use
-`Ctrl+Alt+F` to format a file (or format on save if enabled).
-
-### Emacs
-
-Emacs users should see [this repository](https://github.com/prettier/prettier-emacs)
-for on-demand formatting.
-
-### Vim
-
-Vim users can simply install either [sbdchd](https://github.com/sbdchd)/[neoformat](https://github.com/sbdchd/neoformat), [w0rp](https://github.com/w0rp)/[ale](https://github.com/w0rp/ale), or [prettier](https://github.com/prettier)/[vim-prettier](https://github.com/prettier/vim-prettier), for more details see [this directory](https://github.com/prettier/prettier/tree/master/editors/vim).
-
-### Visual Studio Code
-
-Can be installed using the extension sidebar. Search for `Prettier - JavaScript formatter`.
-
-Can also be installed using `ext install prettier-vscode`.
-
-[Check its repository for configuration and shortcuts](https://github.com/prettier/prettier-vscode)
-
-### Visual Studio
-
-Install the [JavaScript Prettier extension](https://github.com/madskristensen/JavaScriptPrettier).
-
-### Sublime Text
-
-Sublime Text support is available through Package Control and
-the [JsPrettier](https://packagecontrol.io/packages/JsPrettier) plug-in.
-
-### JetBrains WebStorm, PHPStorm, PyCharm...
-
-See the [WebStorm
-guide](https://github.com/jlongster/prettier/tree/master/editors/webstorm/README.md).
-
-## Watching For Changes On The Command Line
-
-If you prefer to have prettier watch for changes from the command line you can use a package like [onchange](https://www.npmjs.com/package/onchange). For example:
-
-```
-npx onchange '**/*.js' -- npx prettier --write {{changed}}
-```
-
-or add the following to your `package.json`
-
-```json
- "scripts": {
- "prettier-watch": "onchange '**/*.js' -- prettier --write {{changed}}"
- },
-```
-
-## Language Support
-
-Prettier attempts to support all JavaScript language features,
-including non-standardized ones. By default it uses the
-[Babylon](https://github.com/babel/babylon) parser with all language
-features enabled, but you can also use the
-[Flow](https://github.com/facebook/flow) parser with the
-`parser` API or `--parser` CLI [option](#options).
-
-All of JSX and Flow syntax is supported. In fact, the test suite in
-`tests/flow` *is* the entire Flow test suite and they all pass.
-
-Prettier also supports [TypeScript](https://www.typescriptlang.org/), CSS, [Less](http://lesscss.org/), [SCSS](http://sass-lang.com), [JSON](http://json.org/), and [GraphQL](http://graphql.org/).
-
-The minimum version of TypeScript supported is 2.1.3 as it introduces the ability to have leading `|` for type definitions which prettier outputs.
-
-## Related Projects
-
-### ESLint Integrations
-
-- [`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) plugs Prettier into your ESLint workflow
-- [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) turns off all ESLint rules that are unnecessary or might conflict with Prettier
-- [`prettier-eslint`](https://github.com/prettier/prettier-eslint)
-passes `prettier` output to `eslint --fix`
-- [`prettier-standard`](https://github.com/sheerun/prettier-standard)
-uses `prettier` and `prettier-eslint` to format code with standard rules
-- [`prettier-standard-formatter`](https://github.com/dtinth/prettier-standard-formatter)
-passes `prettier` output to `standard --fix`
-
-### TSLint Integrations
-
-- [`tslint-plugin-prettier`](https://github.com/ikatyang/tslint-plugin-prettier) runs Prettier as a TSLint rule and reports differences as individual TSLint issues
-- [`tslint-config-prettier`](https://github.com/alexjoverm/tslint-config-prettier) use TSLint with Prettier without any conflict
-- [`prettier-tslint`](https://github.com/azz/prettier-tslint)
-passes `prettier` output to `tslint --fix`
-
-### stylelint Integrations
-
-- [`prettier-stylelint`](https://github.com/hugomrdias/prettier-stylelint)
-passes `prettier` output to `stylelint --fix`
-- [`stylelint-config-prettier`](https://github.com/shannonmoeller/stylelint-config-prettier) turns off all rules that are unnecessary or might conflict with Prettier.
-
-### Forks
-
-- [`prettier-miscellaneous`](https://github.com/arijs/prettier-miscellaneous)
-`prettier` with a few minor extra options
-
-### Misc
-
-- [`neutrino-preset-prettier`](https://github.com/SpencerCDixon/neutrino-preset-prettier) allows you to use Prettier as a Neutrino preset
-- [`prettier_d`](https://github.com/josephfrazier/prettier_d.js) runs Prettier as a server to avoid Node.js startup delay. It also supports configuration via `.prettierrc`, `package.json`, and `.editorconfig`.
-- [`Prettier Bookmarklet`](https://prettier.glitch.me/) provides a bookmarklet and exposes a REST API for Prettier that allows to format CodeMirror editor in your browser
-- [`prettier-github`](https://github.com/jgierer12/prettier-github) formats code in GitHub comments
-- [`rollup-plugin-prettier`](https://github.com/mjeanroy/rollup-plugin-prettier) allows you to use Prettier with Rollup
-- [`markdown-magic-prettier`](https://github.com/camacho/markdown-magic-prettier) allows you to use Prettier to format JS [codeblocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/) in Markdown files via [Markdown Magic](https://github.com/DavidWells/markdown-magic)
-
+Prettier can be ran [in your editor](http://prettier.io/docs/en/editors.html)
+on-save, in a [pre-commit hook](https://prettier.io/docs/en/precommit.html),
+or in [CI environments](https://prettier.io/docs/en/cli.html#list-different)
+to ensure your codebase has a consistent style without devs ever having to post
+a nit comment on a code review ever again!
-## Technical Details
+- - -
-This printer is a fork of
-[recast](https://github.com/benjamn/recast)'s printer with its
-algorithm replaced by the one described by Wadler in "[A prettier
-printer](http://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf)".
-There still may be leftover code from recast that needs to be cleaned
-up.
+**[Documentation](https://prettier.io/docs/en/)**
-The basic idea is that the printer takes an AST and returns an
-intermediate representation of the output, and the printer uses that
-to generate a string. The advantage is that the printer can "measure"
-the IR and see if the output is going to fit on a line, and break if
-not.
+[Install](https://prettier.io/docs/en/install.html) ·
+[Options](https://prettier.io/docs/en/options.html) ·
+[CLI](https://prettier.io/docs/en/cli.html) ·
+[API](https://prettier.io/docs/en/usage-options.html)
-This means that most of the logic of printing an AST involves
-generating an abstract representation of the output involving certain
-commands. For example, `concat(["(", line, arg, line ")"])` would
-represent a concatenation of opening parens, an argument, and closing
-parens. But if that doesn't fit on one line, the printer can break
-where `line` is specified.
+**[Playground](https://prettier.io/playground/)**
-More (rough) details can be found in [commands.md](commands.md).
+- - -
## Badge
-Show the world you're using *Prettier* → [](https://github.com/prettier/prettier)
+Show the world you're using *Prettier* → [](https://github.com/prettier/prettier)
```md
-[](https://github.com/prettier/prettier)
+[](https://github.com/prettier/prettier)
```
## Contributing
diff --git a/docs/api.md b/docs/api.md
new file mode 100644
index 000000000000..9e0557044901
--- /dev/null
+++ b/docs/api.md
@@ -0,0 +1,115 @@
+---
+id: api
+title: API
+---
+
+```js
+const prettier = require("prettier");
+```
+
+## `prettier.format(source [, options])`
+
+`format` is used to format text using Prettier. [Options](options.md) may be provided to override the defaults.
+
+```js
+prettier.format("foo ( );", { semi: false });
+// -> "foo()"
+```
+
+## `prettier.check(source [, options])`
+
+`check` checks to see if the file has been formatted with Prettier given those options and returns a `Boolean`.
+This is similar to the `--list-different` parameter in the CLI and is useful for running Prettier in CI scenarios.
+
+## `prettier.formatWithCursor(source [, options])`
+
+`formatWithCursor` both formats the code, and translates a cursor position from unformatted code to formatted code.
+This is useful for editor integrations, to prevent the cursor from moving when code is formatted.
+
+The `cursorOffset` option should be provided, to specify where the cursor is. This option cannot be used with `rangeStart` and `rangeEnd`.
+
+```js
+prettier.formatWithCursor(" 1", { cursorOffset: 2 });
+// -> { formatted: '1;\n', cursorOffset: 1 }
+```
+
+## `prettier.resolveConfig(filePath [, options])`
+
+`resolveConfig` can be used to resolve configuration for a given source file, passing its path as the first argument.
+The config search will start at the file path and continue to search up the directory (you can use `process.cwd()` to start
+searching from the current directory).
+Or you can pass directly the path of the config file as `options.config` if you don't wish to search for it.
+A promise is returned which will resolve to:
+* An options object, providing a [config file](./configuration-file.html) was found.
+* `null`, if no file was found.
+
+The promise will be rejected if there was an error parsing the configuration file.
+
+If `options.useCache` is `false`, all caching will be bypassed.
+
+```js
+const text = fs.readFileSync(filePath, "utf8");
+prettier.resolveConfig(filePath).then(options => {
+ const formatted = prettier.format(text, options);
+})
+```
+
+Use `prettier.resolveConfig.sync(filePath [, options])` if you'd like to use sync version.
+
+## `prettier.clearConfigCache()`
+
+As you repeatedly call `resolveConfig`, the file system structure will be cached for performance.
+This function will clear the cache. Generally this is only needed for editor integrations that
+know that the file system has changed since the last format took place.
+
+## `prettier.getSupportInfo([version])`
+
+Returns an object representing the parsers, languages and file types Prettier
+supports.
+
+If `version` is provided (e.g. `"1.5.0"`), information for that version will be
+returned, otherwise information for the current version will be returned.
+
+The support information looks like this:
+
+```
+{
+ languages: Array<{
+ name: string,
+ since: string,
+ parsers: string[],
+ group?: string,
+ tmScope: string,
+ aceMode: string,
+ codemirrorMode: string,
+ codemirrorMimeType: string,
+ aliases?: string[],
+ extensions: string[],
+ filenames?: string[],
+ linguistLanguageId: number,
+ vscodeLanguageIds: string[],
+ }>
+}
+```
+
+## Custom Parser API
+
+If you need to make modifications to the AST (such as codemods), or you want to provide an alternate parser, you can do so by setting the `parser` option to a function. The function signature of the parser function is:
+```js
+(text: string, parsers: object, options: object) => AST;
+```
+
+Prettier's built-in parsers are exposed as properties on the `parsers` argument.
+
+```js
+prettier.format("lodash ( )", {
+ parser(text, { babylon }) {
+ const ast = babylon(text);
+ ast.program.body[0].expression.callee.name = "_";
+ return ast;
+ }
+});
+// -> "_();\n"
+```
+
+The `--parser` CLI option may be a path to a node.js module exporting a parse function.
diff --git a/docs/cli.md b/docs/cli.md
new file mode 100644
index 000000000000..ed6494ada148
--- /dev/null
+++ b/docs/cli.md
@@ -0,0 +1,114 @@
+---
+id: cli
+title: CLI
+---
+
+Run Prettier through the CLI with this script. Run it without any
+arguments to see the [options](options.md).
+
+To format a file in-place, use `--write`. You may want to consider
+committing your code before doing that, just in case.
+
+```bash
+prettier [opts] [filename ...]
+```
+
+In practice, this may look something like:
+
+```bash
+prettier --single-quote --trailing-comma es5 --write "{app,__{tests,mocks}__}/**/*.js"
+```
+
+Don't forget the quotes around the globs! The quotes make sure that Prettier
+expands the globs rather than your shell, for cross-platform usage.
+The [glob syntax from the glob module](https://github.com/isaacs/node-glob/blob/master/README.md#glob-primer)
+is used.
+
+Prettier CLI will ignore files located in `node_modules` directory. To opt-out from this behavior use `--with-node-modules` flag.
+
+## `--debug-check`
+
+If you're worried that Prettier will change the correctness of your code, add `--debug-check` to the command.
+This will cause Prettier to print an error message if it detects that code correctness might have changed.
+Note that `--write` cannot be used with `--debug-check`.
+
+## `--find-config-path` and `--config`
+
+If you are repeatedly formatting individual files with `prettier`, you will incur a small performance cost
+when prettier attempts to look up a [configuration file](./configuration-file.html). In order to skip this, you may
+ask prettier to find the config file once, and re-use it later on.
+
+```bash
+prettier --find-config-path ./my/file.js
+./my/.prettierrc
+```
+
+This will provide you with a path to the configuration file, which you can pass to `--config`:
+
+```bash
+prettier --config ./my/.prettierrc --write ./my/file.js
+```
+
+You can also use `--config` if your configuration file lives somewhere where prettier cannot find it,
+such as a `config/` directory.
+
+If you don't have a configuration file, or want to ignore it if it does exist,
+you can pass `--no-config` instead.
+
+### `--ignore-path`
+
+Path to a file containing patterns that describe files to ignore. By default, prettier looks for `./.prettierignore`.
+
+## `--require-pragma`
+
+Require a special comment, called a pragma, to be present in the file's first docblock comment in order for prettier to format it.
+```js
+/**
+ * @prettier
+ */
+```
+
+Valid pragmas are `@prettier` and `@format`.
+
+## `--insert-pragma`
+
+Insert a `@format` pragma to the top of formatted files when pragma is absent.
+Works well when used in tandem with `--require-pragma`.
+
+## `--list-different`
+
+Another useful flag is `--list-different` (or `-l`) which prints the filenames of files that are different from Prettier formatting. If there are differences the script errors out, which is useful in a CI scenario.
+
+```bash
+prettier --single-quote --list-different "src/**/*.js"
+```
+
+## `--no-config`
+
+Do not look for a configuration file. The default settings will be used.
+
+## `--config-precedence`
+
+Defines how config file should be evaluated in combination of CLI options.
+
+**cli-override (default)**
+
+CLI options take precedence over config file
+
+**file-override**
+
+Config file take precedence over CLI options
+
+**prefer-file**
+
+If a config file is found will evaluate it and ignore other CLI options. If no config file is found CLI options will evaluate as normal.
+
+This option adds support to editor integrations where users define their default configuration but want to respect project specific configuration.
+
+## `--with-node-modules`
+
+Prettier CLI will ignore files located in `node_modules` directory. To opt-out from this behavior use `--with-node-modules` flag.
+
+## `--write`
+
+This rewrites all processed files in place. This is comparable to the `eslint --fix` workflow.
diff --git a/docs/comparison.md b/docs/comparison.md
new file mode 100644
index 000000000000..e8c4b9caaab1
--- /dev/null
+++ b/docs/comparison.md
@@ -0,0 +1,16 @@
+---
+id: comparison
+title: Prettier vs. Linters
+---
+
+## How does it compare to ESLint/TSLint/stylelint, etc.?
+
+Linters have two categories of rules:
+
+**Formatting rules**: eg: [max-len](http://eslint.org/docs/rules/max-len), [no-mixed-spaces-and-tabs](http://eslint.org/docs/rules/no-mixed-spaces-and-tabs), [keyword-spacing](http://eslint.org/docs/rules/keyword-spacing), [comma-style](http://eslint.org/docs/rules/comma-style)...
+
+Prettier alleviates the need for this whole category of rules! Prettier is going to reprint the entire program from scratch in a consistent way, so it's not possible for the programmer to make a mistake there anymore :)
+
+**Code-quality rules**: eg [no-unused-vars](http://eslint.org/docs/rules/no-unused-vars), [no-extra-bind](http://eslint.org/docs/rules/no-extra-bind), [no-implicit-globals](http://eslint.org/docs/rules/no-implicit-globals), [prefer-promise-reject-errors](http://eslint.org/docs/rules/prefer-promise-reject-errors)...
+
+Prettier does nothing to help with those kind of rules. They are also the most important ones provided by linters as they are likely to catch real bugs with your code!
diff --git a/docs/configuration.md b/docs/configuration.md
new file mode 100644
index 000000000000..34783b0294fc
--- /dev/null
+++ b/docs/configuration.md
@@ -0,0 +1,85 @@
+---
+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.
diff --git a/docs/editors.md b/docs/editors.md
index fc0feba8b202..4f153065dc81 100644
--- a/docs/editors.md
+++ b/docs/editors.md
@@ -3,7 +3,6 @@ id: editors
title: Editor Integration
---
-
## Atom
Atom users can simply install the [prettier-atom](https://github.com/prettier/prettier-atom) package and use
@@ -16,7 +15,7 @@ for on-demand formatting.
## Vim
-Vim users can simply install either [sbdchd](https://github.com/sbdchd)/[neoformat](https://github.com/sbdchd/neoformat), [w0rp](https://github.com/w0rp)/[ale](https://github.com/w0rp/ale), or [prettier](https://github.com/prettier)/[vim-prettier](https://github.com/prettier/vim-prettier), for more details see [this directory](https://github.com/prettier/prettier/tree/master/editors/vim).
+Vim users can simply install either [sbdchd](https://github.com/sbdchd)/[neoformat](https://github.com/sbdchd/neoformat), [w0rp](https://github.com/w0rp)/[ale](https://github.com/w0rp/ale), or [prettier](https://github.com/prettier)/[vim-prettier](https://github.com/prettier/vim-prettier), for more details see [the vim setup guide](vim.md).
## Visual Studio Code
@@ -37,6 +36,4 @@ the [JsPrettier](https://packagecontrol.io/packages/JsPrettier) plug-in.
## JetBrains WebStorm, PHPStorm, PyCharm...
-See the [WebStorm
-guide](https://github.com/jlongster/prettier/tree/master/editors/webstorm/README.md).
-
+See the [WebStorm setup guide](webstorm.md).
diff --git a/docs/eslint.md b/docs/eslint.md
new file mode 100644
index 000000000000..93cb7abbe766
--- /dev/null
+++ b/docs/eslint.md
@@ -0,0 +1,38 @@
+---
+id: eslint
+title: Integrating with ESLint
+---
+
+If you are using ESLint, integrating Prettier to your workflow is straightforward:
+
+Just add Prettier as an ESLint rule using [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier).
+
+```js
+yarn add --dev prettier eslint-plugin-prettier
+
+// .eslintrc.json
+{
+ "plugins": [
+ "prettier"
+ ],
+ "rules": {
+ "prettier/prettier": "error"
+ }
+}
+```
+
+We also recommend that you use [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) to disable all the existing formatting rules. It's a one liner that can be added on-top of any existing ESLint configuration.
+
+```
+$ yarn add --dev eslint-config-prettier
+```
+
+.eslintrc.json:
+
+```json
+{
+ "extends": [
+ "prettier"
+ ]
+}
+```
diff --git a/docs/ignore.md b/docs/ignore.md
new file mode 100644
index 000000000000..7849a9a3312d
--- /dev/null
+++ b/docs/ignore.md
@@ -0,0 +1,66 @@
+---
+id: ignore
+title: Ignoring Code
+---
+
+Prettier offers an escape hatch to ignore a block of code from being formatted.
+
+## JavaScript
+
+A JavaScript comment of `// prettier-ignore` will exclude the next node in the abstract syntax tree from formatting.
+
+For example:
+
+```js
+matrix(
+ 1, 0, 0,
+ 0, 1, 0,
+ 0, 0, 1
+)
+
+// prettier-ignore
+matrix(
+ 1, 0, 0,
+ 0, 1, 0,
+ 0, 0, 1
+)
+```
+
+will be transformed to:
+
+```js
+matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);
+
+// prettier-ignore
+matrix(
+ 1, 0, 0,
+ 0, 1, 0,
+ 0, 0, 1
+)
+```
+
+## JSX
+
+```jsx
+
+ {/* prettier-ignore */}
+
+
;
+```
+
+## CSS
+
+```css
+/* prettier-ignore */
+.my ugly rule
+{
+
+}
+```
+
+## Markdown
+
+```markdown
+
+Do not format this
+```
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 000000000000..3a6ebc705f99
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,60 @@
+---
+id: index
+title: What is Prettier?
+---
+
+Prettier is an opinionated code formatter with support for:
+
+* JavaScript, including [ES2017](https://github.com/tc39/proposals/blob/master/finished-proposals.md)
+* [JSX](https://facebook.github.io/jsx/)
+* [Flow](https://flow.org/)
+* [TypeScript](https://www.typescriptlang.org/)
+* CSS, [Less](http://lesscss.org/), and [SCSS](http://sass-lang.com)
+* [JSON](http://json.org/)
+* [GraphQL](http://graphql.org/)
+* [Markdown](http://commonmark.org/), including [GFM](https://github.github.com/gfm/)
+
+It removes all original styling[\*](#footnotes) and ensures that all outputted code
+conforms to a consistent style. (See this [blog post](http://jlongster.com/A-Prettier-Formatter))
+
+Prettier takes your code and reprints it from scratch by taking the line length into account.
+
+For example, take the following code:
+
+```js
+foo(arg1, arg2, arg3, arg4);
+```
+
+It fits in a single line so it's going to stay as is. However, we've all run into this situation:
+
+```js
+foo(reallyLongArg(), omgSoManyParameters(), IShouldRefactorThis(), isThereSeriouslyAnotherOne());
+```
+
+Suddenly our previous format for calling function breaks down because this is too long. Prettier is going to do the painstaking work of reprinting it like that for you:
+
+```js
+foo(
+ reallyLongArg(),
+ omgSoManyParameters(),
+ IShouldRefactorThis(),
+ isThereSeriouslyAnotherOne()
+);
+```
+
+Prettier enforces a consistent code **style** (i.e. code formatting that won't affect the AST) across your entire codebase because it disregards the original styling[\*](#footnotes) by parsing it away and re-printing the parsed AST with its own rules that take the maximum line length into account, wrapping code when necessary.
+
+If you want to learn more, these two conference talks are great introductions:
+
+[](https://www.youtube.com/watch?v=hkfBvpEfWdA)
+
+[](https://www.youtube.com/watch?v=0Q4kUNx85_4")
+
+#### Footnotes
+
+\* _Well actually, some original styling is preserved when practical—see
+ [empty lines] and [multi-line objects]._
+
+
+[empty lines]:rationale.md#empty-lines
+[multi-line objects]:rationale.md#multi-line-objects
diff --git a/docs/install.md b/docs/install.md
new file mode 100644
index 000000000000..9bc0d779d953
--- /dev/null
+++ b/docs/install.md
@@ -0,0 +1,27 @@
+---
+id: install
+title: Install
+---
+
+Install with `yarn`:
+
+```
+yarn add prettier --dev --exact
+```
+
+You can install it globally if you like:
+
+```
+yarn global add prettier
+```
+
+*We're using `yarn` but you can use `npm` if you like:*
+
+```
+npm install --save-dev --save-exact prettier
+# or globally
+npm install --global prettier
+```
+
+> We recommend pinning an exact version of prettier in your `package.json`
+> as we introduce stylistic changes in patch releases.
diff --git a/docs/language-support.md b/docs/language-support.md
new file mode 100644
index 000000000000..ee479b6c2430
--- /dev/null
+++ b/docs/language-support.md
@@ -0,0 +1,18 @@
+---
+id: language-support
+title: Language Support
+---
+
+Prettier attempts to support all JavaScript language features,
+including non-standardized ones. By default it uses the
+[Babylon](https://github.com/babel/babylon) parser with all language
+features enabled, but you can also use the
+[Flow](https://github.com/facebook/flow) parser with the
+`parser` API or `--parser` CLI [option](options.md).
+
+All of JSX and Flow syntax is supported. In fact, the test suite in
+`tests/flow` *is* the entire Flow test suite and they all pass.
+
+Prettier also supports [TypeScript](https://www.typescriptlang.org/), CSS, [Less](http://lesscss.org/), [SCSS](http://sass-lang.com), [JSON](http://json.org/), [GraphQL](http://graphql.org/), and [Markdown](http://commonmark.org).
+
+The minimum version of TypeScript supported is 2.1.3 as it introduces the ability to have leading `|` for type definitions which prettier outputs.
diff --git a/docs/options.md b/docs/options.md
index dbae2f911014..d47f119cef29 100644
--- a/docs/options.md
+++ b/docs/options.md
@@ -6,11 +6,13 @@ title: Options
Prettier ships with a handful of customizable format options, usable in both the CLI and API.
## Print Width
-Specify the length of line that the printer will wrap on.
+Specify the line length that the printer will wrap on.
-**We strongly recommend against using more than 80 columns.**
-
-Prettier works by cramming as much content as possible until it reaches the limit, which happens to work well for 80 columns but makes lines that are very crowded. When a bigger column count is used in styleguides, it usually means that code is allowed to go beyond 80 columns, but not to make every single line go there, like Prettier would do.
+> **For readability we recommend against using more than 80 characters:**
+>
+>In code styleguides, maximum line length rules are often set to 100 or 120. However, when humans write code, they don't strive to reach the maximum number of columns on every line. Developers often use whitespace to break up long lines for readability. In practice, the average line length often ends up well below the maximum.
+>
+> Prettier, on the other hand, strives to fit the most code into every line. With the print width set to 120, prettier may produce overly compact, or otherwise undesirable code.
Default | CLI Override | API Override
--------|--------------|-------------
@@ -46,7 +48,6 @@ Default | CLI Override | API Override
Use single quotes instead of double quotes.
Notes:
-
* Quotes in JSX will always be double and ignore this setting.
* If the number of quotes outweighs the other quote, the quote which is less used will be used to format the string - Example: `"I'm double quoted"` results in `"I'm double quoted"` and `"This \"example\" is single quoted"` results in `'This "example" is single quoted'`.
@@ -55,17 +56,17 @@ Default | CLI Override | API Override
`false` | `--single-quote` | `singleQuote: `
## Trailing Commas
-Print trailing commas wherever possible.
+Print trailing commas wherever possible when multi-line. (A single-line array,
+for example, never gets trailing commas.)
Valid options:
-
* `"none"` - No trailing commas.
* `"es5"` - Trailing commas where valid in ES5 (objects, arrays, etc.)
- * `"all"` - Trailing commas wherever possible (function arguments). This requires node 8 or a [transform](https://babeljs.io/docs/plugins/syntax-trailing-function-commas/).
+ * `"all"` - Trailing commas wherever possible (including function arguments). This requires node 8 or a [transform](https://babeljs.io/docs/plugins/syntax-trailing-function-commas/).
Default | CLI Override | API Override
--------|--------------|-------------
-`"none"` | `--trailing-comma ` | `trailingComma: ""`
+`"none"` | --trailing-comma | trailingComma: ""
## Bracket Spacing
Print spaces between brackets in object literals.
@@ -79,7 +80,7 @@ Default | CLI Override | API Override
`true` | `--no-bracket-spacing` | `bracketSpacing: `
## JSX Brackets
-Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line.
+Put the `>` of a multi-line JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).
Default | CLI Override | API Override
--------|--------------|-------------
@@ -89,7 +90,6 @@ Default | CLI Override | API Override
Format only a segment of a file.
These two options can be used to format code starting and ending at a given character offset (inclusive and exclusive, respectively). The range will extend:
-
* Backwards to the start of the first line containing the selected statement.
* Forwards to the end of the selected statement.
@@ -106,21 +106,21 @@ Specify which parser to use.
Both the `babylon` and `flow` parsers support the same set of JavaScript features (including Flow). Prettier automatically infers the parser from the input file path, so you shouldn't have to change this setting.
Built-in parsers:
-
* [`babylon`](https://github.com/babel/babylon/)
* [`flow`](https://github.com/facebook/flow/tree/master/src/parser)
* [`typescript`](https://github.com/eslint/typescript-eslint-parser) _Since v1.4.0_
* [`postcss`](https://github.com/postcss/postcss) _Since v1.4.0_
- * [`json`](https://github.com/vtrushin/json-to-ast) _Since v1.5.0_
+ * [`json`](https://github.com/babel/babylon/tree/f09eb3200f57ea94d51c2a5b1facf2149fb406bf#babylonparseexpressioncode-options) _Since v1.5.0_
* [`graphql`](https://github.com/graphql/graphql-js/tree/master/src/language) _Since v1.5.0_
+ * [`markdown`](https://github.com/wooorm/remark/tree/master/packages/remark-parse) _Since v1.8.0_
-[Custom parsers](#custom-parser-api) are also supported. _Since v1.5.0_
+[Custom parsers](api.md#custom-parser-api) are also supported. _Since v1.5.0_
Default | CLI Override | API Override
--------|--------------|-------------
-`babylon` | `--parser ` or `--parser ./my-parser` | `parser: ""` or `parser: require("./my-parser")`
+`babylon` | `--parser ` `--parser ./my-parser` | `parser: ""` `parser: require("./my-parser")`
-## Filepath
+## FilePath
Specify the input filepath. This will be used to do parser inference.
For example, the following will use `postcss` parser:
@@ -156,13 +156,12 @@ or
Default | CLI Override | API Override
--------|--------------|-------------
`false` | `--require-pragma` | `requirePragma: `
-
diff --git a/docs/precommit.md b/docs/precommit.md
new file mode 100644
index 000000000000..84fb6186cab0
--- /dev/null
+++ b/docs/precommit.md
@@ -0,0 +1,67 @@
+---
+id: precommit
+title: Pre-commit Hook
+---
+
+You can use Prettier with a pre-commit tool. This can re-format your files that are marked as "staged" via `git add` before you commit.
+
+## Option 1. [lint-staged](https://github.com/okonet/lint-staged)
+
+Install it along with [husky](https://github.com/typicode/husky):
+
+```bash
+yarn add lint-staged husky --dev
+```
+
+and add this config to your `package.json`:
+
+```json
+{
+ "scripts": {
+ "precommit": "lint-staged"
+ },
+ "lint-staged": {
+ "*.{js,json,css}": [
+ "prettier --write",
+ "git add"
+ ]
+ }
+}
+```
+There is a limitation where if you stage specific lines this approach will stage the whole file after regardless. See this [issue](https://github.com/okonet/lint-staged/issues/62) for more info.
+
+See https://github.com/okonet/lint-staged#configuration for more details about how you can configure lint-staged.
+
+
+## Option 2. [pre-commit](https://github.com/pre-commit/pre-commit)
+
+Copy the following config into your `.pre-commit-config.yaml` file:
+
+```yaml
+
+ - repo: https://github.com/prettier/prettier
+ sha: '' # Use the sha or tag you want to point at
+ hooks:
+ - id: prettier
+
+```
+
+Find more info from [here](http://pre-commit.com).
+
+## Option 3. bash script
+
+Alternately you can save this script as `.git/hooks/pre-commit` and give it execute permission:
+
+```bash
+#!/bin/sh
+jsfiles=$(git diff --cached --name-only --diff-filter=ACM "*.js" "*.jsx" | tr '\n' ' ')
+[ -z "$jsfiles" ] && exit 0
+
+# Prettify all staged .js files
+echo "$jsfiles" | xargs ./node_modules/.bin/prettier --write
+
+# Add back the modified/prettified files to staging
+echo "$jsfiles" | xargs git add
+
+exit 0
+```
diff --git a/Rationale.md b/docs/rationale.md
similarity index 96%
rename from Rationale.md
rename to docs/rationale.md
index a960ade6c617..0bac38fabcfb 100644
--- a/Rationale.md
+++ b/docs/rationale.md
@@ -1,6 +1,9 @@
-# Rationale
+---
+id: rationale
+title: Rationale
+---
-Prettier is an opinionated JavaScript formatter. This document gives a rationale behind those opinions.
+Prettier is an opinionated code formatter. This document gives a rationale behind those opinions.
## What prettier is concerned about
@@ -18,12 +21,6 @@ The first requirement of prettier is to output valid JavaScript and code that ha
This is the core of prettier. The formatting rules are going to be explained in a later section.
-
-### Semi-colons
-
-...TBD...
-
-
### Strings
Prettier enforces double quotes by default, but has a setting for enforcing single quotes instead. There are two exceptions:
@@ -63,6 +60,11 @@ Here are a few examples of things that are out of scope for prettier:
- Turning `?:` into `if then else`.
+
diff --git a/docs/related-projects.md b/docs/related-projects.md
new file mode 100644
index 000000000000..0ed2c686e5d6
--- /dev/null
+++ b/docs/related-projects.md
@@ -0,0 +1,42 @@
+---
+id: related-projects
+title: Related Projects
+---
+
+## ESLint Integrations
+
+- [`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier) plugs Prettier into your ESLint workflow
+- [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) turns off all ESLint rules that are unnecessary or might conflict with Prettier
+- [`prettier-eslint`](https://github.com/prettier/prettier-eslint)
+passes `prettier` output to `eslint --fix`
+- [`prettier-standard`](https://github.com/sheerun/prettier-standard)
+uses `prettier` and `prettier-eslint` to format code with standard rules
+- [`prettier-standard-formatter`](https://github.com/dtinth/prettier-standard-formatter)
+passes `prettier` output to `standard --fix`
+
+## TSLint Integrations
+
+- [`tslint-plugin-prettier`](https://github.com/ikatyang/tslint-plugin-prettier) runs Prettier as a TSLint rule and reports differences as individual TSLint issues
+- [`tslint-config-prettier`](https://github.com/alexjoverm/tslint-config-prettier) use TSLint with Prettier without any conflict
+- [`prettier-tslint`](https://github.com/azz/prettier-tslint)
+passes `prettier` output to `tslint --fix`
+
+## stylelint Integrations
+
+- [`prettier-stylelint`](https://github.com/hugomrdias/prettier-stylelint)
+passes `prettier` output to `stylelint --fix`
+- [`stylelint-config-prettier`](https://github.com/shannonmoeller/stylelint-config-prettier) turns off all rules that are unnecessary or might conflict with Prettier.
+
+## Forks
+
+- [`prettier-miscellaneous`](https://github.com/arijs/prettier-miscellaneous)
+`prettier` with a few minor extra options
+
+## Misc
+
+- [`neutrino-preset-prettier`](https://github.com/SpencerCDixon/neutrino-preset-prettier) allows you to use Prettier as a Neutrino preset
+- [`prettier_d`](https://github.com/josephfrazier/prettier_d.js) runs Prettier as a server to avoid Node.js startup delay. It also supports configuration via `.prettierrc`, `package.json`, and `.editorconfig`.
+- [`Prettier Bookmarklet`](https://prettier.glitch.me/) provides a bookmarklet and exposes a REST API for Prettier that allows to format CodeMirror editor in your browser
+- [`prettier-github`](https://github.com/jgierer12/prettier-github) formats code in GitHub comments
+- [`rollup-plugin-prettier`](https://github.com/mjeanroy/rollup-plugin-prettier) allows you to use Prettier with Rollup
+- [`markdown-magic-prettier`](https://github.com/camacho/markdown-magic-prettier) allows you to use Prettier to format JS [codeblocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/) in Markdown files via [Markdown Magic](https://github.com/DavidWells/markdown-magic)
diff --git a/docs/technical-details.md b/docs/technical-details.md
new file mode 100644
index 000000000000..3185c925244e
--- /dev/null
+++ b/docs/technical-details.md
@@ -0,0 +1,27 @@
+---
+id: technical-details
+title: Technical Details
+---
+
+This printer is a fork of
+[recast](https://github.com/benjamn/recast)'s printer with its
+algorithm replaced by the one described by Wadler in "[A prettier
+printer](http://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf)".
+There still may be leftover code from recast that needs to be cleaned
+up.
+
+The basic idea is that the printer takes an AST and returns an
+intermediate representation of the output, and the printer uses that
+to generate a string. The advantage is that the printer can "measure"
+the IR and see if the output is going to fit on a line, and break if
+not.
+
+This means that most of the logic of printing an AST involves
+generating an abstract representation of the output involving certain
+commands. For example, `concat(["(", line, arg, line ")"])` would
+represent a concatenation of opening parens, an argument, and closing
+parens. But if that doesn't fit on one line, the printer can break
+where `line` is specified.
+
+More (rough) details can be found in
+[commands.md](https://github.com/prettier/prettier/commands.md).
diff --git a/docs/usage.md b/docs/usage.md
deleted file mode 100644
index 4305287751c7..000000000000
--- a/docs/usage.md
+++ /dev/null
@@ -1,248 +0,0 @@
----
-id: usage
-title: Usage
----
-
-
-## Install
-
-```
-yarn add prettier --dev
-```
-
-You can install it globally if you like:
-
-```
-yarn global add prettier
-```
-
-*We're using `yarn` but you can use `npm` if you like:*
-
-```
-npm install [--save-dev|--global] prettier
-```
-
-## CLI
-
-Run Prettier through the CLI with this script. Run it without any
-arguments to see the [options](#options).
-
-To format a file in-place, use `--write`. You may want to consider
-committing your code before doing that, just in case.
-
-```bash
-prettier [opts] [filename ...]
-```
-
-In practice, this may look something like:
-
-```bash
-prettier --single-quote --trailing-comma es5 --write "{app,__{tests,mocks}__}/**/*.js"
-```
-
-Don't forget the quotes around the globs! The quotes make sure that Prettier
-expands the globs rather than your shell, for cross-platform usage.
-The [glob syntax from the glob module](https://github.com/isaacs/node-glob/blob/master/README.md#glob-primer)
-is used.
-
-Prettier CLI will ignore files located in `node_modules` directory. To opt-out from this behavior use `--with-node-modules` flag.
-
-If you're worried that Prettier will change the correctness of your code, add `--debug-check` to the command.
-This will cause Prettier to print an error message if it detects that code correctness might have changed.
-Note that `--write` cannot be used with `--debug-check`.
-
-Another useful flag is `--list-different` (or `-l`) which prints the filenames of files that are different from Prettier formatting. If there are differences the script errors out, which is useful in a CI scenario.
-
-```bash
-prettier --single-quote --list-different "src/**/*.js"
-```
-
-## ESLint
-
-If you are using ESLint, integrating Prettier to your workflow is straightforward:
-
-Just add Prettier as an ESLint rule using [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier).
-
-```js
-yarn add --dev prettier eslint-plugin-prettier
-
-// .eslintrc.json
-{
- "plugins": [
- "prettier"
- ],
- "rules": {
- "prettier/prettier": "error"
- }
-}
-```
-
-We also recommend that you use [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) to disable all the existing formatting rules. It's a one liner that can be added on-top of any existing ESLint configuration.
-
-```
-$ yarn add --dev eslint-config-prettier
-```
-
-.eslintrc.json:
-
-```json
-{
- "extends": [
- "prettier"
- ]
-}
-```
-
-
-## Pre-commit Hook
-
-You can use Prettier with a pre-commit tool. This can re-format your files that are marked as "staged" via `git add` before you commit.
-
-#### Option 1. [lint-staged](https://github.com/okonet/lint-staged)
-
-Install it along with [husky](https://github.com/typicode/husky):
-
-```bash
-yarn add lint-staged husky --dev
-```
-
-and add this config to your `package.json`:
-
-```json
-{
- "scripts": {
- "precommit": "lint-staged"
- },
- "lint-staged": {
- "*.js": [
- "prettier --write",
- "git add"
- ]
- }
-}
-```
-
-See https://github.com/okonet/lint-staged#configuration for more details about how you can configure lint-staged.
-
-
-#### Option 2. [pre-commit](https://github.com/pre-commit/pre-commit)
-
-Copy the following config into your `.pre-commit-config.yaml` file:
-
-```yaml
-
- - repo: https://github.com/prettier/prettier
- sha: '' # Use the sha or tag you want to point at
- hooks:
- - id: prettier
- ```
-
-Find more info from [here](https://github.com/awebdeveloper/pre-commit-prettier).
-
-#### Option 3. bash script
-
-Alternately you can save this script as `.git/hooks/pre-commit` and give it execute permission:
-
-```bash
-#!/bin/sh
-jsfiles=$(git diff --cached --name-only --diff-filter=ACM | grep '\.jsx\?$' | tr '\n' ' ')
-[ -z "$jsfiles" ] && exit 0
-
-# Prettify all staged .js files
-echo "$jsfiles" | xargs ./node_modules/.bin/prettier --write
-
-# Add back the modified/prettified files to staging
-echo "$jsfiles" | xargs git add
-
-exit 0
-```
-
-## API
-
-The API has three functions: `format`, `check`, and `formatWithCursor`.
-
-```js
-const prettier = require("prettier");
-```
-
-### `prettier.format(source [, options])`
-
-`format` is used to format text using Prettier. [Options](#options) may be provided to override the defaults.
-
-```js
-prettier.format("foo ( );", { semi: false });
-// -> "foo()"
-```
-
-### `prettier.check(source [, options])`
-
-`check` checks to see if the file has been formatted with Prettier given those options and returns a `Boolean`.
-This is similar to the `--list-different` parameter in the CLI and is useful for running Prettier in CI scenarios.
-
-### `prettier.formatWithCursor(source [, options])`
-
-`formatWithCursor` both formats the code, and translates a cursor position from unformatted code to formatted code.
-This is useful for editor integrations, to prevent the cursor from moving when code is formatted.
-
-The `cursorOffset` option should be provided, to specify where the cursor is. This option cannot be used with `rangeStart` and `rangeEnd`.
-
-```js
-prettier.formatWithCursor(" 1", { cursorOffset: 2 });
-// -> { formatted: '1;\n', cursorOffset: 1 }
-```
-
-### Custom Parser API
-
-If you need to make modifications to the AST (such as codemods), or you want to provide an alternate parser, you can do so by setting the `parser` option to a function. The function signature of the parser function is:
-```js
-(text: string, parsers: object, options: object) => AST;
-```
-
-Prettier's built-in parsers are exposed as properties on the `parsers` argument.
-
-```js
-prettier.format("lodash ( )", {
- parser(text, { babylon }) {
- const ast = babylon(text);
- ast.program.body[0].expression.callee.name = "_";
- return ast;
- }
-});
-// -> "_();\n"
-```
-
-The `--parser` CLI option may be a path to a node.js module exporting a parse function.
-
-## Excluding code from formatting
-
-A JavaScript comment of `// prettier-ignore` will exclude the next node in the abstract syntax tree from formatting.
-
-For example:
-
-```js
-matrix(
- 1, 0, 0,
- 0, 1, 0,
- 0, 0, 1
-)
-
-// prettier-ignore
-matrix(
- 1, 0, 0,
- 0, 1, 0,
- 0, 0, 1
-)
-```
-
-will be transformed to:
-
-```js
-matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);
-
-// prettier-ignore
-matrix(
- 1, 0, 0,
- 0, 1, 0,
- 0, 0, 1
-)
-```
diff --git a/editors/vim/README.md b/docs/vim.md
similarity index 76%
rename from editors/vim/README.md
rename to docs/vim.md
index 56b2b73cc2d2..035db3f8c7e3 100644
--- a/editors/vim/README.md
+++ b/docs/vim.md
@@ -1,53 +1,31 @@
-# Vim Prettier
-
-
-Table of Contents
-
-- [Vim and Prettier integration](#vim-and-prettier-integration)
- * [Neoformat](#neoformat)
- + [Neoformat - Installation](#neoformat---installation)
- + [Neoformat - Usage](#neoformat---usage)
- + [Neoformat - Other autocmd events](#neoformat---other-autocmd-events)
- + [Neoformat - Customizing Prettier](#neoformat---customizing-prettier)
- * [vim-prettier](#vim-prettier-1)
- + [vim-prettier - Installation](#vim-prettier---installation)
- + [vim-prettier - Usage](#vim-prettier---usage)
- + [vim-prettier - Configuration](#vim-prettier---configuration)
- * [ALE](#ale)
- + [ALE - Installation](#ale---installation)
- + [ALE - Usage](#ale---usage)
- + [ALE - Configuration](#ale---configuration)
- * [Running manually](#running-manually)
- + [Running Prettier manually in Vim](#running-prettier-manually-in-vim)
-
-
---------------------------------------------------------------------------------
-
-## Vim and Prettier integration
+---
+id: vim
+title: Vim Setup
+---
Vim users can simply install either [sbdchd](https://github.com/sbdchd)/[neoformat](https://github.com/sbdchd/neoformat), [w0rp](https://github.com/w0rp)/[ale](https://github.com/w0rp/ale), or [prettier](https://github.com/prettier)/[vim-prettier](https://github.com/prettier/vim-prettier).
--------------------------------------------------------------------------------
-### Neoformat
+## Neoformat
-#### Neoformat - Installation
+### Neoformat - Installation
Add [sbdchd](https://github.com/sbdchd)/[neoformat](https://github.com/sbdchd/neoformat) to your list based on the tool you use:
-```vim
+```
Plug 'sbdchd/neoformat'
```
-#### Neoformat - Usage
+### Neoformat - Usage
Then make Neoformat run on save:
-```vim
+```
autocmd BufWritePre *.js Neoformat
```
-#### Neoformat - Other `autocmd` events
+### Neoformat - Other `autocmd` events
You can also make Vim format your code more frequently, by setting an `autocmd` for other events. Here are a couple of useful ones:
@@ -56,17 +34,17 @@ You can also make Vim format your code more frequently, by setting an `autocmd`
For example, you can format on both of the above events together with `BufWritePre` like this:
-```vim
+```
autocmd BufWritePre,TextChanged,InsertLeave *.js Neoformat
```
See `:help autocmd-events` in Vim for details.
-#### Neoformat - Customizing Prettier
+### Neoformat - Customizing Prettier
If your project requires settings other than the default Prettier settings, you can pass arguments to do so in your `.vimrc` or [vim project](http://vim.wikia.com/wiki/Project_specific_settings), you can do so:
-```vim
+```
autocmd FileType javascript setlocal formatprg=prettier\ --stdin\ --parser\ flow\ --single-quote\ --trailing-comma\ es5
" Use formatprg when available
let g:neoformat_try_formatprg = 1
@@ -76,21 +54,21 @@ Each space in prettier options should be escaped with `\`.
--------------------------------------------------------------------------------
-### vim-prettier
+## vim-prettier
-
-#### vim-prettier - Installation
+
+### vim-prettier - Installation
Install with [vim-plug](https://github.com/junegunn/vim-plug), assumes node and yarn|npm installed globally.
By default it will auto format **javascript**, **typescript**, **less**, **scss** and **css** files that have "@format" annotation in the header of the file.
-```vim
+```
" post install (yarn install | npm install) then load plugin only for editing supported files
-Plug 'prettier/vim-prettier', {
- \ 'do': 'npm install',
- \ 'for': ['javascript', 'typescript', 'css', 'less', 'scss'] }
+Plug 'prettier/vim-prettier', {
+ \ 'do': 'npm install',
+ \ 'for': ['javascript', 'typescript', 'css', 'less', 'scss'] }
```
If using other vim plugin managers or doing manual setup make sure to have `prettier` installed globally or go to your vim-prettier directory and either do `npm install` or `yarn install`
@@ -103,41 +81,41 @@ vim-prettier executable resolution:
2. Look for a global prettier installation
3. Use locally installed vim-prettier prettier executable
-#### vim-prettier - Usage
+### vim-prettier - Usage
Prettier by default will run on auto save but can also be manualy triggered by:
-```vim
+```
p
```
-or
-```vim
+or
+```
:Prettier
```
If your are on vim 8+ you can also trigger async formatting by:
-```vim
+```
:PrettierAsync
```
-#### vim-prettier - Configuration
+### vim-prettier - Configuration
-Disable auto formatting of files that have "@format" tag
+Disable auto formatting of files that have "@format" tag
-```vim
+```
let g:prettier#autoformat = 0
```
The command `:Prettier` by default is synchronous but can also be forced async
-```vim
+```
let g:prettier#exec_cmd_async = 1
```
By default parsing errors will open the quickfix but can also be disabled
-```vim
+```
let g:prettier#quickfix_enabled = 0
```
@@ -146,21 +124,21 @@ First disable the default autoformat, then update to your own custom behaviour
Running before saving sync:
-```vim
+```
let g:prettier#autoformat = 0
autocmd BufWritePre *.js,*.css,*.scss,*.less Prettier
```
Running before saving async (vim 8+):
-```vim
+```
let g:prettier#autoformat = 0
autocmd BufWritePre *.js,*.css,*.scss,*.less PrettierAsync
```
-Running before saving, changing text or leaving insert mode:
+Running before saving, changing text or leaving insert mode:
-```vim
+```
" when running at every change you may want to disable quickfix
let g:prettier#quickfix_enabled = 0
@@ -168,9 +146,9 @@ let g:prettier#autoformat = 0
autocmd BufWritePre,TextChanged,InsertLeave *.js,*.css,*.scss,*.less PrettierAsync
```
-**Vim-prettier default formatting settings are different from the prettier defaults, but they can be configured**
+**Vim-prettier default formatting settings are different from the prettier defaults, but they can be configured**
-```vim
+```
" max line lengh that prettier will wrap on
g:prettier#config#print_width = 80
@@ -184,13 +162,13 @@ g:prettier#config#use_tabs = 'false'
g:prettier#config#semi = 'true'
" single quotes over double quotes
-g:prettier#config#single_quote = 'true'
+g:prettier#config#single_quote = 'true'
" print spaces between brackets
-g:prettier#config#bracket_spacing = 'false'
+g:prettier#config#bracket_spacing = 'false'
" put > on the last line instead of new line
-g:prettier#config#jsx_bracket_same_line = 'true'
+g:prettier#config#jsx_bracket_same_line = 'true'
" none|es5|all
g:prettier#config#trailing_comma = 'all'
@@ -201,9 +179,9 @@ g:prettier#config#parser = 'flow'
```
--------------------------------------------------------------------------------
-### ALE
+## ALE
-#### ALE - Installation
+### ALE - Installation
[ALE](https://github.com/w0rp/ale) is an asynchronous lint engine for Vim that
also has the ability to run formatters over code, including Prettier. For ALE
@@ -213,17 +191,17 @@ asynchronous abilities that both Vim 8 and Neovim provide.
The best way to install ALE is with your favourite plugin manager for Vim, such
as [Vim-Plug](https://github.com/junegunn/vim-plug):
-```vim
+```
Plug 'w0rp/ale'
```
You can find further instructions on the [ALE repository](https://github.com/w0rp/ale#3-installation).
-#### ALE - Usage
+### ALE - Usage
Once you've installed ALE you need to enable the Prettier fixer:
-```vim
+```
let g:ale_fixers = {}
let g:ale_fixers['javascript'] = ['prettier']
```
@@ -233,39 +211,39 @@ ALE will first use the Prettier installed locally (in
You can then run `:ALEFix` in a JavaScript file to run Prettier.
-#### ALE - Configuration
+### ALE - Configuration
To have ALE run `prettier` when you save a file you can tell ALE to run
automatically:
-```vim
+```
let g:ale_fix_on_save = 1
```
To configure Prettier, you can set `g:ale_javascript_prettier_options`. This is
a string that will be passed through to the Prettier command line tool:
-```vim
+```
let g:ale_javascript_prettier_options = '--single-quote --trailing-comma es5'
```
If you use Prettier config files, you must set
`g:ale_javascript_prettier_use_local_config` to have ALE respect them:
-```vim
+```
let g:ale_javascript_prettier_use_local_config = 1
```
--------------------------------------------------------------------------------
-### Running manually
+## Running manually
-#### Running Prettier manually in Vim
+### Running Prettier manually in Vim
If you need a little more control over when prettier is run, you can create a
custom key binding. In this example, `gp` (mnemonic: "get pretty") is used to
run prettier (with options) in the currently active buffer:
-```vim
+```
nnoremap gp :silent %!prettier --stdin --trailing-comma all --single-quote
```
diff --git a/docs/watching-files.md b/docs/watching-files.md
new file mode 100644
index 000000000000..4ce7661ff286
--- /dev/null
+++ b/docs/watching-files.md
@@ -0,0 +1,18 @@
+---
+id: watching-files
+title: Watching For Changes
+---
+
+If you prefer to have prettier watch for changes from the command line you can use a package like [onchange](https://www.npmjs.com/package/onchange). For example:
+
+```
+npx onchange '**/*.js' -- npx prettier --write {{changed}}
+```
+
+or add the following to your `package.json`
+
+```json
+ "scripts": {
+ "prettier-watch": "onchange '**/*.js' -- prettier --write {{changed}}"
+ },
+```
diff --git a/editors/webstorm/README.md b/docs/webstorm.md
similarity index 93%
rename from editors/webstorm/README.md
rename to docs/webstorm.md
index b32288b28ba7..5f7d69193936 100644
--- a/editors/webstorm/README.md
+++ b/docs/webstorm.md
@@ -1,3 +1,8 @@
+---
+id: webstorm
+title: Webstorm Setup
+---
+
## Configure External Tool
https://blog.jetbrains.com/webstorm/2016/08/using-external-tools/
@@ -11,7 +16,7 @@ Go to *File | Settings | Tools | External Tools* for Windows and Linux or *WebSt
* **Parameters** set `--write [other opts] $FilePathRelativeToProjectRoot$`
* **Working directory** set `$ProjectFileDir$`
-
+
### Process directories
@@ -42,4 +47,4 @@ Go to *File | Settings | Tools | File Watchers* for Windows and Linux or *WebSto
* **Working directory** set `$ProjectFileDir$`
* **Immediate file synchronization**: Uncheck to reformat on Save only (otherwise code will jump around while you type).
-
+
diff --git a/docs/why-prettier.md b/docs/why-prettier.md
index 64cd688311d0..437a31f6b86a 100644
--- a/docs/why-prettier.md
+++ b/docs/why-prettier.md
@@ -5,10 +5,10 @@ title: Why Prettier?
## Building and enforcing a style guide
-By far the biggest reason for adopting prettier is to stop all the ongoing debates over styles. It is generally accepted that having a common style guide is valuable for a project & team but getting there is a very painful and unrewarding process. People get very emotional around particular ways of writing code and nobody likes spending time writing and receiving nits.
+By far the biggest reason for adopting Prettier is to stop all the on-going debates over styles. It is generally accepted that having a common style guide is valuable for a project and team but getting there is a very painful and unrewarding process. People get very emotional around particular ways of writing code and nobody likes spending time writing and receiving nits.
- “We want to free mental threads and end discussions around style. While sometimes fruitful, these discussions are for the most part wasteful.”
-- “Literally had an engineer go through a huge effort of cleaning up all of our code because we were debating ternary style for the longest time and were inconsistent about it. It was dumb, but it was a weird on-going "great debate" that wasted lots of little back and forth bits. It's far easier for us all to agree now: just run prettier, and go with that style.”
+- “Literally had an engineer go through a huge effort of cleaning up all of our code because we were debating ternary style for the longest time and were inconsistent about it. It was dumb, but it was a weird on-going "great debate" that wasted lots of little back and forth bits. It's far easier for us all to agree now: just run Prettier, and go with that style.”
- “Getting tired telling people how to style their product code.”
- “Our top reason was to stop wasting our time debating style nits.”
- “Having a githook set up has reduced the amount of style issues in PRs that result in broken builds due to ESLint rules or things I have to nit-pick or clean up later.”
@@ -26,7 +26,7 @@ Prettier is usually introduced by people with experience in the current codebase
## Writing code
-What usually happens once people are using prettier is that they realize that they actually spend a lot of time and mental energy formatting their code. With prettier editor integration, you can just press that magic key binding and poof, the code is formatted. This is an eye opening experience if anything else.
+What usually happens once people are using Prettier is that they realize that they actually spend a lot of time and mental energy formatting their code. With Prettier editor integration, you can just press that magic key binding and poof, the code is formatted. This is an eye opening experience if anything else.
- “I want to write code. Not spend cycles on formatting.”
- “It removed 5% that sucks in our daily life - aka formatting”
@@ -34,26 +34,27 @@ What usually happens once people are using prettier is that they realize that th
## Easy to adopt
-We've worked very hard to use the least controversial coding styles, went through many rounds of fixing all the edge cases and polished the getting started experience. When you're ready to push prettier into your codebase, not only should it be painless for you to do it technically but the newly formatted codebase should not generate major controversy and be accepted painlessly by your co-workers.
+We've worked very hard to use the least controversial coding styles, went through many rounds of fixing all the edge cases and polished the getting started experience. When you're ready to push Prettier into your codebase, not only should it be painless for you to do it technically but the newly formatted codebase should not generate major controversy and be accepted painlessly by your co-workers.
- “It's low overhead. We were able to throw Prettier at very different kinds of repos without much work.”
- “It's been mostly bug free. Had there been major styling issues during the course of implementation we would have been wary about throwing this at our JS codebase. I'm happy to say that's not the case.”
- “Everyone runs it as part of their pre commit scripts, a couple of us use the editor on save extensions as well.”
- “It's fast, against one of our larger JS codebases we were able to run Prettier in under 13 seconds.”
-- “The biggest benefit for prettier for us was being able to format the entire code base at once.”
+- “The biggest benefit for Prettier for us was being able to format the entire code base at once.”
## Clean up an existing codebase
-Since coming up with a coding style and enforcing it is a big undertaking, it often slips through the cracks and you are left working on inconsistent codebases. Running prettier in this case is a quick win, the codebase is now uniform and easier to read without spending hardly any time.
+Since coming up with a coding style and enforcing it is a big undertaking, it often slips through the cracks and you are left working on inconsistent codebases. Running Prettier in this case is a quick win, the codebase is now uniform and easier to read without spending hardly any time.
- “Take a look at the code :) I just need to restore sanity.”
-- “We inherited a ~2000 module ES6 code base, developed by 20 different developers over 18 months, in a global team. Felt like such a win without much research.
+- “We inherited a ~2000 module ES6 code base, developed by 20 different developers over 18 months, in a global team. Felt like such a win without much research.”
## Ride the hype train
-Purely technical aspects of the projects aren't the only thing people look into when choosing to adopt prettier. Who built and uses it and how quickly it spreads through the community have a non trivial impact.
+Purely technical aspects of the projects aren't the only thing people look into when choosing to adopt Prettier. Who built and uses it and how quickly it spreads through the community has a non-trivial impact.
- “The amazing thing, for me, is: 1) Announced 2 months ago. 2) Already adopted by, it seems, every major JS project. 3) 7000 stars, 100,000 npm downloads/mo”
- “Was built by the same people as React & React Native.”
- “I like to be part of the hot new things.”
- “Because soon enough people are gonna ask for it.”
+
diff --git a/editors/atom.md b/editors/atom.md
deleted file mode 100644
index 3a9e78cf37c4..000000000000
--- a/editors/atom.md
+++ /dev/null
@@ -1 +0,0 @@
-See https://github.com/prettier/prettier-atom
diff --git a/editors/emacs/README.md b/editors/emacs/README.md
deleted file mode 100644
index 067cbfa8221e..000000000000
--- a/editors/emacs/README.md
+++ /dev/null
@@ -1,3 +0,0 @@
-This package has been moved to https://github.com/prettier/prettier-emacs.
-
-Please, update your configuration to use the new location.
diff --git a/package.json b/package.json
index 3b84813d3a5e..5877bb856568 100644
--- a/package.json
+++ b/package.json
@@ -62,7 +62,6 @@
"eslint-plugin-prettier": "2.1.2",
"eslint-plugin-react": "7.1.0",
"jest": "21.1.0",
- "markdown-toc": "1.1.0",
"mkdirp": "0.5.1",
"prettier": "1.7.3",
"rimraf": "2.6.2",
@@ -87,6 +86,6 @@
"test-integration": "jest tests_integration",
"lint": "cross-env EFF_NO_LINK_RULES=true eslint . --format node_modules/eslint-friendly-formatter",
"build": "node ./scripts/build/build.js",
- "toc": "node ./scripts/table-of-contents.js"
+ "check-deps": "node ./scripts/check-deps.js"
}
}
diff --git a/scripts/check-deps.js b/scripts/check-deps.js
new file mode 100644
index 000000000000..08f46a918f97
--- /dev/null
+++ b/scripts/check-deps.js
@@ -0,0 +1,19 @@
+"use strict";
+
+const pkg = require("../package.json");
+const chalk = require("chalk");
+
+validateDependencyObject(pkg.dependencies);
+validateDependencyObject(pkg.devDependencies);
+
+function validateDependencyObject(object) {
+ Object.keys(object).forEach(key => {
+ if (object[key][0] === "^" || object[key][0] === "~") {
+ console.error(
+ chalk.red("error"),
+ `Dependency "${chalk.bold.red(key)}" should be pinned.`
+ );
+ process.exitCode = 1;
+ }
+ });
+}
diff --git a/scripts/table-of-contents.js b/scripts/table-of-contents.js
deleted file mode 100644
index 74f33f433b31..000000000000
--- a/scripts/table-of-contents.js
+++ /dev/null
@@ -1,13 +0,0 @@
-#!/usr/bin/env node
-
-"use strict";
-
-const fs = require("fs");
-const toc = require("markdown-toc");
-const path = require("path");
-
-const readmeFilename = path.resolve(__dirname, "../README.md");
-const oldReadme = fs.readFileSync(readmeFilename, "utf8");
-const newReadme = toc.insert(oldReadme, { maxdepth: 3, bullets: ["*", "+"] });
-
-fs.writeFileSync(readmeFilename, newReadme);
diff --git a/tests_integration/__tests__/ignore-relative-path.js b/tests_integration/__tests__/ignore-relative-path.js
index f17bd317a08a..e72ae74ab179 100644
--- a/tests_integration/__tests__/ignore-relative-path.js
+++ b/tests_integration/__tests__/ignore-relative-path.js
@@ -2,6 +2,8 @@
const runPrettier = require("../runPrettier");
+expect.addSnapshotSerializer(require("../path-serializer"));
+
describe("support relative paths", () => {
runPrettier("cli/ignore-relative-path", [
"./shouldNotBeIgnored.js",
diff --git a/tests_integration/__tests__/multiple-patterns.js b/tests_integration/__tests__/multiple-patterns.js
index 772715cfdea8..d39bfe14934f 100644
--- a/tests_integration/__tests__/multiple-patterns.js
+++ b/tests_integration/__tests__/multiple-patterns.js
@@ -2,6 +2,8 @@
const runPrettier = require("../runPrettier");
+expect.addSnapshotSerializer(require("../path-serializer"));
+
describe("multiple patterns", () => {
runPrettier("cli/multiple-patterns", [
"directory/**/*.js",
diff --git a/tests_integration/__tests__/with-node-modules.js b/tests_integration/__tests__/with-node-modules.js
index d1d7014b9f96..6233566eb5a0 100644
--- a/tests_integration/__tests__/with-node-modules.js
+++ b/tests_integration/__tests__/with-node-modules.js
@@ -2,6 +2,8 @@
const runPrettier = require("../runPrettier");
+expect.addSnapshotSerializer(require("../path-serializer"));
+
describe("ignores node_modules by default", () => {
runPrettier("cli/with-node-modules", ["**/*.js", "-l"]).test({
status: 1
diff --git a/website/core/Footer.js b/website/core/Footer.js
index 8454a2543990..7bd0e9c085b5 100644
--- a/website/core/Footer.js
+++ b/website/core/Footer.js
@@ -38,10 +38,8 @@ class Footer extends React.Component {
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
+ 
+
+
-
-
-## Why Prettier?
-
-### Building and enforcing a style guide
-
-By far the biggest reason for adopting Prettier is to stop all the on-going debates over styles. It is generally accepted that having a common style guide is valuable for a project and team but getting there is a very painful and unrewarding process. People get very emotional around particular ways of writing code and nobody likes spending time writing and receiving nits.
-- “We want to free mental threads and end discussions around style. While sometimes fruitful, these discussions are for the most part wasteful.”
-- “Literally had an engineer go through a huge effort of cleaning up all of our code because we were debating ternary style for the longest time and were inconsistent about it. It was dumb, but it was a weird on-going "great debate" that wasted lots of little back and forth bits. It's far easier for us all to agree now: just run Prettier, and go with that style.”
-- “Getting tired telling people how to style their product code.”
-- “Our top reason was to stop wasting our time debating style nits.”
-- “Having a githook set up has reduced the amount of style issues in PRs that result in broken builds due to ESLint rules or things I have to nit-pick or clean up later.”
-- “I don't want anybody to nitpick any other person ever again.”
-- “It reminds me of how Steve Jobs used to wear the same clothes every day because he has a million decisions to make and he didn't want to be bothered to make trivial ones like picking out clothes. I think Prettier is like that.”
-
-### Helping Newcomers
-
-Prettier is usually introduced by people with experience in the current codebase and JavaScript but the people that disproportionally benefit from it are newcomers to the codebase. One may think that it's only useful for people with very limited programming experience, but we've seen it quicken the ramp up time from experienced engineers joining the company, as they likely used a different coding style before, and developers coming from a different programming language.
-- “My motivations for using Prettier are: appearing that I know how to write JavaScript well.”
-- “I always put spaces in the wrong place, now I don't have to worry about it anymore.”
-- “When you're a beginner you're making a lot of mistakes caused by the syntax. Thanks to Prettier, you can reduce these mistakes and save a lot of time to focus on what really matters.”
-- “As a teacher, I will also tell to my students to install Prettier to help them to learn the JS syntax and have readable files.”
-
-### Writing code
-
-What usually happens once people are using Prettier is that they realize that they actually spend a lot of time and mental energy formatting their code. With Prettier editor integration, you can just press that magic key binding and poof, the code is formatted. This is an eye opening experience if anything else.
-- “I want to write code. Not spend cycles on formatting.”
-- “It removed 5% that sucks in our daily life - aka formatting”
-- “We're in 2017 and it's still painful to break a call into multiple lines when you happen to add an argument that makes it go over the 80 columns limit :(“
-
-### Easy to adopt
-
-We've worked very hard to use the least controversial coding styles, went through many rounds of fixing all the edge cases and polished the getting started experience. When you're ready to push Prettier into your codebase, not only should it be painless for you to do it technically but the newly formatted codebase should not generate major controversy and be accepted painlessly by your co-workers.
-- “It's low overhead. We were able to throw Prettier at very different kinds of repos without much work.”
-- “It's been mostly bug free. Had there been major styling issues during the course of implementation we would have been wary about throwing this at our JS codebase. I'm happy to say that's not the case.”
-- “Everyone runs it as part of their pre commit scripts, a couple of us use the editor on save extensions as well.”
-- “It's fast, against one of our larger JS codebases we were able to run Prettier in under 13 seconds.”
-- “The biggest benefit for Prettier for us was being able to format the entire code base at once.”
-
-### Clean up an existing codebase
-
-Since coming up with a coding style and enforcing it is a big undertaking, it often slips through the cracks and you are left working on inconsistent codebases. Running Prettier in this case is a quick win, the codebase is now uniform and easier to read without spending hardly any time.
-- “Take a look at the code :) I just need to restore sanity.”
-- “We inherited a ~2000 module ES6 code base, developed by 20 different developers over 18 months, in a global team. Felt like such a win without much research.”
-
-### Ride the hype train
-
-Purely technical aspects of the projects aren't the only thing people look into when choosing to adopt Prettier. Who built and uses it and how quickly it spreads through the community has a non-trivial impact.
-- “The amazing thing, for me, is: 1) Announced 2 months ago. 2) Already adopted by, it seems, every major JS project. 3) 7000 stars, 100,000 npm downloads/mo”
-- “Was built by the same people as React & React Native.”
-- “I like to be part of the hot new things.”
-- “Because soon enough people are gonna ask for it.”
-
-A few of the [many projects](https://www.npmjs.com/browse/depended/prettier) using Prettier:
-
-
