Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/eslint/eslint into eslint.c…
…onfig.ts
- Loading branch information
Showing
27 changed files
with
871 additions
and
148 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| --- | ||
| title: Stats Data | ||
| eleventyNavigation: | ||
| key: stats data | ||
| parent: extend eslint | ||
| title: Stats Data | ||
| order: 6 | ||
| --- | ||
|
|
||
| While an analysis of the overall rule performance for an ESLint run can be carried out by setting the [TIMING](./custom-rules#profile-rule-performance) environment variable, it can sometimes be useful to acquire more *granular* timing data (lint time per file per rule) or collect other measures of interest. In particular, when developing new [custom plugins](./plugins) and evaluating/benchmarking new languages or rule sets. For these use cases, you can optionally collect runtime statistics from ESLint. | ||
|
|
||
| ## Enable stats collection | ||
|
|
||
| To enable collection of statistics, you can either: | ||
|
|
||
| 1. Use the `--stats` CLI option. This will pass the stats data into the formatter used to output results from ESLint. (Note: not all formatters output stats data.) | ||
| 1. Set `stats: true` as an option on the `ESLint` constructor. | ||
|
|
||
| Enabling stats data adds a new `stats` key to each [LintResult](../integrate/nodejs-api#-lintresult-type) object containing data such as parse times, fix times, lint times per rule. | ||
|
|
||
| As such, it is not available via stdout but made easily ingestible via a formatter using the CLI or via the Node.js API to cater to your specific needs. | ||
|
|
||
| ## ◆ Stats type | ||
|
|
||
| The `Stats` value is the timing information of each lint run. The `stats` property of the [LintResult](../integrate/nodejs-api#-lintresult-type) type contains it. It has the following properties: | ||
|
|
||
| * `fixPasses` (`number`)<br> | ||
| The number of times ESLint has applied at least one fix after linting. | ||
| * `times` (`{ passes: TimePass[] }`)<br> | ||
| The times spent on (parsing, fixing, linting) a file, where the linting refers to the timing information for each rule. | ||
| * `TimePass` (`{ parse: ParseTime, rules?: Record<string, RuleTime>, fix: FixTime, total: number }`)<br> | ||
| An object containing the times spent on (parsing, fixing, linting) | ||
| * `ParseTime` (`{ total: number }`)<br> | ||
| The total time that is spent when parsing a file. | ||
| * `RuleTime` (`{ total: number }`)<be> | ||
| The total time that is spent on a rule. | ||
| * `FixTime` (`{ total: number }`)<be> | ||
| The total time that is spent on applying fixes to the code. | ||
|
|
||
| ### CLI usage | ||
|
|
||
| Let's consider the following example: | ||
|
|
||
| ```js [file-to-fix.js] | ||
| /*eslint no-regex-spaces: "error", wrap-regex: "error"*/ | ||
|
|
||
| function a() { | ||
| return / foo/.test("bar"); | ||
| } | ||
| ``` | ||
|
|
||
| Run ESLint with `--stats` and output to JSON via the built-in [`json` formatter](../use/formatters/): | ||
|
|
||
| ```bash | ||
| npx eslint file-to-fix.js --fix --stats -f json | ||
| ``` | ||
|
|
||
| This yields the following `stats` entry as part of the formatted lint results object: | ||
|
|
||
| ```json | ||
| { | ||
| "times": { | ||
| "passes": [ | ||
| { | ||
| "parse": { | ||
| "total": 3.975959 | ||
| }, | ||
| "rules": { | ||
| "no-regex-spaces": { | ||
| "total": 0.160792 | ||
| }, | ||
| "wrap-regex": { | ||
| "total": 0.422626 | ||
| } | ||
| }, | ||
| "fix": { | ||
| "total": 0.080208 | ||
| }, | ||
| "total": 12.765959 | ||
| }, | ||
| { | ||
| "parse": { | ||
| "total": 0.623542 | ||
| }, | ||
| "rules": { | ||
| "no-regex-spaces": { | ||
| "total": 0.043084 | ||
| }, | ||
| "wrap-regex": { | ||
| "total": 0.007959 | ||
| } | ||
| }, | ||
| "fix": { | ||
| "total": 0 | ||
| }, | ||
| "total": 1.148875 | ||
| } | ||
| ] | ||
| }, | ||
| "fixPasses": 1 | ||
| } | ||
| ``` | ||
|
|
||
| Note, that for the simple example above, the sum of all rule times should be directly comparable to the first column of the TIMING output. Running the same command with `TIMING=all`, you can verify this: | ||
|
|
||
| ```bash | ||
| $ TIMING=all npx eslint file-to-fix.js --fix --stats -f json | ||
| ... | ||
| Rule | Time (ms) | Relative | ||
| :---------------|----------:|--------: | ||
| wrap-regex | 0.431 | 67.9% | ||
| no-regex-spaces | 0.204 | 32.1% | ||
| ``` | ||
|
|
||
| ### API Usage | ||
|
|
||
| You can achieve the same thing using the Node.js API by passing`stats: true` as an option to the `ESLint` constructor. For example: | ||
|
|
||
| ```js | ||
| const { ESLint } = require("eslint"); | ||
|
|
||
| (async function main() { | ||
| // 1. Create an instance. | ||
| const eslint = new ESLint({ stats: true, fix: true }); | ||
|
|
||
| // 2. Lint files. | ||
| const results = await eslint.lintFiles(["file-to-fix.js"]); | ||
|
|
||
| // 3. Format the results. | ||
| const formatter = await eslint.loadFormatter("json"); | ||
| const resultText = formatter.format(results); | ||
|
|
||
| // 4. Output it. | ||
| console.log(resultText); | ||
| })().catch((error) => { | ||
| process.exitCode = 1; | ||
| console.error(error); | ||
| }); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.