892a62f4e5
To be followed by tests and `npm run build`, obviously! Reviewed-on: #1 Co-authored-by: Jack Jackson <scubbojj@gmail.com> Co-committed-by: Jack Jackson <scubbojj@gmail.com>
109 lines
3.8 KiB
Markdown
109 lines
3.8 KiB
Markdown
[](https://prettier.io)
|
|
|
|
<h2 align="center">Opinionated Code Formatter</h2>
|
|
|
|
<p align="center">
|
|
<em>
|
|
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>
|
|
</em>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/prettier/prettier/actions?query=workflow%3AProd+branch%3Amain">
|
|
<img alt="Github Actions Build Status" src="https://img.shields.io/github/actions/workflow/status/prettier/prettier/prod-test.yml?label=Prod&style=flat-square"></a>
|
|
<a href="https://github.com/prettier/prettier/actions?query=workflow%3ADev+branch%3Amain">
|
|
<img alt="Github Actions Build Status" src="https://img.shields.io/github/actions/workflow/status/prettier/prettier/dev-test.yml?label=Dev&style=flat-square"></a>
|
|
<a href="https://github.com/prettier/prettier/actions?query=workflow%3ALint+branch%3Amain">
|
|
<img alt="Github Actions Build Status" src="https://img.shields.io/github/actions/workflow/status/prettier/prettier/lint.yml?label=Lint&style=flat-square"></a>
|
|
<a href="https://codecov.io/gh/prettier/prettier">
|
|
<img alt="Codecov Coverage Status" src="https://img.shields.io/codecov/c/github/prettier/prettier.svg?style=flat-square"></a>
|
|
<a href="https://twitter.com/acdlite/status/974390255393505280">
|
|
<img alt="Blazing Fast" src="https://img.shields.io/badge/speed-blazing%20%F0%9F%94%A5-brightgreen.svg?style=flat-square"></a>
|
|
<br/>
|
|
<a href="https://www.npmjs.com/package/prettier">
|
|
<img alt="npm version" src="https://img.shields.io/npm/v/prettier.svg?style=flat-square"></a>
|
|
<a href="https://www.npmjs.com/package/prettier">
|
|
<img alt="weekly downloads from npm" src="https://img.shields.io/npm/dw/prettier.svg?style=flat-square"></a>
|
|
<a href="#badge">
|
|
<img alt="code style: prettier" src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square"></a>
|
|
<a href="https://twitter.com/PrettierCode">
|
|
<img alt="Follow Prettier on Twitter" src="https://img.shields.io/badge/%40PrettierCode-9f9f9f?style=flat-square&logo=x&labelColor=555"></a>
|
|
</p>
|
|
|
|
## 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
|
|
|
|
<!-- prettier-ignore -->
|
|
```js
|
|
foo(reallyLongArg(), omgSoManyParameters(), IShouldRefactorThis(), isThereSeriouslyAnotherOne());
|
|
```
|
|
|
|
### Output
|
|
|
|
```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!
|
|
|
|
---
|
|
|
|
**[Documentation](https://prettier.io/docs/)**
|
|
|
|
[Install](https://prettier.io/docs/install) ·
|
|
[Options](https://prettier.io/docs/options) ·
|
|
[CLI](https://prettier.io/docs/cli) ·
|
|
[API](https://prettier.io/docs/api)
|
|
|
|
**[Playground](https://prettier.io/playground/)**
|
|
|
|
---
|
|
|
|
## Badge
|
|
|
|
Show the world you're using _Prettier_ → [](https://github.com/prettier/prettier)
|
|
|
|
```md
|
|
[](https://github.com/prettier/prettier)
|
|
```
|
|
|
|
## Contributing
|
|
|
|
See [CONTRIBUTING.md](CONTRIBUTING.md).
|