Files

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

104 lines
3.3 KiB
Markdown
Raw Permalink Normal View History

2023-07-16 10:04:53 +05:30
[![Prettier Banner](https://unpkg.com/prettier-logo@1.0.3/images/prettier-banner-light.svg)](https://prettier.io)
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/plugins">
Your favorite language?
</a>
2017-11-07 14:39:07 +11:00
</em>
</p>
2017-11-07 14:39:07 +11:00
<p align="center">
2025-05-08 19:26:30 +08:00
<a href="https://github.com/prettier/prettier/actions?query=branch%3Amain">
<img alt="CI Status" src="https://img.shields.io/github/check-runs/prettier/prettier/main?style=flat-square&label=CI"></a>
2017-11-07 14:39:07 +11:00
<a href="https://codecov.io/gh/prettier/prettier">
2025-05-08 19:26:30 +08:00
<img alt="Coverage Status" src="https://img.shields.io/codecov/c/github/prettier/prettier.svg?style=flat-square"></a>
<a href="https://x.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>
2025-05-08 19:26:30 +08:00
<a href="https://github.com/prettier/prettier#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>
2025-05-08 19:26:30 +08:00
<a href="https://x.com/intent/follow?screen_name=PrettierCode">
<img alt="Follow Prettier on X" src="https://img.shields.io/badge/%40PrettierCode-9f9f9f?style=flat-square&logo=x&labelColor=555"></a>
2017-11-07 14:39:07 +11:00
</p>
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-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(),
);
```
Prettier can be run [in your editor](https://prettier.io/docs/editors) on-save, in a [pre-commit hook](https://prettier.io/docs/precommit), or in [CI environments](https://prettier.io/docs/cli#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
**[Documentation](https://prettier.io/docs/)**
2017-06-21 10:44:53 -07:00
[Install](https://prettier.io/docs/install) ·
[Options](https://prettier.io/docs/options) ·
[CLI](https://prettier.io/docs/cli) ·
[API](https://prettier.io/docs/api)
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
---
## Badge
2017-11-22 19:27:40 +08:00
Show the world you're using _Prettier_ → [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
```md
2017-11-07 14:39:07 +11:00
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
```
2017-01-10 00:45:11 -05:00
## Contributing
2016-11-29 12:26:03 -05:00
See [CONTRIBUTING.md](CONTRIBUTING.md).