Skip to main content

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

This recipe is available under the Moderne Source Available License.

Options​

TypeNameDescriptionExample
ListpatternsOptional. The lint target files. This can contain any of file paths, directory paths, and glob patterns.lib/**/*.js
StringparserOptional. Parser used by ESLint to parse the source files. Defaults to @typescript-eslint/parser. See ESLint documentation for more details.esprima
ListparserOptionsOptional. A list of parser options for ESLint. The format is key: value. Defaults to ecmaVersion: "latest", ecmaFeatures: { jsx: true }, sourceType: "module". See ESLint documentation for more details.ecmaVersion: 6, ecmaFeatures: { jsx: true }
BooleanallowInlineConfigOptional. Whether inline config comments are allowed. Defaults to false. See ESLint documentation for more details.true
ListenvsOptional. A list of env mappings for ESLint. The format is key: value.browser: true
ListglobalsOptional. Define global variables for rules that require knowledge of these.var1, var2: writable
ListpluginsOptional. A list of plugins for ESLint.@typescript-eslint, prettier
ListextendOptional. A list of extends for ESLint.eslint:recommended, prettier
ListrulesOptional. List of rules to be checked by ESLint. Optionally, the severity and other rule options can also be specified as e.g. off, warn or ["error", "always"]. The severity off is useful when the rule is declared by an extended shareable config. For more information, see the ESLint documentationeqeqeq: warn, multiline-comment-style: ["error", "starred-block"], prettier/prettier
BooleanfixOptional. Automatically fix violations when possible. Defaults to true.false
StringconfigFileOptional. 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 in your build file or by running a shell command (in which case no build changes are needed):

  1. Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("7.6.2")
}

rewrite {
    activeRecipe("org.openrewrite.codemods.ESLint")
    setExportDatatables(true)
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-codemods:0.13.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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 NameDescription
Source PathThe source path of the file.
Rule IDESLint Rule ID.
SeverityEither Warning or Error.
FatalIs this a fatal error (like a parse error).
MessageThe message created by the rule.
LineLine in source file this message pertains to.
ColumnColumn in source file this message pertains to.