TheDeveloper / eslint-config-ts-styleguide

Typescript styleguide

Usage

In your project:

# use github package registry
cat > .npmrc <<EOF
@thedeveloper:registry=https://npm.pkg.github.com/thedeveloper
EOF

npm i -D \
  @thedeveloper/eslint-config-ts-styleguide \
  @typescript-eslint/eslint-plugin \
  @typescript-eslint/parser \
  eslint-config-airbnb-base \
  eslint-plugin-import \
  eslint

Create .eslintrc.yaml:

env:
  es2021: true
  node: true

parserOptions:
  ecmaVersion: 12
  project: './tsconfig.json'

parser: '@typescript-eslint/parser'

plugins:
  - '@typescript-eslint'

extends:
  - 'plugin:@typescript-eslint/recommended'
  - 'plugin:@typescript-eslint/recommended-requiring-type-checking'
  - '@thedeveloper/eslint-config-ts-styleguide'

Add .vscode/settings.json to auto fix errors:

mkdir -p .vscode && \
cat > .vscode/settings.json <<EOF
{
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}
EOF

Test

npm i