aboutsummaryrefslogtreecommitdiff
path: root/node_modules/prettier/README.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/prettier/README.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/prettier/README.md')
-rw-r--r--node_modules/prettier/README.md106
1 files changed, 106 insertions, 0 deletions
diff --git a/node_modules/prettier/README.md b/node_modules/prettier/README.md
new file mode 100644
index 00000000..91db3d0d
--- /dev/null
+++ b/node_modules/prettier/README.md
@@ -0,0 +1,106 @@
+![Prettier Banner](https://raw.githubusercontent.com/prettier/prettier-logo/master/images/prettier-banner-light.png)
+
+<h2 align="center">Opinionated Code Formatter</h2>
+
+<p align="center">
+ <em>
+ JavaScript
+ · Flow
+ · TypeScript
+ · CSS
+ · SCSS
+ · Less
+ · JSX
+ · Vue
+ · GraphQL
+ · JSON
+ · Markdown
+ · <a href="https://prettier.io/docs/en/plugins.html">
+ Your favorite language?
+ </a>
+ </em>
+</p>
+
+<p align="center">
+ <a href="https://travis-ci.org/prettier/prettier">
+ <img alt="Travis CI Build Status" src="https://img.shields.io/travis/prettier/prettier/master.svg?style=flat-square&label=Travis+CI">
+ </a>
+ <a href="https://circleci.com/gh/prettier/prettier">
+ <img alt="CircleCI Build Status" src="https://img.shields.io/circleci/project/github/prettier/prettier/master.svg?style=flat-square&label=CircleCI">
+ </a>
+ <a href="https://ci.appveyor.com/project/azz/prettier">
+ <img alt="AppVeyor Build Status" src="https://img.shields.io/appveyor/ci/azz/prettier.svg?style=flat-square&label=AppVeyor">
+ </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="monthly downloads from npm" 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>
+ <a href="https://gitter.im/jlongster/prettier">
+ <img alt="Chat on Gitter" src="https://img.shields.io/gitter/room/jlongster/prettier.svg?style=flat-square">
+ </a>
+ <a href="https://twitter.com/PrettierCode">
+ <img alt="Follow Prettier on Twitter" src="https://img.shields.io/twitter/follow/prettiercode.svg?label=follow+prettier&style=flat-square">
+ </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](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!
+
+---
+
+**[Documentation](https://prettier.io/docs/en/)**
+
+<!-- prettier-ignore -->
+[Install](https://prettier.io/docs/en/install.html) ·
+[Options](https://prettier.io/docs/en/options.html) ·
+[CLI](https://prettier.io/docs/en/cli.html) ·
+[API](https://prettier.io/docs/en/api.html)
+
+**[Playground](https://prettier.io/playground/)**
+
+---
+
+## Badge
+
+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
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).