@siemens/eslint-config-angular/index.mjs

Configuration for linting Angular TypeScript and templates using Angular ESLint.

/**
 * Copyright Siemens 2024.
 * SPDX-License-Identifier: MIT
 */
import eslintJs from '@eslint/js';
import typescriptEslint from 'typescript-eslint';
import angularEslint from 'angular-eslint';
import perfectionist from 'eslint-plugin-perfectionist';
import preferArrowPlugin from 'eslint-plugin-prefer-arrow';

// Keep in sync with eslint-config-typescript (except Angular stuff).

export const configBase = typescriptEslint.config({
  extends: [
    eslintJs.configs.recommended,
    ...typescriptEslint.configs.recommended,
    ...angularEslint.configs.tsRecommended
  ],
  plugins: {
    perfectionist
  },
  languageOptions: {
    parserOptions: {
      allowAutomaticSingleRunInference: true
    }
  },
  processor: angularEslint.processInlineTemplates,
  settings: {
    'import/ignore': ['node_modules']
  },
  rules: {
    '@angular-eslint/no-attribute-decorator': ['error'],
    '@angular-eslint/no-forward-ref': ['error'],
    '@angular-eslint/use-component-view-encapsulation': ['error'],

    'brace-style': ['off'],
    'comma-dangle': ['off'],
    'comma-spacing': ['off'],
    'func-call-spacing': ['off'],
    'indent': ['off'],
    'keyword-spacing': ['off'],
    'no-shadow': ['off'],
    'no-underscore-dangle': ['off'],
    'object-curly-spacing': ['off'],
    'space-infix-ops': ['off'],
    'space-before-blocks': ['off'],

    // Disable the recommended formatting rules.
    'no-unexpected-multiline': ['off'],

    '@typescript-eslint/array-type': ['error'],
    '@typescript-eslint/member-ordering': ['off'],
    '@typescript-eslint/naming-convention': ['off'],
    '@typescript-eslint/no-non-null-asserted-optional-chain': ['error'],
    '@typescript-eslint/no-non-null-assertion': ['off'],
    '@typescript-eslint/no-require-imports': ['error'],
    '@typescript-eslint/no-shadow': ['error', { ignoreTypeValueShadow: true }],
    '@typescript-eslint/no-unused-vars': [
      'error',
      { vars: 'all', args: 'none', ignoreRestSiblings: false }
    ],
    '@typescript-eslint/no-var-requires': ['error'],
    '@typescript-eslint/no-explicit-any': ['off'],
    '@typescript-eslint/no-empty-function': ['off'],
    '@typescript-eslint/no-inferrable-types': ['error', { ignoreParameters: true }],
    '@typescript-eslint/consistent-type-assertions': ['error'],
    '@typescript-eslint/dot-notation': ['error'],
    '@typescript-eslint/no-unused-expressions': ['error'],
    '@typescript-eslint/prefer-for-of': ['error'],
    '@typescript-eslint/prefer-function-type': ['error'],
    '@typescript-eslint/prefer-nullish-coalescing': ['error', { ignorePrimitives: true }],
    '@typescript-eslint/unified-signatures': ['error'],

    'no-duplicate-imports': ['error'],
    'no-empty': ['error'],
    'no-irregular-whitespace': ['error'],
    'sort-imports': ['error', { ignoreCase: true, ignoreDeclarationSort: true }]
  }
});

export const configRecommended = typescriptEslint.config({
  extends: [...angularEslint.configs.tsAll, ...configBase],
  plugins: {
    'prefer-arrow': preferArrowPlugin
  },
  rules: {
    camelcase: ['off'],
    'no-extra-semi': ['off'],
    'no-implied-eval': ['off'],
    'no-loop-func': ['off'],
    'no-useless-constructor': ['off'],
    'sort-imports': ['off'],

    'perfectionist/sort-imports': [
      'error',
      {
        type: 'alphabetical',
        order: 'asc',
        newlinesBetween: 'always',
        groups: [
          ['builtin', 'external'],
          ['parent', 'sibling', 'index']
        ]
      }
    ],

    '@angular-eslint/component-max-inline-declarations': ['off'],
    '@angular-eslint/prefer-on-push-component-change-detection': ['off'],
    '@angular-eslint/use-component-selector': ['off'],
    '@angular-eslint/use-injectable-provided-in': ['off'],
    '@angular-eslint/no-host-metadata-property': ['off'],

    '@typescript-eslint/naming-convention': [
      'error',
      {
        selector: 'default',
        format: ['camelCase']
      },
      {
        selector: 'variable',
        modifiers: ['const', 'global'],
        format: ['camelCase', 'UPPER_CASE']
      },
      {
        selector: ['classProperty', 'parameterProperty'],
        modifiers: ['private'],
        format: ['camelCase'],
        leadingUnderscore: 'allow'
      },
      {
        selector: 'enumMember',
        format: ['PascalCase']
      },
      {
        selector: 'parameter',
        format: ['camelCase'],
        leadingUnderscore: 'allow'
      },
      {
        selector: 'typeLike',
        format: ['PascalCase']
      },
      {
        selector: 'objectLiteralProperty',
        format: null
      },
      {
        selector: 'objectLiteralMethod',
        format: null
      },
      {
        selector: 'import',
        modifiers: ['default'],
        format: null
      }
    ],
    '@typescript-eslint/no-for-in-array': ['error'],
    '@typescript-eslint/no-implied-eval': ['error'],
    '@typescript-eslint/no-loop-func': ['error'],
    '@typescript-eslint/no-this-alias': ['error'],
    '@typescript-eslint/no-useless-constructor': ['error'],
    '@typescript-eslint/prefer-includes': ['error'],
    '@typescript-eslint/prefer-literal-enum-member': ['error'],
    '@typescript-eslint/prefer-nullish-coalescing': [
      'error',
      {
        ignoreConditionalTests: true,
        ignoreMixedLogicalExpressions: true
      }
    ],
    '@typescript-eslint/prefer-optional-chain': ['error'],

    'prefer-arrow/prefer-arrow-functions': ['error']
  }
});

export default configRecommended;