Prettier

• Usage
  • CLI
    • Pre-commit hook for changed files
  • API
  • Options
  • Excluding code from formatting
• Editor Integration
  • Atom
  • Emacs
  • Vim
    • Other autocmd events
    • Customizing Prettier in Vim
    • Running Prettier manually in Vim
  • Visual Studio Code
  • Visual Studio
  • Sublime Text
  • JetBrains
• Language Support
• Related Projects
• Technical Details
• Badge
• Contributing

Prettier is an opinionated JavaScript formatter inspired by refmt with advanced support for language features from ES2017, JSX, and Flow. It removes all original styling* and ensures that all outputted JavaScript conforms to a consistent style. (See this blog post)

If you are interested in the details, you can watch those two conference talks:

This goes way beyond ESLint and other projects built on it. Unlike ESLint, there aren't a million configuration options and rules. But more importantly: everything is fixable. This works because Prettier never "checks" anything; it takes JavaScript as input and delivers the formatted JavaScript as output.

In technical terms: Prettier parses your JavaScript into an AST (Abstract Syntax Tree) and pretty-prints the AST, completely ignoring any of the original formatting*. Say hello to completely consistent syntax!

There's an extremely important piece missing from existing styling tools: the maximum line length. Sure, you can tell ESLint to warn you when you have a line that's too long, but that's an after-thought (ESLint never knows how to fix it). The maximum line length is a critical piece the formatter needs for laying out and wrapping code.

For example, take the following code:

foo(arg1, arg2, arg3, arg4);

That looks like the right way to format it. However, we've all run into this situation:

foo(reallyLongArg(), omgSoManyParameters(), IShouldRefactorThis(), isThereSeriouslyAnotherOne());

Suddenly our previous format for calling function breaks down because this is too long. What you would probably do is this instead:

foo(
  reallyLongArg(),
  omgSoManyParameters(),
  IShouldRefactorThis(),
  isThereSeriouslyAnotherOne()
);

This clearly shows that the maximum line length has a direct impact on the style of code we desire. The fact that current style tools ignore this means they can't really help with the situations that are actually the most troublesome. Individuals on teams will all format these differently according to their own rules and we lose the consistency we sought after.

Even if we disregard line widths, it's too easy to sneak in various styles of code in all other linters. The most strict linter I know happily lets all these styles happen:

foo({ num: 3 },
  1, 2)

foo(
  { num: 3 },
  1, 2)

foo(
  { num: 3 },
  1,
  2
)

Prettier bans all custom styling* by parsing it away and re-printing the parsed AST with its own rules that take the maximum line width into account, wrapping code when necessary.

*Well actually, some original styling is preserved when practical—see empty lines and multi-line objects.

Usage

Install:

yarn add prettier --dev

You can install it globally if you like:

yarn global add prettier

We're defaulting to yarn but you can use npm if you like:

npm install [-g] prettier

CLI

Run Prettier through the CLI with this script. Run it without any arguments to see the options.

To format a file in-place, use --write. You may want to consider committing your code before doing that, just in case.

prettier [opts] [filename ...]

In practice, this may look something like:

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.)

In the future we will have better support for formatting whole projects.

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.

prettier --single-quote --list-different "src/**/*.js"

Pre-commit hook for changed files

You can use this with a pre-commit tool. This can re-format your files that are marked as "staged" via git add before you commit.

1. lint-staged

Install it along with husky:

yarn add lint-staged husky --dev

and add this config to your package.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.

2. pre-commit

Just copy the following config in your pre-commit config yaml file

    -   repo: https://github.com/awebdeveloper/pre-commit-prettier
        sha: ''  # Use the sha or tag you want to point at
        hooks:
        -   id: prettier
            additional_dependencies: ['prettier@1.1.0']

Find more info from here

3. bash script

Alternately you can just save this script as .git/hooks/pre-commit and give it execute permission:

#!/bin/sh
jsfiles=$(git diff --cached --name-only --diff-filter=ACM | grep '\.jsx\?$' | tr '\n' ' ')
[ -z "$jsfiles" ] && exit 0

diffs=$(node_modules/.bin/prettier -l $jsfiles)
[ -z "$diffs" ] && exit 0

echo "here"
echo >&2 "Javascript files must be formatted with prettier. Please run:"
echo >&2 "node_modules/.bin/prettier --write "$diffs""

exit 1

API

The API has two functions, exported as format and check. format usage is as follows:

const prettier = require("prettier");

