/eslint-config-bechara-ts

Primary LanguageJavaScriptMIT LicenseMIT

Bechara - TypeScript ESLint Configuration

This package offers a custom set of rules to be used across Node.js projects written in TypeScript.

Quick Start

1. Install ESLint and this rule package in your project:

npm i -D eslint @bechara/eslint-config-bechara-ts

2. Create a .eslintrc.js file at the root of your workspace that extends the recently installed package:

module.exports =  {
  extends: [ 
    '@bechara/eslint-config-bechara-ts'
  ]
}

3. To prevent unverified code being committed, install these supporting tools for git hooks:

npm i -D husky lint-staged

4. Configure lint execution during pre-commit by adding the following properties to your package.json:

"script": {
  "prepare": "husky install .config/husky"
},
"lint-staged": {
  "*.ts": "eslint --cache --fix"
}

5. Run npm i to create husky configuration directory and create a file at /.config/husky/pre-commit:

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged --allow-empty

6. Finally, run npm i again to create the git hooks.

Remember to add .eslintcache to your .gitignore as it is irrelevant to the project.

Rules

IDE Integration

To increase productivity, it is highly recommended to install an ESLint extension for your IDE and enable auto-fixing.

Please refer to this guide that includes all the most popular coding tools:

Even faster code formatting using ESLint

Starting Definition

Our rule set uses as entry point these following predefined sets:

Further customizations are defined in the property rules of index.js. These include adding, modifying and disabling existing ones.

Please refer to comments inside index.js for clarifications.

Overwriting

To lower or increase severity of a rule, as well as disable it, overwrite its definition in your .eslintrc.js e.g.:

module.exports =  {
  extends: [ 
    '@bechara/eslint-config-bechara-ts'
  ],
  rules: {
    'eqeqeq': [ 'warn' ], // Originally 'error'
    'no-console': [ 'off' ], // Originally 'warn'
  }
}

Troubleshooting

"Parsing error: Invalid ecmaVersion"

To use the most up-to-date features (currently ecma 2020), you must use ESLint >= 7.8.0.

In case you are not able to do so, overwrite the parserOptions in your .eslintrc.js with a previous version, e.g.:

module.exports =  {
  parserOptions: {
    ecmaVersion: 6,
  },
  extends: [ 
    '@bechara/eslint-config-bechara-ts'
  ]
}