Skip to content

meyfa/eslint-config

Repository files navigation

@meyfa/eslint-config

CI

ESLint config for personal TypeScript projects. It uses the RushStack patch to reduce dependency clutter.

Usage

Install ESLint, as well as this package (-DE means --save-dev --save-exact):

npm install -DE eslint@8 @meyfa/eslint-config

Then in the .eslintrc.yml:

extends: '@meyfa/eslint-config'
parserOptions:
  project: './tsconfig.eslint.json'

That's it! If the project requires JSDoc for some files, add the following to the .eslintrc.yml:

overrides:
  - files: ['src/**/*.ts']
    extends: '@meyfa/eslint-config/jsdoc'

Rules

This package provides all the rules from eslint-config-standard-with-typescript with a few changes. For example, it customizes some things for files that match the glob test/**/* to work better with Mocha/Chai, and disables some impractical defaults.

The main reason this package exists is to avoid having to install all peer dependencies of eslint-config-standard-with-typescript.

About

ESLint config for personal TypeScript projects. Uses the RushStack patch to reduce dependency clutter.

Resources

License

Stars

Watchers

Forks

Sponsor this project