@overlookmotel's ESLint config

ESLint config for Javascript apps/libraries. Based on eslint-config-airbnb-base with some modifications.

Usage

Add to .eslintrc: "extends": "@overlookmotel/eslint-config"

Add dev dependencies in package.json:

• @overlookmotel/eslint-config
• eslint

If using NPM before v7, additionally add peer dependencies as dev dependencies in package.json:

• eslint-config-airbnb-base
• eslint-plugin-eslint-comments
• eslint-plugin-import
• eslint-plugin-jsdoc

Tests

Use npm test to run the tests. Use npm run cover to check coverage.

Versioning

This module follows semver. Breaking changes will only be made in major version updates.

All active NodeJS release lines are supported (v14+ at time of writing). After a release line of NodeJS reaches end of life according to Node's LTS schedule, support for that version of Node may be dropped at any time, and this will not be considered a breaking change. Dropping support for a Node version will be made in a minor version update (e.g. 1.2.0 to 1.3.0). If you are using a Node version which is approaching end of life, pin your dependency of this module to patch updates only using tilde (~) e.g. ~1.2.3 to avoid breakages.

Changelog

See changelog.md

Issues

If you discover a bug, please raise an issue on Github. https://github.com/overlookmotel/eslint-config/issues

Contribution

Pull requests are very welcome. Please:

• ensure all tests pass before submitting PR
• add tests for new features
• document new functionality/API additions in README
• do not add an entry to Changelog (Changelog is created when cutting releases)

Changelog

10.1.0

Features:

• Parse latest syntax

Minor:

• Drop support for Node v12
• Drop support for Node v17

Dependencies:

• Update peer dependencies

Dev:

• Update dev dependencies
• CI run tests on Node v18 + v19

Docs:

• Remove David badges from README

10.0.3

Rule changes:

• indent rule: Indent switch cases

10.0.2

Rule changes:

• Amend lines-between-class-members rule
• JSDoc prefer @extends for classes

10.0.1

Dev:

• Update dev dependencies

Docs:

• Fix changelog

10.0.0

Breaking changes:

• Update to ESLint 8

Dev:

• Run tests on CI on Node v17
• Clean up after cover NPM script even if fails

Docs:

• Update license year

9.0.7

Bug fixes:

• Enable commonjs option on import/no-unresolved rule

Dependencies:

• Update peer dependencies

9.0.6

Dependencies:

• Update peer dependencies

Dev:

• Update dev dependencies

9.0.5

Rule changes:

• Disable no-multi-assign rule

9.0.4

Dev:

• Fix package-lock.json version
• Update dev dependencies

9.0.3

Dev:

• Use NPM v7 for development
• CI run lint and coverage with Node v16

9.0.2

Bug fixes:

• Remove returnsProp JSDoc tag rule

9.0.1

No code:

• Linting fixes

9.0.0

Breaking changes:

• Add JSDoc rules [major]

8.0.0

Breaking changes:

• Disable no-nested-ternary rule
• Disable no-return-await rule
• Parser ecmaVersion 2021

Bug fixes:

• Parse .mjs files as ES Modules

Features:

• Drop support for Node v10

Dependencies:

• Update peer dependencies

Dev:

• Use Github Actions for CI
• Update dev dependencies

Docs:

• Remove Greenkeeper badge
• Update license year
• Remove license indentation

7.2.1

Tests:

• Import module by name [fix]

7.2.0

Tests:

• Import module by name [refactor]

7.1.4

Dev:

• Replace Mocha + Chai with Jest

7.1.3

Features:

• Drop support for Node v8

Dependencies:

• Update peer dependencies

Dev:

• CI run tests on Node v14
• Simplify lint scripts
• Update dev dependencies
• .editorconfig config
• Replace .npmignore with files list in package.json
• Remove sudo key from Travis CI config
• Travis CI cache NPM

7.1.2

Docs:

• Fix missing changelog entry [fix]

7.1.1

No code:

• Header code comments

7.1.0

Rule changes:

• Tab width of 2 not 4

7.0.0

Breaking changes:

• Update ESLint peer dependencies

Rule changes:

• Enforce import/extensions rule
• Relax object-shorthand rule with ignoreConstructors option

Refactor:

• File extensions on imports

Dev:

• Update dev dependencies
• ESLint ignore coverage dir
• Update .gitignore + .npmignore

Docs:

• Versioning policy
• Update license year

6.0.0

Breaking changes:

• Remove Node-specific functionality (use @overlookmotel/eslint-config-node)
• Update ESLint peer dependencies

Dev:

• Update dev dependencies

5.0.1

Dev:

• Update dev dependencies

5.0.0

Breaking changes:

• Update ESLint peer dependencies

Dev:

• Update dev dependencies

4.3.2

Rule changes:

• Disable max-classes-per-file rule

4.3.1

Rule changes:

• arrow-parens rule only brackets for block arrow functions

4.3.0

Rule changes:

• strict rule global option

4.2.0

Rule changes:

• Update AirBnB config

Dev:

• Update dev dependencies

4.1.0

Rule changes:

• Add eslint-plugin-node

4.0.1

Dev:

• Update dev dependencies

4.0.0

Breaking changes:

• Drop support for Node v6
• Update peer dependencies

Dev:

• CI run tests on Node v12
• package-lock.json
• Update dev dependencies

3.0.2

Dev:

• Git ignore package-lock.json
• Reformat package.json

3.0.1

Dev:

• ESLint config no .js in require path

3.0.0

Rule changes:

• no-console rule error not warning

2.1.2

Rule changes:

• Disable guard-for-in rule

2.1.1

Rule changes:

• Disable no-await-in-loop rule

2.1.0

Rule changes:

• Alter generator-star-spacing rule
• Disable no-continue rule
• object-shorthand rule disable ignoreConstructors option

Other:

• Lint index.js

2.0.0

Breaking changes:

• Base on airbnb config

Other:

• Update dependencies
• Lint this library with own config

1.1.1

• README update
• Rename CI npm script ci
• NPM ignore .gitattributes

1.1.0

• Add eslint-comments plugin [feat]
• Rules for max-len [feat]
• Use @overlookmotel/eslint-config-tests ESLint config for tests

1.0.0

• Initial release