2017-12-18 00:24:19 +11:00

2016-12-23 13:38:10 -05:00
2017-11-07 14:39:07 +11:00
<h2 align="center">Opinionated Code Formatter</h2>
2017-01-11 17:01:02 +00:00
2017-11-07 14:39:07 +11:00
<p align="center">
<em>
2018-11-07 09:09:04 +08:00
JavaScript
· TypeScript
· Flow
· JSX
· JSON
</em>
<br />
<em>
CSS
· SCSS
· Less
</em>
<br />
<em>
HTML
· Vue
· Angular
</em>
<br />
<em>
GraphQL
· Markdown
· YAML
</em>
<br />
<em>
<a href="https://prettier.io/docs/en/plugins.html">
2018-01-17 16:54:36 -05:00
Your favorite language?
</a>
2017-11-07 14:39:07 +11:00
</em>
</p>
2017-06-04 13:03:30 +10:00
2017-11-07 14:39:07 +11:00
<p align="center">
2018-11-15 19:35:51 -05:00
<a href="https://dev.azure.com/prettier/prettier/_build/latest?definitionId=5">
2018-12-18 08:16:32 +08:00
<img alt="Azure Pipelines Build Status" src="https://img.shields.io/azure-devops/build/prettier/79013671-677c-4846-a6d8-3050d40e21c0/5.svg?style=flat-square&label=build&branchName=master"></a>
2017-11-07 14:39:07 +11:00
<a href="https://codecov.io/gh/prettier/prettier">
2018-10-05 14:06:53 -04:00
<img alt="Codecov Coverage Status" src="https://img.shields.io/codecov/c/github/prettier/prettier.svg?style=flat-square"></a>
2018-06-04 14:16:06 +10:00
<a href="https://twitter.com/acdlite/status/974390255393505280">
2018-10-05 14:06:53 -04:00
<img alt="Blazing Fast" src="https://img.shields.io/badge/speed-blazing%20%F0%9F%94%A5-brightgreen.svg?style=flat-square"></a>
2018-06-04 14:16:06 +10:00
<br/>
2017-11-07 14:39:07 +11:00
<a href="https://www.npmjs.com/package/prettier">
2018-10-05 14:06:53 -04:00
<img alt="npm version" src="https://img.shields.io/npm/v/prettier.svg?style=flat-square"></a>
2017-11-07 14:39:07 +11:00
<a href="https://www.npmjs.com/package/prettier">
2018-10-05 14:06:53 -04:00
<img alt="weekly downloads from npm" src="https://img.shields.io/npm/dw/prettier.svg?style=flat-square"></a>
2017-11-07 14:39:07 +11:00
<a href="#badge ">
2018-10-05 14:06:53 -04:00
<img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a>
2018-06-04 14:16:06 +10:00
<a href="https://gitter.im/jlongster/prettier">
2018-10-05 14:06:53 -04:00
<img alt="Chat on Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square"></a>
2017-11-29 17:50:02 +01:00
<a href="https://twitter.com/PrettierCode">
2018-10-05 14:06:53 -04:00
<img alt="Follow Prettier on Twitter" src="https://img.shields.io/twitter/follow/prettiercode.svg?label=follow+prettier&style=flat-square"></a>
2017-11-07 14:39:07 +11:00
</p>
2016-12-23 13:38:10 -05:00
2017-11-07 14:39:07 +11:00
## Intro
2017-06-23 13:52:46 +03:00
2017-11-22 19:27:40 +08:00
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.
2017-08-29 13:39:49 -07:00
2017-11-07 14:39:07 +11:00
### Input
2017-06-21 10:44:53 -07:00
2017-11-22 19:27:40 +08:00
<!-- prettier-ignore -->
2017-06-21 10:44:53 -07:00
```js
foo ( reallyLongArg (), omgSoManyParameters (), IShouldRefactorThis (), isThereSeriouslyAnotherOne ());
```
2017-11-07 14:39:07 +11:00
### Output
2017-06-21 10:44:53 -07:00
```js
foo (
reallyLongArg (),
omgSoManyParameters (),
IShouldRefactorThis (),
isThereSeriouslyAnotherOne ()
);
```
2017-12-14 01:49:42 -05:00
Prettier can be run [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-picky comment on a code review ever again!
2017-06-21 10:44:53 -07:00
2017-11-22 19:27:40 +08:00
---
2017-06-21 10:44:53 -07:00
2017-11-07 14:39:07 +11:00
** [Documentation ](https://prettier.io/docs/en/ )**
2017-06-21 10:44:53 -07:00
2017-11-22 19:27:40 +08:00
<!-- prettier-ignore -->
2017-11-07 14:39:07 +11:00
[Install ](https://prettier.io/docs/en/install.html ) ·
[Options ](https://prettier.io/docs/en/options.html ) ·
[CLI ](https://prettier.io/docs/en/cli.html ) ·
2017-11-07 15:08:21 -05:00
[API ](https://prettier.io/docs/en/api.html )
2017-04-10 16:18:01 -07:00
2017-11-07 14:39:07 +11:00
** [Playground ](https://prettier.io/playground/ )**
2017-04-10 16:17:39 -07:00
2017-11-22 19:27:40 +08:00
---
2016-12-23 13:38:10 -05:00
2017-03-29 19:56:01 +05:30
## Badge
2017-11-22 19:27:40 +08:00
Show the world you're using _Prettier_ → [](https://github.com/prettier/prettier)
2017-03-29 19:56:01 +05:30
```md
2017-11-07 14:39:07 +11:00
[](https://github.com/prettier/prettier)
2017-03-29 19:56:01 +05:30
```
2017-01-10 00:45:11 -05:00
## Contributing
2016-11-29 12:26:03 -05:00
2017-05-24 17:32:20 +02:00
See [CONTRIBUTING.md ](CONTRIBUTING.md ).