etienne-bechara/eslint-config-bechara-ts

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:

• ESLint Recommended
• ESLint TypeScript Recommended
• Import Errors
• Import Warnings
• Jest Recommended
• Unicorn Recommended

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'
  ]
}

eslint-config-bechara-ts's Issues

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