Blame view

node_modules/prettier/README.md 3.93 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
  ![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
      · 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">
        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/prettier/prettier">
      <img alt="AppVeyor Build Status" src="https://img.shields.io/appveyor/ci/prettier/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="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://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).