Lint source code with ESLint
org.openrewrite.codemods.ESLint
_Run ESLint across the code to fix common static analysis issues in the code.
This requires the code to have an existing ESLint configuration._
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite.recipe
artifactId: rewrite-codemods
version: 0.2.0
Options
Type | Name | Description | Example |
---|---|---|---|
| patterns | Optional. The lint target files. This can contain any of file paths, directory paths, and glob patterns. |
|
| parser | Optional. Parser used by ESLint to parse the source files. Defaults to |
|
| parserOptions | Optional. A list of parser options for ESLint. The format is |
|
| allowInlineConfig | Optional. Whether inline config comments are allowed. Defaults to |
|
| envs | Optional. A list of |
|
| globals | Optional. Define global variables for rules that require knowledge of these. |
|
| plugins | Optional. A list of plugins for ESLint. |
|
| extend | Optional. A list of extends for ESLint. |
|
| rules | Optional. List of rules to be checked by ESLint. Optionally, the severity and other rule options can also be specified as e.g. |
|
| fix | Optional. Automatically fix violations when possible. Defaults to |
|
| configFile | Optional. Allows specifying the full ESLint configuration file contents as multiline JSON. See ESLint documentation for more details. Note that this will override any other configuration options. |
Usage
This recipe has no required configuration options. It can be activated by adding a dependency on org.openrewrite.recipe:rewrite-codemods:0.2.0
in your build file or by running a shell command (in which case no build changes are needed):
Add the following to your
build.gradle
file:
Run
gradle rewriteRun
to run the recipe.
See how this recipe works across multiple open-source repositories
The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Data Tables
ESLint messages
org.openrewrite.codemods.ESLintMessages
Errors and warnings as reported by ESLint.
Column Name | Description |
---|---|
Source Path | The source path of the file. |
Rule ID | ESLint Rule ID. |
Severity | Either |
Fatal | Is this a fatal error (like a parse error). |
Message | The message created by the rule. |
Line | Line in source file this message pertains to. |
Column | Column in source file this message pertains to. |
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | Description |
---|---|
Source path before the run | The source path of the file before the run. |
Source path after the run | A recipe may modify the source path. This is the path after the run. |
Parent of the recipe that made changes | In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all. |
Recipe that made changes | The specific recipe that made a change. |
Estimated time saving | An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds. |
Cycle | The recipe cycle in which the change was made. |
Source files that errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | Description |
---|---|
Source path | The file that failed to parse. |
Recipe that made changes | The specific recipe that made a change. |
Stack trace | The stack trace of the failure. |
Recipe performance
org.openrewrite.table.RecipeRunStats
Statistics used in analyzing the performance of recipes.
Column Name | Description |
---|---|
The recipe | The recipe whose stats are being measured both individually and cumulatively. |
Source file count | The number of source files the recipe ran over. |
Source file changed count | The number of source files which were changed in the recipe run. Includes files created, deleted, and edited. |
Cumulative scanning time | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |
Last updated