eslint-config-contactlab

eslint-config-contactlab

ContactLab ESLint extensible and sharable configuration.

It also includes configuration for @typescript-eslint in order to provide support for TypeScript files linting.

Usage

Install the configuration as a npm package:

$ npm install --save-dev eslint-config-contactlab

# --- OR ---

$ yarn add --dev eslint-config-contactlab

and then add it as extension in your ESLint configuration file:

// for example in your .eslinrc.js or package.json

{
  "extends": "contactlab"
}

See the ESlint config docs for more information.

TypeScript

If you need to lint TypeScript files please use the contactlab/typescript config

// in your .eslinrc.js or package.json

{
  "extends": "contactlab/typescript"
}

and run the eslint CLI with --ext .js,.jsx,.ts,.tsx option.

You can also disable rules on file basis (in case they collide with your configuration) with the overrides key:

// in your .eslintrc.js file

module.exports = {
  // ...your configuration

  overrides: [
    // Disable typescript rules for tests and js files
    {
      files: ['*.test.ts*', '*.js'],
      rules: {
        '@typescript-eslint/explicit-function-return-type': 'off',
        '@typescript-eslint/no-explicit-any': 'off'
      }
    }
  ]
};

Rules

ES configuration already extends the default eslint:recommended rules.

TypeScript configuration the @typescript-eslint/recommended-type-checked and @typescript-eslint/stylistic-type-checked rules.

Older Nodejs versions

v14.x

Since v10.0.0 eslint-config-contactlab supports Nodejs version >= 16.x

If you need support for previous versions please use v9.0.0

v12.x

Since v6.0.0 eslint-config-contactlab supports Nodejs version >= 14.x

If you need support for previous versions please use v5.0.0

v10.x

Since v5.0.0 eslint-config-contactlab supports Nodejs version >= 12.x

If you need support for previous versions please use v4.0.0

v8.x

Since v4.0.0 eslint-config-contactlab supports Nodejs version >= 10.x

If you need support for previous versions please use v3.0.0

v6.x

Since v3.0.0 eslint-config-contactlab supports Nodejs version >= 8.x

If you need support for older versions please use v2.0.2