.eslintrc.js

/**
 * We are using the .JS version of an ESLint config file here so that we can
 * add lots of comments to better explain and document the setup.
 *
 * Source file:
 * @see https://github.com/angular-eslint/angular-eslint/blob/master/packages/integration-tests/fixtures/angular-cli-workspace/.eslintrc.js
 */
module.exports = {
  root: true,
  parser: '@typescript-eslint/parser',
  parserOptions: {
    ecmaVersion: 2020,
    sourceType: 'module',
    project: './tsconfig.json',
  },
  ignorePatterns: [],
  settings: {
    'import/parsers': {
      '@typescript-eslint/parser': ['.ts', '.tsx'],
    },
    'import/resolver': {
      typescript: {
        alwaysTryTypes: true,
        directory: './tsconfig.json',
      },
    },
  },
  plugins: ['import', '@typescript-eslint', '@angular-eslint'],
  extends: [
    'eslint:recommended',
    'plugin:prettier/recommended',
    'plugin:@typescript-eslint/eslint-recommended',
    'plugin:@typescript-eslint/recommended',
    'prettier',
    'prettier/@typescript-eslint',
    'plugin:import/errors',
    'plugin:import/warnings',
    'plugin:import/typescript',
  ],

  /**
   * TODO: Look up what this actually includes
   */
  // "extends": "tslint:recommended",

  rules: {
    '@typescript-eslint/explicit-member-accessibility': 'off',
    '@typescript-eslint/explicit-function-return-type': 'off',
    '@typescript-eslint/no-parameter-properties': 'off',
    '@typescript-eslint/no-explicit-any': 'off',
    '@typescript-eslint/no-use-before-define': ['error', { functions: false }],
    // TODO: Enable deprecation rule once available
    // @see https://github.com/typescript-eslint/typescript-eslint/issues/1223
    // @see https://github.com/SonarSource/eslint-plugin-sonarjs/issues/150
    // '@typescript-eslint/deprecation': 'warn',
    'import/namespace': 0,
    'import/order': [
      'error',
      {
        groups: [
          ['builtin', 'external'],
          'internal',
          'parent',
          'sibling',
          'index',
        ],
        alphabetize: { order: 'asc' },
        'newlines-between': 'always',
        pathGroups: [{ pattern: 'ngx-testing', group: 'internal' }],
      },
    ],

    // CODELYZER Section Below

    // ORIGINAL tslint.json -> "array-type": false,
    '@typescript-eslint/array-type': 'off',

    // ORIGINAL tslint.json -> "arrow-parens": false,
    'arrow-parens': 'off',

    // ORIGINAL tslint.json -> "deprecation": { "severity": "warning" },
    /**
     * | [`deprecation`]              | 🌓  | [`import/no-deprecated`] <sup>[1]</sup>            |
     * <sup>[1]</sup> Only warns when importing deprecated symbols<br>
     */

    // ORIGINAL tslint.json -> "component-class-suffix": true,
    '@angular-eslint/component-class-suffix': 'error',

    // ORIGINAL tslint.json -> "contextual-lifecycle": true,
    '@angular-eslint/contextual-lifecycle': 'error',

    // ORIGINAL tslint.json -> "directive-class-suffix": true,
    /**
     * TODO: Not converted yet
     */
    // '@angular-eslint/directive-class-suffix': 'error'

    // ORIGINAL tslint.json -> "directive-selector": [true, "attribute", "app", "camelCase"],
    '@angular-eslint/directive-selector': [
      'error',
      { type: 'attribute', prefix: 'ngt', style: 'camelCase' },
    ],

    // ORIGINAL tslint.json -> "component-selector": [true, "element", "app", "kebab-case"],
    '@angular-eslint/component-selector': [
      'error',
      { type: 'element', prefix: 'ngt', style: 'kebab-case' },
    ],

    // ORIGINAL tslint.json -> "import-blacklist": [true, "rxjs/Rx"],
    'no-restricted-imports': [
      'error',
      {
        paths: [
          {
            name: 'rxjs/Rx',
            message: "Please import directly from 'rxjs' instead",
          },
        ],
      },
    ],

    // ORIGINAL tslint.json -> "interface-name": false,
    '@typescript-eslint/interface-name-prefix': 'off',

    // ORIGINAL tslint.json -> "max-classes-per-file": false,
    'max-classes-per-file': 'off',

    // ORIGINAL tslint.json -> "max-line-length": [true, 140],
    'max-len': ['error', { code: 140 }],

    // ORIGINAL tslint.json -> "member-access": false,
    '@typescript-eslint/explicit-member-accessibility': 'off',

    // ORIGINAL tslint.json -> "member-ordering": [true, { "order": ["static-field", "instance-field", "static-method", "instance-method"] } ],
    '@typescript-eslint/member-ordering': [
      'error',
      {
        default: [
          'static-field',
          'instance-field',
          'static-method',
          'instance-method',
        ],
      },
    ],

    // ORIGINAL tslint.json -> "no-consecutive-blank-lines": false,
    'no-multiple-empty-lines': 'error',

    // ORIGINAL tslint.json -> "no-console": [true, "debug", "info", "time", "timeEnd", "trace"],
    'no-restricted-syntax': [
      'error',
      {
        selector:
          'CallExpression[callee.object.name="console"][callee.property.name=/^(debug|info|time|timeEnd|trace)$/]',
        message: 'Unexpected property on console object was called',
      },
    ],

    // ORIGINAL tslint.json -> "no-empty": false,
    'no-empty': 'off',

    // ORIGINAL tslint.json -> "no-inferrable-types": [true, "ignore-params"],
    '@typescript-eslint/no-inferrable-types': [
      'error',
      {
        ignoreParameters: true,
      },
    ],

    // ORIGINAL tslint.json -> "no-non-null-assertion": true,
    '@typescript-eslint/no-non-null-assertion': 'error',

    // ORIGINAL tslint.json -> "no-redundant-jsdoc": true,
    /**
     * | [`no-redundant-jsdoc`]              | 🛑  | N/A ([open issue](https://github.com/gajus/eslint-plugin-jsdoc/issues/134))         |
     */

    // ORIGINAL tslint.json -> "no-switch-case-fall-through": true,
    'no-fallthrough': 'error',

    // ORIGINAL tslint.json -> "no-var-requires": false,
    '@typescript-eslint/no-var-requires': 'off',

    // ORIGINAL tslint.json -> "object-literal-key-quotes": [true, "as-needed"],
    'quote-props': ['error', 'as-needed'],

    // ORIGINAL tslint.json -> "object-literal-sort-keys": false,
    'sort-keys': 'off',

    // ORIGINAL tslint.json -> "ordered-imports": false,
    /**
     * Needs import plugin
     */

    // ORIGINAL tslint.json -> "quotemark": [true, "single"],
    // quotes: [
    //   'error',
    //   'single',
    //   { avoidEscape: true, allowTemplateLiterals: true },
    // ],

    // ORIGINAL tslint.json -> "trailing-comma": false,
    'comma-dangle': 'off',

    // ORIGINAL tslint.json -> "no-conflicting-lifecycle": true,
    // FIXME: Error - Definition for rule '@angular-eslint/no-conflicting-lifecycle' was not found
    // '@angular-eslint/no-conflicting-lifecycle': 'error',

    // ORIGINAL tslint.json -> "no-host-metadata-property": true,
    '@angular-eslint/no-host-metadata-property': 'error',

    // ORIGINAL tslint.json -> "no-input-rename": true,
    /**
     * TODO: Not converted yet
     */
    // '@angular-eslint/no-input-rename': 'error',

    // ORIGINAL tslint.json -> "no-inputs-metadata-property": true,
    '@angular-eslint/no-inputs-metadata-property': 'error',

    // ORIGINAL tslint.json -> "no-output-native": true,
    '@angular-eslint/no-output-native': 'error',

    // ORIGINAL tslint.json -> "no-output-on-prefix": true,
    '@angular-eslint/no-output-on-prefix': 'error',

    // ORIGINAL tslint.json -> "no-output-rename": true,
    '@angular-eslint/no-output-rename': 'error',

    // ORIGINAL tslint.json -> "no-outputs-metadata-property": true,
    '@angular-eslint/no-outputs-metadata-property': 'error',

    // ORIGINAL tslint.json -> "template-banana-in-box": true,
    // APPLIED VIA TEMPLATE-RELATED CONFIG BELOW

    // ORIGINAL tslint.json -> "template-no-negated-async": true,
    /**
     * TODO: Not converted yet
     */

    // ORIGINAL tslint.json -> "use-lifecycle-interface": true,
    '@angular-eslint/use-lifecycle-interface': 'error',

    // ORIGINAL tslint.json -> "use-pipe-transform-interface": true
    '@angular-eslint/use-pipe-transform-interface': 'error',
  },
  overrides: [
    {
      files: ['*.component.html'],
      parser: '@angular-eslint/template-parser',
      plugins: ['@angular-eslint/template'],
      rules: {
        // '@angular-eslint/template/banana-in-a-box': 'error',
      },
    },
  ],
};