xref: /arkcompiler/ets_frontend/ets2panda/linter/.eslintrc.json

{
  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaVersion": "latest",
    "sourceType": "module",
    "project": true
  },
  "plugins": ["@typescript-eslint", "@stylistic", "import", "n"],
  "rules": {
    // suggestions
    "accessor-pairs": "error",
    "arrow-body-style": ["error", "always"],
    "camelcase": "off", // we use naming-convention rule to enforce naming scheme
    "class-methods-use-this": ["error", { "exceptMethods": [], "enforceForClassFields": true }],
    "complexity": ["error", { "max": 15 }],
    "consistent-return": ["error", { "treatUndefinedAsUnspecified": false }],
    "curly": ["error", "all"],
    "default-case": "error",
    "default-param-last": "warn",
    "dot-notation": "error",
    "eqeqeq": ["error", "smart"],
    "func-style": ["error", "declaration", {"allowArrowFunctions": true}],
    "max-depth": ["error", { "max": 4 }],
    "max-lines-per-function": ["error", { "max": 50 }],
    "max-params": ["error", 5],
    "multiline-comment-style": ["error", "starred-block"],
    "no-else-return": ["error", { "allowElseIf": true }],
    "no-eval": ["error", {"allowIndirect": false} ],
    "no-extra-bind": "error",
    "no-implied-eval": "error",
    "no-lonely-if": "error",
    "no-nested-ternary": "warn",
    "no-param-reassign": "warn",
    "no-prototype-builtins": "error",
    "no-regex-spaces": "error",
    "no-return-await": "error",
    "no-throw-literal": "error",
    "no-undef-init": "error",
    "no-unneeded-ternary": "error",
    "no-useless-return": "error",
    "no-var": "error",
    "one-var": ["error", "never"],
    "one-var-declaration-per-line": "error",
    "prefer-const": "error",
    "prefer-named-capture-group": "warn",
    "prefer-rest-params": "error",
    "strict": "error",
    "spaced-comment": ["error", "always"],
    "vars-on-top": "error",

     // imports
    "import/no-absolute-path": "error",
    "n/file-extension-in-import": ["error", "never"],

    // style
    "@stylistic/array-bracket-newline": ["error", "consistent"],
    "@stylistic/array-bracket-spacing": ["error", "never"],
    "@stylistic/array-element-newline": ["error", "consistent"],
    "@stylistic/arrow-parens": ["error", "always"],
    "@stylistic/arrow-spacing": ["error", { "before": true, "after": true }],
    "@stylistic/block-spacing": ["error", "always"],
    "@stylistic/brace-style": ["error", "1tbs", { "allowSingleLine": true }],
    "@stylistic/comma-dangle": [
      "error",
      {
        "arrays": "never",
        "objects": "never",
        "imports": "never",
        "exports": "never",
        "functions": "never"
      }
    ],
    "@stylistic/comma-spacing": ["error", { "before": false, "after": true }],
    "@stylistic/comma-style": ["error", "last"],
    "@stylistic/computed-property-spacing": ["error", "never", { "enforceForClassMembers": true }],
    "@stylistic/dot-location": ["error", "object"],
    "@stylistic/eol-last": ["error", "always"],
    "@stylistic/no-confusing-arrow": "error",
    "@stylistic/no-floating-decimal": "error",
    "@stylistic/func-call-spacing": ["error", "never"],
    "@stylistic/function-call-argument-newline": ["error", "consistent"],
    "@stylistic/function-paren-newline": ["error", "consistent"],
    "@stylistic/generator-star-spacing": ["error", { "before": true, "after": false }],
    "@stylistic/implicit-arrow-linebreak": ["error", "beside"],
    "@stylistic/indent": [
      "error",
      2,
      {
        "ignoredNodes": [],
        "SwitchCase": 1,
        "VariableDeclarator": 1,
        "outerIIFEBody": 1,
        "MemberExpression": 1,
        "FunctionDeclaration": {
          "parameters": 1,
          "body": 1
        },
        "FunctionExpression": {
          "parameters": 1,
          "body": 1
        },
        "CallExpression": {
          "arguments": 1
        },
        "ArrayExpression": 1,
        "ObjectExpression": 1,
        "ImportDeclaration": 1,
        "flatTernaryExpressions": true,
        "offsetTernaryExpressions": false,
        "ignoreComments": false
      }
    ],
    "@stylistic/jsx-quotes": ["error", "prefer-double"],
    "@stylistic/keyword-spacing": ["error", { "before": true, "after": true }],
    "line-comment-position": ["error", { "position": "above" }],
    "@stylistic/linebreak-style": ["error", "unix"],
    "@stylistic/lines-around-comment": ["error", { "beforeBlockComment": true }],
    "@stylistic/lines-between-class-members": [
      "error",
      {
        "enforce": [
          { "blankLine": "always", "prev": "*", "next": "method" },
          { "blankLine": "always", "prev": "method", "next": "*" }
        ]
      }
    ],
    "@stylistic/max-len": ["error", { "code": 120, "tabWidth": 2, "ignoreComments": true, "ignoreStrings": true }],
    "@stylistic/max-statements-per-line": ["error", { "max": 1 }],
    "@stylistic/multiline-ternary": ["error", "always-multiline"],
    "@stylistic/new-parens": ["error", "always"],
    "@stylistic/newline-per-chained-call": ["error", { "ignoreChainWithDepth": 2 }],
    "@stylistic/no-extra-parens": ["error", "all"],
    "@stylistic/no-mixed-spaces-and-tabs": "error",
    "@stylistic/no-multi-spaces": "error",
    "@stylistic/no-multiple-empty-lines": ["error", { "max": 2, "maxEOF": 1 }],
    "@stylistic/no-tabs": "error",
    "@stylistic/no-trailing-spaces": ["error", { "skipBlankLines": false, "ignoreComments": false }],
    "@stylistic/no-whitespace-before-property": "error",
    "@stylistic/nonblock-statement-body-position": ["error", "beside"],
    "@stylistic/object-curly-newline": ["error", { "consistent": true }],
    "@stylistic/object-curly-spacing": ["error", "always"],
    "@stylistic/operator-linebreak": ["error", "after"],
    // disable due to conflict with required rule 'lines-around-comment'
    "@stylistic/padded-blocks": "off",
    "@stylistic/quotes": ["error", "single"],
    "@stylistic/rest-spread-spacing": ["error", "never"],
    "@stylistic/semi": ["error", "always"],
    "@stylistic/semi-spacing": ["error", { "before": false, "after": true }],
    "@stylistic/semi-style": ["error", "last"],
    "@stylistic/space-before-blocks": ["error", "always"],
    "@stylistic/space-before-function-paren": ["error", "never"],
    "@stylistic/space-in-parens": ["error", "never"],
    "@stylistic/space-infix-ops": ["error"],
    "@stylistic/space-unary-ops": ["error", { "words": true, "nonwords": false, "overrides": {} }],
    "@stylistic/switch-colon-spacing": ["error", { "after": true, "before": false }],
    "@stylistic/template-curly-spacing": ["error", "never"],
    "@stylistic/template-tag-spacing": ["error", "never"],
    "unicode-bom": ["error", "never"],
    "@stylistic/wrap-iife": ["error", "outside"],
    "@stylistic/wrap-regex": "error",
    "@stylistic/yield-star-spacing": ["error", { "before": true, "after": false }],

    // typescript
    "@typescript-eslint/explicit-function-return-type": "error",
    "@typescript-eslint/adjacent-overload-signatures": "error",
    "@typescript-eslint/consistent-type-exports": "error",
    "@typescript-eslint/await-thenable": "error",
    "@typescript-eslint/no-dynamic-delete": "error",
    "@typescript-eslint/no-this-alias": "error",
    "@typescript-eslint/explicit-member-accessibility": [
      "error",
      {
        "accessibility": "no-public"
      }
    ],
    "@typescript-eslint/method-signature-style": "error",
    "@typescript-eslint/no-confusing-non-null-assertion": "error",
    "@typescript-eslint/no-confusing-void-expression": "error",
    // FIXME(knazarov)
    // need to do something about this
    "@typescript-eslint/no-explicit-any": "warn",
    // Produce too many warning caused by 'any' usage
//    "@typescript-eslint/no-unsafe-member-access": "warn",
//    "@typescript-eslint/no-unsafe-assignment": "warn",
    "@typescript-eslint/no-unsafe-call": "warn",
    "@typescript-eslint/no-unsafe-argument": "warn",
    "@typescript-eslint/no-unsafe-return": "warn",
    "no-unsafe-finally": "error",
    "@typescript-eslint/no-extra-non-null-assertion": "error",
    "@typescript-eslint/no-meaningless-void-operator": "error",
    "@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
    // FIXME(knazarov)
    // disabled due to many cases, where typescript deduces non-undefined value, but we can recieve one from the api
    "@typescript-eslint/no-unnecessary-condition": "off",
    "@typescript-eslint/no-unnecessary-type-assertion": "error",
    "@typescript-eslint/prefer-as-const": "error",
    "@typescript-eslint/prefer-optional-chain": "error",
    "@typescript-eslint/prefer-readonly": "error",
    "@typescript-eslint/consistent-type-imports": "error",
    // FIXME(knazarov)
    // need to change metadata in cookbook accordingle. so do it later
    "@typescript-eslint/naming-convention": [
      "off",
      {
        "selector": "default",
        "format": ["camelCase"]
      },
      {
        "selector": "enumMember",
        "format": ["UPPER_CASE"]
      },
      {
        "selector": "variable",
        "format": ["camelCase", "UPPER_CASE"]
      },
      {
        "selector": "typeLike",
        "format": ["PascalCase"]
      },
      {
        "selector": "memberLike",
        "format": ["camelCase"]
      }
    ]
  }
}