Files
test-repo/README.md
T

92 lines
2.8 KiB
Markdown
Raw Normal View History

2017-11-07 14:39:07 +11:00
![Prettier Banner](https://raw.githubusercontent.com/prettier/prettier-logo/master/images/prettier-banner-dark.png)
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>
JavaScript
· Flow
· TypeScript
· CSS
· SCSS
· Less
· GraphQL
· JSON
· Markdown
</em>
</p>
2017-11-07 14:39:07 +11:00
<p align="center">
<a href="https://gitter.im/jlongster/prettier">
<img alt="Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square">
</a>
<a href="https://travis-ci.org/prettier/prettier">
<img alt="Travis" src="https://img.shields.io/travis/prettier/prettier.svg?style=flat-square">
</a>
<a href="https://codecov.io/gh/prettier/prettier">
<img alt="Codecov" src="https://img.shields.io/codecov/c/github/prettier/prettier.svg?style=flat-square">
</a>
<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="npm version" src="https://img.shields.io/npm/dm/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>
</p>
2017-11-07 14:39:07 +11:00
## Intro
2017-06-23 13:52:46 +03:00
2017-11-07 14:39:07 +11: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
```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-11-07 14:39:07 +11:00
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!
2017-06-21 10:44:53 -07:00
2017-11-07 14:39:07 +11: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-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-07 14:39:07 +11:00
- - -
## Badge
2017-11-07 14:39:07 +11: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).