const options = {} // optional
prettier.format(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.

Options

Prettier ships with a handful of customizable format options, usable in both the CLI and API.

Option	Default	CLI override	API override
Print Width - Specify the length of line that the printer will wrap on. We strongly recommend against using more than 80 columns. Prettier works by craming 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.	80	--print-width <int>	printWidth: <int>
Tab Width - Specify the number of spaces per indentation-level.	2	--tab-width <int>	tabWidth: <int>
Tabs - Indent lines with tabs instead of spaces.	false	--use-tabs	useTabs: <bool>
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	true	--no-semi	semi: <bool>
Quotes - Use single quotes instead of double quotes.	false	--single-quote	singleQuote: <bool>
Trailing Commas - Print trailing commas wherever possible. 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.	"none"	--trailing-comma <none|es5|all>	trailingComma: "<none|es5|all>"
Bracket Spacing - Print spaces between brackets in object literals. Valid options: - true - Example: { foo: bar } - false - Example: {foo: bar}	true	--no-bracket-spacing	bracketSpacing: <bool>
JSX Brackets on Same Line - Put the > of a multi-line JSX element at the end of the last line instead of being alone on the next line	false	--jsx-bracket-same-line	jsxBracketSameLine: <bool>
Range Start - Format code starting at a given character offset. The range will extend backwards to the start of the first line containing the selected statement.	0	--range-start <int>	rangeStart: <int>
Range End - Format code ending at a given character offset (exclusive). The range will extend forwards to the end of the selected statement.	Infinity	--range-end <int>	rangeEnd: <int>
Parser - Specify which parser to use. Both parsers support the same set of JavaScript features (including Flow). You shouldn't have to change this setting.	babylon	--parser <flow|babylon>	parser: "<flow|babylon>"

Excluding code from formatting

A JavaScript comment of // prettier-ignore will exclude the next node in the abstract syntax tree from formatting.

For example:

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:

matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);

// prettier-ignore
matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

Editor Integration

Atom

Atom users can simply install the prettier-atom package and use Ctrl+Alt+F to format a file (or format on save if enabled).

Emacs

Emacs users should see this directory for on-demand formatting.

Vim

Add sbdchd/neoformat to your list based on the tool you use:

Plug 'sbdchd/neoformat'

Then make Neoformat run on save:

autocmd BufWritePre *.js 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:

• TextChanged: after a change was made to the text in Normal mode
• InsertLeave: when leaving Insert mode

For example, you can format on both of the above events together with BufWritePre like this:

autocmd BufWritePre,TextChanged,InsertLeave *.js Neoformat

See :help autocmd-events in Vim for details.

Customizing Prettier in Vim

If your project requires settings other than the default Prettier settings, you can pass arguments to do so in your .vimrc or vim project, you can do so:

autocmd FileType javascript setlocal formatprg=prettier\ --stdin\ --parser\ flow\ --single-quote\ --trailing-comma\ es5
" Use formatprg when available
let g:neoformat_try_formatprg = 1

Each option needs to be escaped with \.

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:

nnoremap gp :silent %!prettier --stdin --trailing-comma all --single-quote<CR>

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

Visual Studio

Install the JavaScript Prettier extension.

Sublime Text

Sublime Text support is available through Package Control and the JsPrettier plug-in.

JetBrains

JetBrains users can configure prettier as an External Tool. See this blog post or this directory with examples.

More editors are coming soon.

Language Support

Prettier attempts to support all JavaScript language features, including non-standardized ones. By default it uses the Babylon parser with all language features enabled, but you can also use the Flow parser with the parser API or --parser CLI option.

All of JSX and Flow syntax is supported. In fact, the test suite in tests is the entire Flow test suite and they all pass.

Related Projects

• eslint-plugin-prettier plugs Prettier into your ESLint workflow
• eslint-config-prettier turns off all ESLint rules that are unnecessary or might conflict with Prettier
• prettier-eslint passes prettier output to eslint --fix
• prettier-standard uses prettier and prettier-eslint to format code with standard rules
• prettier-standard-formatter passes prettier output to standard --fix
• prettier-miscellaneous prettier with a few minor extra options
• neutrino-preset-prettier allows you to use Prettier as a Neutrino preset
• prettier_d runs Prettier as a server to avoid Node.js startup delay

Technical Details

This printer is a fork of recast's printer with its algorithm replaced by the one described by Wadler in "A prettier printer". 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 concatentation 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. Better docs will come soon.

Badge

Show the world you're using Prettier →

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

Contributing

To get up and running, install the dependencies and run the tests:

yarn
yarn lint
yarn test

Here's what you need to know about the tests:

• The tests uses Jest snapshots.
• You can make changes and run jest -u (or yarn test -- -u) to update the snapshots. Then run git diff to take a look at what changed. Always update the snapshots when opening a PR.
• You can run AST_COMPARE=1 jest for a more robust test run. That formats each file, re-parses it, and compares the new AST with the original one and makes sure they are semantically equivalent.
• Each test folder has a jsfmt.spec.js that runs the tests. Normally you can just put run_spec(__dirname); there. You can also pass options and additional parsers, like this: run_spec(__dirname, { trailingComma: "es5" }, ["babylon"]);
• tests/flow/ contains the Flow test suite, and is not supposed to be edited by hand. To update it, clone the Flow repo next to the Prettier repo and run: node scripts/sync-flow-tests.js ../flow/tests/.
• If you would like to debug prettier locally, you can either debug it in node or the browser. The easiest way to debug it in the browser is to run the interactive docs REPL locally. The easiest way to debug it in node, is to create a local test file and run it in an editor like VS Code.

Run yarn lint -- --fix to automatically format files.

If you can, take look at commands.md and check out Wadler's paper to understand how Prettier works.