@orcinuss/eslint-config-eslint v1.0.1

Orcinuss's Eslint Config

Eslint Configuration for Orcinuss's NPM packages for code consistency and structure.

Installation

1. Add eslint and this package to your repository yarn add eslint @orcinuss/eslint-config-eslint -D.
2. Create an .eslintrc.js file at the root of your project.
3. Add this package to the extends section of your .eslintrc.js file as show in the example below.
4. Add the executable script: "lint": "eslint --config ./.eslintrc.js --fix index.js lib/**/*.js" to your package.json scripts section.

Example Eslintrc

extends: [
    '@orcinuss/eslint',
]

Included Options

This config already has the following keys present, so you don't need to repeat them:

parserOptions: {
    ecmaVersion: 2018,
    ecmaFeatures: {
        experimentalObjectRestSpread: true,
    },
},

env: {
    es6: true,
    node: true,
},

Caveats

Here are some common rules in specific locations that you may need to add:

1. Disable global requires for index.js and *.spec.js files: 'global-require': 'off'
2. Disable invalid this when using class transform properties: 'no-invalid-this': 'off' and 'babel/no-invalid-this': 'off'