eslint-config

ES Lint Config for W11K Projects

If you're migration from Angular tslint to eslint consider following this update guideline: https://github.com/angular-eslint/angular-eslint and use the .eslintrc.json file below to get started.

Install

npm i --save-dev @w11k/eslint-config @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-rxjs

Configuration

• Typescript: @w11k/eslint-config/lib/typescript.recommended
• Angular: @w11k/eslint-config/lib/angular.recommended
• React: @w11k/eslint-config/lib/react.recommended

Breaking Changes

• Angular <= 12: Use Plugin Version 0.1.2
• Angular > 13: Use Plugin Version 1.x.x

EditorConfig

The current Version of the .editorconfig used at W11K is also HERE Just download it and include it in the root folder of your project

Angular

.eslintrc.json

{
  "root": true,
  "ignorePatterns": [
    "projects/**/*"
  ],
  "overrides": [
    {
      "files": [
        "*.ts"
      ],
      "parserOptions": {
        "project": [
          "tsconfig.json"
        ],
        "createDefaultProgram": true
      },
      "extends": [
        "@w11k/eslint-config/lib/angular.recommended"
      ],
      "rules": {
        "@angular-eslint/component-class-suffix": "warn",
        "@angular-eslint/component-selector": [
          "warn",
          {
            "type": "element",
            "prefix": "app",
            "style": "kebab-case"
          }
        ],
        "@angular-eslint/directive-class-suffix": "warn",
        "@angular-eslint/directive-selector": [
          "warn",
          {
            "type": "attribute",
            "prefix": "app",
            "style": "camelCase"
          }
        ]
      }
    },
    {
      "files": [
        "*.html"
      ],
      "extends": [
        "plugin:@angular-eslint/template/recommended"
      ],
      "rules": {}
    }
  ]
}

create-react-app

1. Install npm i --save-dev @w11k/eslint-config or yarn add -D @w11k/eslint-config

2. delete this es-lint related section from package.json

"eslintConfig": {
  "extends": [
    "react-app",
    "react-app/jest"
  ]
},

3. Add file .eslintrc.js to the project root

module.exports = {
    "root": true,
    "ignorePatterns": [
        "projects/**/*"
    ],
    "extends": [
        "@w11k/eslint-config/lib/react.recommended"
    ],
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "project": [
            "./tsconfig.json"
        ],
        "createDefaultProgram": true
    },
    "overrides": []
}

Gatsby

.eslintrc.js

module.exports = {
  "root": true,
  "ignorePatterns": [
    "projects/**/*"
  ],
  "extends": [
    "@w11k/eslint-config/lib/react.recommended"
  ],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "project": [
      "./tsconfig.json"
    ],
    "createDefaultProgram": true
  },
  "overrides": [
    {
      "files": [
        "*.ts",
        "*.tsx"
      ],
      "rules": {
        ...your overridden rules
      }
    }
  ]
}