Installation

yarn add --dev eslint @devoxa/eslint-config

The configuration also has a peer dependency on typescript@^3.9.2.

Usage

To enable the rules, add a eslint.config.js file to your project. See the ESLint configuration docs for more details.

const config = require('@devoxa/eslint-config')

module.exports = config({
  // (Recommended) Files (in gitignore syntax) that will be transformed into ignore configs
  ignoreFiles: ['.gitignore'],

  // (Optional) Additional configs that will be spread into the main config
  // See https://typescript-eslint.io/packages/typescript-eslint#config
  configs: [
    /* ... */
  ],
})

Since the ESLint configuration is for TypeScript projects it is also required that you have a tsconfig.json file configured.

It is also recommended to add the following script to your package.json for easy usage.

"lint": "eslint '{src,tests}/**/*.{ts,tsx}'"

Additionally, it is recommended to install the VS Code Extension to get in-editor warnings.

Extending

This configuration is not intended to be changed, but if you have a setup where modification is required, it is possible. To extend a configuration you can use the configs option as described above.

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

License

MIT