| 1 | # snazzy [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
|
| 2 |
|
| 3 | [travis-image]: https://img.shields.io/travis/feross/snazzy/master.svg
|
| 4 | [travis-url]: https://travis-ci.org/feross/snazzy
|
| 5 | [npm-image]: https://img.shields.io/npm/v/snazzy.svg
|
| 6 | [npm-url]: https://npmjs.org/package/snazzy
|
| 7 | [downloads-image]: https://img.shields.io/npm/dm/snazzy.svg
|
| 8 | [downloads-url]: https://npmjs.org/package/snazzy
|
| 9 | [standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
|
| 10 | [standard-url]: https://standardjs.com
|
| 11 |
|
| 12 | ### Format [JavaScript Standard Style](https://github.com/feross/standard) as Stylish (i.e. snazzy) output
|
| 13 |
|
| 14 | Converts "compact" text from a linter to "stylish" (i.e. snazzy) output.
|
| 15 |
|
| 16 | 
|
| 17 |
|
| 18 | Compared to before:
|
| 19 |
|
| 20 | 
|
| 21 |
|
| 22 | ## install
|
| 23 |
|
| 24 | ```
|
| 25 | npm install -g snazzy
|
| 26 | ```
|
| 27 |
|
| 28 | ## usage
|
| 29 |
|
| 30 | Pipe "compact" text into the `snazzy` command to get back pretty results:
|
| 31 |
|
| 32 | ```bash
|
| 33 | $ standard --verbose | snazzy
|
| 34 | ```
|
| 35 |
|
| 36 | ## note about version 7.0.0
|
| 37 |
|
| 38 | `standard` is no longer bundled with snazzy. You must install `standard` manually
|
| 39 | alongside `snazzy`.
|
| 40 |
|
| 41 | Run `npm install standard --save-dev` to get a copy of `standard`, then run
|
| 42 | `standard | snazzy` where you previously used to run `snazzy`.
|
| 43 |
|
| 44 | This way requires more steps, but it's better. The user now controls the exact
|
| 45 | version of `standard` that is used. And for users who were piping into `snazzy` all
|
| 46 | along, this means a quicker install since an extra copy of `standard` will not get
|
| 47 | installed.
|
| 48 |
|
| 49 | ## license
|
| 50 |
|
| 51 | MIT. Copyright (c) [Feross Aboukhadijeh](https://feross.org).
|