
This package contains configuration files for ESLint v6+
TypeScript configurations require TypeScript v3+
These are configurations for ESLint that I use in my JavaScript and TypeScript projects. Most of the configurations assume development in ES2015+ compatible environments, but the default configuration does not do this.
installation
$ npm install --save-dev eslint-config-futagozaryuu
usage
Put the following into your configuration (.eslintrc.json
file or the "eslintConfig" field in package.json
):
{
"extends": "futagozaryuu"
}
configurations
A list of usable configurations as well the configurations they use:
futagozaryuu
(default, includes: possible-errors, best-practices, stylistic-issues and variables)
futagozaryuu/possible-errors
futagozaryuu/best-practices
futagozaryuu/stylistic-issues
futagozaryuu/variables
futagozaryuu/es5
(includes: default)
futagozaryuu/es2015
(includes: es5)
futagozaryuu/es2016
(includes: es2015)
futagozaryuu/es2017
(includes: es2016)
futagozaryuu/es2018
(includes: es2017)
futagozaryuu/es2019
(includes: es2018)
futagozaryuu/node
futagozaryuu/node-v4
(includes: es2015 and node)
futagozaryuu/node-v6
(includes: es2015 and node)
futagozaryuu/node-v8
(includes: es2017 and node)
futagozaryuu/node-v10
(includes: es2018 and node)
futagozaryuu/node-v12
(includes: es2019 and node)
futagozaryuu/typescript
(includes: es2019)
futagozaryuu/typescript/node
(includes: node, test and typescript)
futagozaryuu/typescript/node-v4
(includes: node-v4, test and typescript)
futagozaryuu/typescript/node-v6
(includes: node-v6, test and typescript)
futagozaryuu/typescript/node-v8
(includes: node-v8, test and typescript)
futagozaryuu/typescript/node-v10
(includes: node-v10, test and typescript)
futagozaryuu/typescript/node-v12
(includes: node-v12, test and typescript)
futagozaryuu/deprecated
futagozaryuu/test
futagozaryuu/dev
(includes: es2019, node and test)
If you open the source files for these configurations, you will find each rule has a JSDoc description. Some of these descriptions have icons:
- ⚠️ means a feature that has not been widely implemented
- 📝 means a rule that can be fixed using the
--fix
flag
versioning
Since v7 of this package I will try to follow a semver based versioning:
4.17.0
= RELEASE.REVISION.PATCH
RELEASE
- a new configuration has been added
- a new dependency is required
REVISION
- confirmed compatibility with ESLint release's
- changes to existing configurations
PATCH
- a bug is fixed
- docs are updated
- dependency upgrades (without configuration updates)
- is reset when
REVISION
increments
Also to note on dependencies; before 4.17 my dependencies were always fixed (on any package), but since I've started to embrace tools like Yarn, I thought why not also use practices like tildes (e.g. ~
) and carets (e.g. ^
). See this answer on StackOverflow for a clear explanation about the two.
license
Copyright (c) 2017+ Futago-za Ryuu
Released under the MIT License, http://opensource.org/licenses/MIT