scobal/gradle-eslint-plugin

A Gradle plugin for ESLint

Gradle ESLint Plugin

This is a Gradle plugin for running ESLint as part of your Gradle build.

Usage

1. Install ESLint via npm: npm install eslint

2. Add the following to your build.gradle

    buildscript {
        repositories {
            maven {
                url "https://plugins.gradle.org/m2/"
            }
        }
        dependencies {
            classpath "gradle.plugin.com.github.scobal.eslint:gradle-eslint-plugin:1.0.5"
        }
    }
   
    apply plugin: "com.github.scobal.eslint"
   

3. Configure ESLint to include your Javascript files in your build.gradle

    eslint {
        inputs = ["**/*.js*"]
    }
   

4. Run gradle eslint

Configuration

The goal of this plugin is to support as fully as possible the command line interface described here:

http://eslint.org/docs/user-guide/command-line-interface

This is a list of the available options for use inside the eslint configuration block:

Option	Description
executable	The path to an eslint executable (default is "eslint"), eg: "/usr/bin/eslint"
yarnPath	The path to yarn package manager, which will indicate to plugin to run eslint via yarn rather than directly. This can be either directory containing yarn or full path including yarn executable. Plugin has logic built to add '.cmd' suffix for the Windows Operating System, eg: "build/yarn/bin", "/usr/bin/yarn"
ignoreExitValue	Boolean to ignore eslint's exit value (default is false), eg: true
inputs	A list of files, directories and/or globs (default is ["src"]), eg: ["service.js", "src/controllers/", "**/*.js"]
config	The path to an eslint configuration file, eg: "/home/scobal/esconfig"
noEslintrc	Boolean to disable the use of .eslintrc, eg: true
env	A list of environments as strings, eg: ["environment_1", "environment_2"]
ext	A list of Javascript file extensions as strings, eg: [".js", ".jsx"]
global	A list of global variables as strings, eg: ["global_1", "global_1"]
parser	The parser to be used, eg: "espree"
parserOptions	Specify parser options
cache	Boolean to only check changed files, eg: true
cacheFile	The path to an eslint cache file, eg: "/tmp/eslint_cache/file"
cacheLocation	The path to an eslint cache file or directory, eg: "/tmp/eslint_cache"
rulesDir	A list of directories with additional rules, eg: ["/eslint/rules_1", "/eslint/rules_2"]
plugin	A list of plugins as strings, eg: ["plugin_1", "plugin_2"]
rule	Specify rules
outputFile	The path to the output file, eg: "/home/scobal/report.out"
format	The format of the output file, eg: "checkstyle"

License

gradle-eslint-plugin is licensed under version 2.0 of the Apache License. See the LICENSE file for details.

Development

gradle-eslint-plugin's Issues

Cannot enable cache

The following eslint configuration

eslint {
  executable = "./node_modules/eslint/bin/eslint.js"
  config = "./.eslintrc.json"
  inputs = ["src/**/*.ts"]
  cache = true
}

results in the following error message:

> Task :eslint FAILED
Caching disabled for task ':eslint' because:
  Build cache is disabled
Task ':eslint' is not up-to-date because:
  Task has not declared any outputs despite executing actions.
Starting process 'command './node_modules/eslint/bin/eslint.js''. Working directory: /home/hakjac/wsgit/hippo Command: ./node_modules/eslint/bin/eslint.js --config ./.eslintrc.json --cache true src/**/*.ts
Successfully started process 'command './node_modules/eslint/bin/eslint.js''

Oops! Something went wrong! :(

ESLint: 6.2.2.

No files matching the pattern "true" were found.
Please check for typing mistakes in the pattern.

I believe that the cache = true option should not result in --cache true but instead just a --cache

A problem occurred starting process 'command 'eslint''

I can not run the plugin . Errors occur frequently when you start gradle eslint
A problem occurred starting process 'command 'eslint''
Here are the contents of build.gradle
plugins {
id "com.github.scobal.eslint" version "1.0.1"
}
eslint {
config = ".eslintrc.json"
inputs = ["js/.js"]
}

A problem occurred starting process 'command 'eslint''

I can not run the plugin . Errors occur frequently when you start gradle eslint
A problem occurred starting process 'command 'eslint''
Here are the contents of build.gradle:
plugins {
id "com.github.scobal.eslint" version "1.0.4"
}
eslint {
inputs = ["**/.js"]
}

How can I configure the "--quiet" CLI option in the plugin

I want to use --quiet for eslint. Is it possible to set this using the eslint configuration block?

Feature Request: environment variable for project.exec

Would it be possible to supply the environment property to the project.exec task?
This is needed to that can specify the environment variables like PATH to specify the installation of node?
Otherwise it just looks for the global installed node option.

Plugin does not enable setting all eslint options

The only options that are available to configure are listed here: https://github.com/scobal/gradle-eslint-plugin#configuration. Eslint command line interface allows setting more options which are helpful (i.e. the output file). It would be nice if all eslint parameters could be configurable in the plugin (by introducing handling more options or at least enable passing any option in the form of key=value string).