/
manifest.js
68 lines (63 loc) · 2.86 KB
/
manifest.js
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
/**
* @fileoverview Metadata about built-in formatters
* @author Ben Perlmutter
*/
"use strict";
/**
* @typedef Formatter
* @type {Object}
* @property {string} name Name of formatter.
* @property {string} description Description of formatter in Markdown.
*/
/**
* @type {Array<Formatter>} Array of Formatter metadata objects
*/
const formatterMetadata = [
{
name: "checkstyle",
description: "Outputs results to the [Checkstyle](https://checkstyle.sourceforge.io/) format."
},
{
name: "compact",
description: "Human-readable output format. Mimics the default output of JSHint."
},
{
name: "html",
description: "Outputs results to HTML. The `html` formatter is useful for visual presentation in the browser."
},
{
name: "jslint-xml",
description: "Outputs results to format compatible with the [JSLint Jenkins plugin](https://plugins.jenkins.io/jslint/)."
},
{
name: "json-with-metadata",
description: `Outputs JSON-serialized results. The \`json-with-meta\` provides the same linting results as the [\`json\`](#json) formatter with additional metadata about the rules applied. The linting results are included in the \`"results"\` property and the rules metadata is included in the \`"metadata"\` property.
Alternatively, you can use the [ESLint Node.js API](../../developer-guide/nodejs-api.md) to programmatically use ESLint.`
},
{
name: "json",
description: `Outputs JSON-serialized results. The \`json\` formatter is useful when you want to programmatically work with the CLI's linting results.
Alternatively, you can use the [ESLint Node.js API](../../developer-guide/nodejs-api.md) to programmatically use ESLint.`
},
{
name: "junit",
description: "Outputs results to format compatible with the [JUnit Jenkins plugin](https://plugins.jenkins.io/junit/)."
},
{
name: "stylish",
description: "Human-readable output format. This is the default formatter."
},
{
name: "tap",
description: "Outputs results to the [Test Anything Protocol (TAP)](https://testanything.org/) specification format."
},
{
name: "unix",
description: "Outputs results to a format similar to many commands in UNIX-like systems. Parsable with tools such as [grep](https://www.gnu.org/software/grep/manual/grep.html), [sed](https://www.gnu.org/software/sed/manual/sed.html), and [awk](https://www.gnu.org/software/gawk/manual/gawk.html)."
},
{
name: "visualstudio",
description: "Outputs results to format compatible with the integrated terminal of the [Visual Studio](https://visualstudio.microsoft.com/) IDE. When using Visual Studio, you can click on the linting results in the integrated terminal to go to the issue in the source code."
}
];
module.exports = formatterMetadata;