eslint-config-tc

ESLint shareable config for JavaScript projects

What is eslint-config-tc?

Shared configuration for ESLint. Follow the instructions below to easily include this configuration in another project without having to duplicate the file.

How do I install it?

First thing first, let's make sure you have the necessary pre-requisites.

System Dependencies

Node

• Node.js - v16.0.0+
• npm - v8.0.0+

Command

npx install-peerdeps --dev eslint-config-tc

eslint, eslint-plugin-import, eslint-plugin-jest, eslint-plugin-prettier, eslint-plugin-unicorn, and prettier are peer dependencies and must be installed.

Usage

Add the following to your .eslintrc.json file:

{
  "extends": "eslint-config-tc"
}

If you need to override a rule, your .eslintrc.json file should look like the example below. All shared rules will be used, but eqeqeq will be turned off.

{
  "extends": "eslint-config-tc",
  "rules": {
    "eqeqeq": "off"
  }
}

Contributing

Please see CONTRIBUTING.md.

Release History

Please see CHANGELOG.md.

License

Copyright (c) 2016-2023 Thomas Lindner. Licensed under the MIT license.