@aduth/eslint-config

Andrew Duthie's personal ESLint configuration

Usage no npm install needed!

<script type="module">
  import aduthEslintConfig from 'https://cdn.skypack.dev/@aduth/eslint-config';
</script>

README

@aduth/eslint-config

Andrew Duthie's personal ESLint configurations.

Installation

npm install --save-dev eslint @aduth/eslint-config

eslint is a peer dependency of these configurations and must be installed in your project.

The following peer dependencies are optional and will enable additional rules when present:

  • JSDoc: eslint-plugin-jsdoc
  • Prettier: eslint-plugin-prettier and eslint-config-prettier
  • TypeScript: @typescript-eslint/eslint-plugin and @typescript-eslint/parser

Usage

{
    "extends": "@aduth/eslint-config"
}

Refer to the ESLint guide on Extending Configuration Files.

The configuration includes only rules. You will need to provide environment and plugin settings as appropriate.

Variations

The default configuration is optimized for ES2015+. The following variations are available:

  • @aduth/eslint-config/base: Minimal subset of common rules
  • @aduth/eslint-config/esnext: Rules optimized for ES2015+
  • @aduth/eslint-config/es5: Rules optimized for ES5 only (assigns parserOption.ecmaVersion: 5)

License

Copyright 2018 Andrew Duthie

Released under the MIT License.