Package detail

@dotcom-tool-kit/eslint

financial-times3.2kISC4.3.4

A plugin to run eslint in your JavaScript code. This plugin uses the ESLint Node.js API to run ESLint. It loads the ESLint configuration files (.eslintrc.* files) in your

readme

@dotcom-tool-kit/eslint

A plugin to run eslint in your JavaScript code. This plugin uses the ESLint Node.js API to run ESLint. It loads the ESLint configuration files (.eslintrc.* files) in your repo by default.

Installation

With Tool Kit already set up, install this plugin as a dev dependency:

npm install --save-dev @dotcom-tool-kit/eslint

And add it to your repo's .toolkitrc.yml:

plugins:
    - '@dotcom-tool-kit/eslint'

Tasks

`Eslint`

Runs eslint to lint and format target files.

Task options

Property	Description	Type	Default
`configPath`	Path to the ESLint config file to use.	`string`
`files`	The glob patterns for lint target files. This can either be a string or an array of strings.	`Array<string> \	string`	`["*/.js"]`

All properties are optional.