@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)