@rmtc/plugin-eslint v1.0.0
@rmtc/plugin-eslint
An ESLint plugin for @rmtc/toolchain.
!WARNING This project is intended for use in @rowanmanning's projects. It's free to use but I don't offer support for use-cases outside of what I need.
Table of Contents
Requirements
This library requires the following to run:
Usage
Install the module with npm:
npm install --save-dev @rmtc/plugin-eslint
Include it in your .rmtc.json
file:
{
plugins: [
// ...
'@rmtc/plugin-eslint'
]
// ...
}
Workflows
This plugin defines the following workflows:
verify
: a general workflow used to verify code quality.
Steps
This plugin defines the following steps that can be added to any workflow:
eslint
: run theeslint
command-line tool on the whole project.
E.g. if you prefer to define a lint
workflow, use the following:
{
plugins: ['@rmtc/plugin-eslint'],
workflows: {
lint: ['eslint']
}
}
Configuration
This plugin provides no additional configuration. To configure the way that the eslint
command-line tool runs, you should use one of the configuration methods that they suggest.
Contributing
See the central README for a contribution guide and code of conduct.
License
Licensed under the MIT license. Copyright © 2023, Rowan Manning