UNPKG

@overlookmotel/eslint-config

Version:

@overlookmotel's ESLint config

github.com/overlookmotel/eslint-config

overlookmotel/eslint-config

51 lines (30 loc) • 2.31 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
[![NPM version](https://img.shields.io/npm/v/@overlookmotel/eslint-config.svg)](https://www.npmjs.com/package/@overlookmotel/eslint-config) [![Build Status](https://img.shields.io/github/workflow/status/overlookmotel/eslint-config/Test.svg)](https://github.com/overlookmotel/eslint-config/actions) [![Coverage Status](https://img.shields.io/coveralls/overlookmotel/eslint-config/master.svg)](https://coveralls.io/r/overlookmotel/eslint-config) # @overlookmotel's ESLint config ESLint config for Javascript apps/libraries. Based on [eslint-config-airbnb-base](https://www.npmjs.com/package/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](https://semver.org/). 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](https://nodejs.org/en/about/releases/), 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](https://github.com/overlookmotel/eslint-config/blob/master/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)