UNPKG

standard-codeclimate

Version:

Format JavaScript Standard Style as CodeClimate engine output

github.com/jden/standard-codeclimate

jden/standard-codeclimate

51 lines (33 loc) • 1.69 kB
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
# standard-codeclimate [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [travis-image]: https://img.shields.io/travis/jden/standard-codeclimate.svg?style=flat [travis-url]: https://travis-ci.org/jden/standard-codeclimate [npm-image]: https://img.shields.io/npm/v/standard-codeclimate?style=flat [npm-url]: https://npmjs.org/package/standard-codeclimate [downloads-image]: https://img.shields.io/npm/dm/standard-codeclimate.svg?style=flat [downloads-url]: https://npmjs.org/package/standard-codeclimate ### Format [JavaScript Standard Style](https://github.com/feross/standard) as json output for the CodeClimate platform See the [CodeClimate spec](https://github.com/codeclimate/spec/blob/master/SPEC.md) detailing required output format ## install ``` npm install -g standard-codeclimate ``` ## usage Pipe "compact" text into the `standard-codeclimate` command to get back pretty results: ```bash $ standard --verbose | standard-codeclimate ``` Or, just run `standard-codeclimate` directly and it will run `standard` and give you pretty results: ```bash $ standard-codeclimate ``` ### null byte-delimited flag CodeClimate [requires each issue to be delimited by a null byte (`\0`)](https://github.com/codeclimate/spec/blob/master/SPEC.md#output). Use the `--null-delimited` flag if you're using this in a CodeClimate engine, e.g. ```sh $ standard-codeclimate --null-delimited ``` Additionally, `standard-codeclimate` supports all command line flags that `standard` supports: ```bash $ standard-codeclimate --format --verbose test1.js test2.js ``` ## license ISC. Copyright (c) [jden](https://jden.us).