@kevinoid's ESLint Config
An ESLint shareable
configs for
@kevinoid's preferred style (based on
Airbnb
style).
Installation
Before using any configuration from this package, it must be installed, either
globally or locally, which can be done using the following steps:
- Install
peerDependencies
(and transitive peerDependencies
) for
@kevinoid/eslint-config
. This can be done using npx install-peerdeps --dev @kevinoid/eslint-config
,
install-peerdeps
or
manually based on the output from npm info @kevinoid/eslint-config peerDependencies
. - Install this package (e.g.
npm install @kevinoid/eslint-config
).
Usage
This package includes configurations for several different environments:
Name | Description |
---|
@kevinoid/eslint-config/ie11 | Browsers including Internet Explorer 11. |
@kevinoid/eslint-config/nodejs | Node 6 and later. |
@kevinoid/eslint-config/webextensions | Browser Extensions |
@kevinoid/eslint-config/wsh | JScript 5.8 in Windows Script Host |
Add the chosen configuration to
extends
in .eslintrc
, for example:
{
"extends": "@kevinoid/eslint-config/nodejs"
}
or eslintConfig
in package.json
, for example:
{
"name": "packagename",
"version": "1.0.0",
...
"eslintConfig": {
"extends": "@kevinoid/eslint-config/nodejs"
}
}
License
This project is available under the terms of the MIT License.
See the summary at TLDRLegal.
The template upon which
this project is based is available under the terms of
CC0 1.0 Universal.