@chemiadox/eslint-config v1.0.2

Chemiadox ESLint base configuration

Provides a standard configuration for ESLint that can be used in all Chemiadox TypeScript projects.

Guidance and reasoning

The rules defined here are an extension of the base rules defined by Airbnb with some exceptions. This package also overrides some rules with a TypeScript variant of the same rule.

Setup / installation

The package should be defined as one of the devDependencies in your project's package.json:

"devDependencies": {
  "@chemiadox/eslint-config": "^1.0.1"
}

It's also necessary to define an ESLint configuration file that extends from @chemiadox:

{
  "extends": [
    "@chemiadox"
  ],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": 11,
    "sourceType": "module",
    "project": "./tsconfig.json"
  },
  "rules": {},
  "overrides": []
}

If your project requires global exceptions, you can add your custom rules to the rules object. This should be used sparingly and as a last resort with an eye toward eliminating them as soon as possible.

It's more likely that your project will require overrides for specific file patterns that don't fit nicely into our linting standards. In these situations you will want to add values to the overrides array for specific file patterns.