@cgzair/eslint-config-cgz 1.1.0

package/rules/imports.js

@@ -0,0 +1,63 @@
+module.exports = {
+  plugins: ["import"],
+  settings: {
+    "import/ignore": ["node_modules", "\\.(coffee|scss|css|less|hbs|svg|json)$"],
+  },
+  rules: {
+    "import/no-unresolved": "off",
+    "import/named": "off",
+    "import/default": "off",
+    "import/namespace": "off",
+    "import/export": "off",
+    "import/no-named-as-default": "error",
+    "import/no-named-as-default-member": "warn",
+    "import/no-deprecated": "off",
+    "import/no-extraneous-dependencies": "off",
+    "import/no-mutable-exports": "off",
+    "import/unambiguous": "off",
+    "import/no-commonjs": "off",
+    "import/no-amd": "warn",
+    "import/no-nodejs-modules": "off",
+    "import/first": "error",
+    "import/no-duplicates": "error",
+    "import/no-namespace": "off",
+    "import/extensions": "off",
+    "import/order": [
+      "warn",
+      {
+        pathGroups: [
+          {
+            pattern: "**/~/**/*[.scss|.sass|.less|.css]",
+            group: "sibling",
+          },
+          {
+            pattern: "**/@/**/*",
+            group: "external",
+            position: "after",
+          },
+        ],
+        groups: ["builtin", "external", "internal", "type", "parent", "object", "index", "sibling"],
+        "newlines-between": "never",
+      },
+    ],
+    "import/newline-after-import": "warn",
+    "import/prefer-default-export": "off",
+    "import/no-restricted-paths": "off",
+    "import/max-dependencies": "off",
+    "import/no-absolute-path": "off",
+    "import/no-dynamic-require": "off",
+    "import/no-internal-modules": "off",
+    "import/no-webpack-loader-syntax": "off",
+    "import/no-unassigned-import": "off",
+    "import/no-named-default": "off",
+    "import/no-anonymous-default-export": "off",
+    "import/exports-last": "off",
+    "import/group-exports": "off",
+    "import/no-default-export": "off",
+    "import/no-self-import": "error",
+    "import/no-cycle": ["error", { maxDepth: Infinity }],
+    "import/no-useless-path-segments": "off",
+    "import/dynamic-import-chunkname": "off",
+    "import/no-relative-parent-imports": "off",
+  },
+};

package/rules/jsx-a11y.js

@@ -0,0 +1,18 @@
+module.exports = {
+  plugins: ["jsx-a11y"],
+  rules: {
+    "jsx-a11y/alt-text": "warn",
+    "jsx-a11y/img-redundant-alt": "warn",
+    "jsx-a11y/anchor-has-content": "warn",
+    "jsx-a11y/aria-props": "warn",
+    "jsx-a11y/aria-proptypes": "warn",
+    "jsx-a11y/aria-unsupported-elements": "warn",
+    "jsx-a11y/aria-role": ["warn", { ignoreNonDOM: true }],
+    "jsx-a11y/role-has-required-aria-props": "warn",
+    "jsx-a11y/role-supports-aria-props": "warn",
+    "jsx-a11y/iframe-has-title": "warn",
+    "jsx-a11y/no-access-key": "warn",
+    "jsx-a11y/no-distracting-elements": "warn",
+    "jsx-a11y/scope": "warn",
+  },
+};

package/rules/node.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ["eslint-config-egg/lib/rules/node"],
+  rules: {
+    "node/no-deprecated-api": "error",
+  },
+};

package/rules/react.js

@@ -0,0 +1,177 @@
+module.exports = {
+  plugins: ["react", "react-hooks"],
+  rules: {
+    "react/display-name": "off",
+    "react/forbid-prop-types": ["warn", { forbid: ["any"] }],
+    "react/jsx-boolean-value": ["error", "never", { always: [] }],
+    "react/jsx-closing-bracket-location": ["error", "line-aligned"],
+    "react/jsx-closing-tag-location": "error",
+    "react/jsx-props-no-multi-spaces": "error",
+    "react/jsx-curly-spacing": ["error", "never", { allowMultiline: true }],
+    "react/jsx-handler-names": [
+      "warn",
+      {
+        eventHandlerPrefix: "handle",
+        eventHandlerPropPrefix: "on",
+      },
+    ],
+    "react/jsx-indent-props": ["error", 2],
+    "react/jsx-key": "error",
+    "react/jsx-max-props-per-line": ["error", { maximum: 1, when: "multiline" }],
+    "react/jsx-no-bind": [
+      "warn",
+      {
+        ignoreRefs: false,
+        allowArrowFunctions: true,
+        allowBind: false,
+      },
+    ],
+    "react/jsx-no-duplicate-props": ["error", { ignoreCase: true }],
+    "react/jsx-no-literals": "off",
+    "react/jsx-no-undef": "error",
+    "react/jsx-pascal-case": [
+      "error",
+      {
+        allowAllCaps: true,
+        ignore: [],
+      },
+    ],
+    "react/sort-prop-types": "off",
+    "react/jsx-sort-prop-types": "off",
+    "react/jsx-sort-props": "off",
+    "react/jsx-uses-react": ["error"],
+    "react/jsx-uses-vars": "error",
+    "react/no-danger": "warn",
+    "react/no-deprecated": "error",
+    "react/no-will-update-set-state": "error",
+    "react/no-direct-mutation-state": "off",
+    "react/no-is-mounted": "error",
+    "react/no-multi-comp": ["error", { ignoreStateless: true }],
+    "react/no-set-state": "off",
+    "react/no-string-refs": "error",
+    "react/no-this-in-sfc": "error",
+    "react/no-unknown-property": "error",
+    "react/prefer-es6-class": ["error", "always"],
+    "react/prefer-stateless-function": "off",
+    "react/prop-types": [
+      "warn",
+      {
+        ignore: [],
+        customValidators: [],
+        skipUndeclared: false,
+      },
+    ],
+    "react/react-in-jsx-scope": "off",
+    "react/require-render-return": "error",
+    "react/self-closing-comp": "error",
+    // 规则比较多，暂无开启，后期通过插件自动处理
+    "react/sort-comp": [
+      "off",
+      {
+        order: [
+          "static-methods",
+          "instance-variables",
+          "lifecycle",
+          "/^on.+$/",
+          "getters",
+          "setters",
+          "/^(get|set)(?!(InitialState$|DefaultProps$|ChildContext$)).+$/",
+          "instance-methods",
+          "everything-else",
+          "rendering",
+        ],
+        groups: {
+          lifecycle: [
+            "displayName",
+            "propTypes",
+            "contextTypes",
+            "childContextTypes",
+            "mixins",
+            "statics",
+            "defaultProps",
+            "constructor",
+            "getDefaultProps",
+            "getInitialState",
+            "state",
+            "getChildContext",
+            "componentWillMount",
+            "UNSAFE_componentWillMount",
+            "componentDidMount",
+            "componentWillReceiveProps",
+            "UNSAFE_componentWillReceiveProps",
+            "shouldComponentUpdate",
+            "componentWillUpdate",
+            "UNSAFE_componentWillUpdate",
+            "componentDidUpdate",
+            "componentWillUnmount",
+          ],
+          rendering: ["/^render.+$/", "render"],
+        },
+      },
+    ],
+    "react/jsx-wrap-multilines": [
+      "error",
+      {
+        declaration: "parens",
+        assignment: "parens",
+        return: "parens",
+        arrow: "parens",
+      },
+    ],
+    "react/jsx-first-prop-new-line": ["error", "multiline-multiprop"],
+    "react/jsx-equals-spacing": ["error", "never"],
+    "react/jsx-indent": ["error", 2],
+    "react/jsx-no-target-blank": "warn",
+    "react/no-access-state-in-setstate": "error",
+    "react/jsx-filename-extension": ["error", { extensions: [".jsx", ".js", ".tsx", ".ts", ".vue"] }],
+    "react/jsx-no-comment-textnodes": "error",
+    "react/no-render-return-value": "error",
+    "react/require-optimization": "off",
+    "react/no-find-dom-node": "error",
+    "react/forbid-component-props": "off",
+    "react/forbid-elements": "off",
+    "react/no-danger-with-children": "error",
+    "react/no-unused-prop-types": [
+      "error",
+      {
+        customValidators: [],
+        skipShapeProps: true,
+      },
+    ],
+    "react/style-prop-object": "error",
+    "react/no-unescaped-entities": "error",
+    "react/no-children-prop": "error",
+    "react/jsx-tag-spacing": [
+      "error",
+      {
+        closingSlash: "never",
+        beforeSelfClosing: "always",
+        afterOpening: "never",
+      },
+    ],
+    "react/jsx-space-before-closing": "off",
+    "react/no-array-index-key": "warn",
+    "react/require-default-props": "off",
+    "react/forbid-foreign-prop-types": "off",
+    "react/void-dom-elements-no-children": "error",
+    "react/default-props-match-prop-types": ["warn", { allowRequiredDefaults: false }],
+    "react/no-redundant-should-component-update": "error",
+    "react/no-unused-state": "error",
+    "react/boolean-prop-naming": "off",
+    "react/no-typos": "error",
+    "react/jsx-curly-brace-presence": "off",
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn",
+  },
+  settings: {
+    "import/resolver": {
+      node: {
+        extensions: [".js", ".jsx", ".json"],
+      },
+    },
+    react: {
+      pragma: "React",
+      version: "detect",
+    },
+  },
+};

package/rules/typescript.js

@@ -0,0 +1,303 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  settings: {
+    "import/parsers": {
+      "@typescript-eslint/parser": [".ts", ".d.ts"],
+    },
+    "import/resolver": {
+      node: {
+        extensions: [".mjs", ".js", ".ts", ".json"],
+      },
+    },
+    "import/extensions": [".js", ".ts", ".mjs"],
+  },
+  parserOptions: {
+    project: "./tsconfig.json",
+    createDefaultProgram: true,
+    extraFileExtensions: [".vue"],
+  },
+  rules: {
+    "@typescript-eslint/adjacent-overload-signatures": "error",
+    "@typescript-eslint/array-type": ["warn", { default: "array-simple" }],
+    "@typescript-eslint/await-thenable": "off",
+    "@typescript-eslint/ban-ts-comment": [
+      "warn",
+      {
+        "ts-expect-error": "allow-with-description",
+        "ts-ignore": "allow-with-description",
+        "ts-nocheck": "allow-with-description",
+        "ts-check": "allow-with-description",
+      },
+    ],
+    "@typescript-eslint/ban-tslint-comment": "error",
+    "@typescript-eslint/ban-types": "warn",
+
+    "brace-style": "off",
+    "@typescript-eslint/brace-style": ["error", "1tbs", { allowSingleLine: true }],
+    "@typescript-eslint/class-literal-property-style": ["warn", "fields"],
+    "comma-spacing": "off",
+    "@typescript-eslint/comma-spacing": ["error", { before: false, after: true }],
+    "@typescript-eslint/consistent-type-assertions": [
+      "error",
+      {
+        assertionStyle: "as",
+        objectLiteralTypeAssertions: "never",
+      },
+    ],
+    "@typescript-eslint/consistent-type-definitions": ["warn", "interface"],
+    "default-param-last": "off",
+    "@typescript-eslint/default-param-last": "off",
+    "dot-notation": "off",
+    "@typescript-eslint/dot-notation": ["error", { allowKeywords: true }],
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-member-accessibility": ["warn", { accessibility: "no-public" }],
+    "@typescript-eslint/explicit-module-boundary-types": "off",
+    "func-call-spacing": "off",
+    "@typescript-eslint/func-call-spacing": ["error", "never"],
+    indent: "off",
+    "@typescript-eslint/indent": [
+      "error",
+      2,
+      {
+        SwitchCase: 1,
+        VariableDeclarator: 1,
+        outerIIFEBody: 1,
+        FunctionDeclaration: {
+          parameters: 1,
+          body: 1,
+        },
+        FunctionExpression: {
+          parameters: 1,
+          body: 1,
+        },
+        CallExpression: {
+          arguments: 1,
+        },
+        ArrayExpression: 1,
+        ObjectExpression: 1,
+        ImportDeclaration: 1,
+        flatTernaryExpressions: false,
+        ignoredNodes: [
+          "JSXElement",
+          "JSXElement > *",
+          "JSXAttribute",
+          "JSXIdentifier",
+          "JSXNamespacedName",
+          "JSXMemberExpression",
+          "JSXSpreadAttribute",
+          "JSXExpressionContainer",
+          "JSXOpeningElement",
+          "JSXClosingElement",
+          "JSXText",
+          "JSXEmptyExpression",
+          "JSXSpreadChild",
+        ],
+        ignoreComments: false,
+      },
+    ],
+    "init-declarations": "off",
+    "@typescript-eslint/init-declarations": "off",
+    "keyword-spacing": "off",
+    "@typescript-eslint/keyword-spacing": [
+      "error",
+      {
+        before: true,
+        after: true,
+        overrides: {
+          return: { after: true },
+          throw: { after: true },
+          case: { after: true },
+        },
+      },
+    ],
+    "lines-between-class-members": "off",
+    "@typescript-eslint/lines-between-class-members": "off",
+    "@typescript-eslint/member-delimiter-style": "error",
+    "@typescript-eslint/member-ordering": [
+      "warn",
+      {
+        default: [
+          "public-static-field",
+          "protected-static-field",
+          "private-static-field",
+          "static-field",
+          "public-static-method",
+          "protected-static-method",
+          "private-static-method",
+          "static-method",
+          "public-instance-field",
+          "protected-instance-field",
+          "private-instance-field",
+          "public-field",
+          "protected-field",
+          "private-field",
+          "instance-field",
+          "field",
+          "constructor",
+          "public-instance-method",
+          "protected-instance-method",
+          "private-instance-method",
+          "public-method",
+          "protected-method",
+          "private-method",
+          "instance-method",
+          "method",
+        ],
+      },
+    ],
+    "@typescript-eslint/method-signature-style": ["warn", "property"],
+    camelcase: "off",
+    "@typescript-eslint/camelcase": "off",
+    "@typescript-eslint/naming-convention": "off",
+    "no-array-constructor": "off",
+    "@typescript-eslint/no-array-constructor": "error",
+    "@typescript-eslint/no-base-to-string": "off",
+    "@typescript-eslint/no-confusing-non-null-assertion": "warn",
+    "no-dupe-class-members": "off",
+    "@typescript-eslint/no-dupe-class-members": "error",
+    "@typescript-eslint/no-dynamic-delete": "off",
+    "no-empty-function": "off",
+    "@typescript-eslint/no-empty-function": [
+      "error",
+      {
+        allow: ["arrowFunctions", "functions", "methods"],
+      },
+    ],
+    "@typescript-eslint/no-empty-interface": "warn",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-extra-non-null-assertion": "off",
+    "no-extra-parens": "off",
+    "@typescript-eslint/no-extra-parens": "off",
+    "no-extra-semi": "off",
+    "@typescript-eslint/no-extra-semi": "error",
+    "@typescript-eslint/no-extraneous-class": "off",
+    "@typescript-eslint/no-floating-promises": "off",
+    "@typescript-eslint/no-for-in-array": "off",
+    "@typescript-eslint/no-implied-eval": "off",
+    "@typescript-eslint/no-inferrable-types": "warn",
+    "no-invalid-this": "off",
+    "@typescript-eslint/no-invalid-this": "off",
+    "@typescript-eslint/no-invalid-void-type": "error",
+    "no-loss-of-precision": "off",
+    "@typescript-eslint/no-loss-of-precision": ["error"],
+    "no-magic-numbers": "off",
+    "@typescript-eslint/no-magic-numbers": "off",
+    "@typescript-eslint/no-misused-new": "off",
+    "@typescript-eslint/no-misused-promises": "off",
+    "@typescript-eslint/no-namespace": [
+      "error",
+      {
+        allowDeclarations: true,
+        allowDefinitionFiles: true,
+      },
+    ],
+    "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-parameter-properties": "off",
+    "@typescript-eslint/no-require-imports": "off",
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": "error",
+    "@typescript-eslint/no-this-alias": [
+      "warn",
+      {
+        allowDestructuring: true,
+      },
+    ],
+    "@typescript-eslint/no-throw-literal": "off",
+    "@typescript-eslint/no-type-alias": "off",
+    "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off",
+    "@typescript-eslint/no-unnecessary-condition": "off",
+    "@typescript-eslint/no-unnecessary-qualifier": "off",
+    "@typescript-eslint/no-unnecessary-type-arguments": "off",
+    "@typescript-eslint/no-unnecessary-type-assertion": "off",
+    "@typescript-eslint/no-unsafe-assignment": "off",
+    "@typescript-eslint/no-unsafe-call": "off",
+    "@typescript-eslint/no-unsafe-member-access": "off",
+    "@typescript-eslint/no-unsafe-return": "off",
+    "no-unused-expressions": "off",
+    "@typescript-eslint/no-unused-expressions": [
+      "error",
+      {
+        allowShortCircuit: true,
+        allowTernary: true,
+        allowTaggedTemplates: true,
+      },
+    ],
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": ["error", { vars: "all", args: "after-used", ignoreRestSiblings: true }],
+    "@typescript-eslint/no-unused-vars-experimental": "off",
+    "no-use-before-define": "off",
+    "@typescript-eslint/no-use-before-define": ["error", { functions: false, classes: false, variables: false }],
+    "no-useless-constructor": "off",
+    "@typescript-eslint/no-useless-constructor": "error",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/prefer-as-const": "warn",
+    "@typescript-eslint/prefer-for-of": "off",
+    "@typescript-eslint/prefer-function-type": "off",
+    "@typescript-eslint/prefer-includes": "off",
+    "@typescript-eslint/prefer-namespace-keyword": "error",
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
+    "@typescript-eslint/prefer-optional-chain": "warn",
+    "@typescript-eslint/prefer-readonly": "off",
+    "@typescript-eslint/prefer-readonly-parameter-types": "off",
+    "@typescript-eslint/prefer-reduce-type-parameter": "off",
+    "@typescript-eslint/prefer-regexp-exec": "off",
+    "@typescript-eslint/prefer-string-starts-ends-with": "off",
+    "@typescript-eslint/prefer-ts-expect-error": "off",
+    "@typescript-eslint/promise-function-async": "off",
+    quotes: "off",
+    "@typescript-eslint/quotes": ["error", "double", { avoidEscape: true }],
+    "require-await": "off",
+    "@typescript-eslint/require-await": "off",
+    "@typescript-eslint/restrict-plus-operands": "warn",
+    "@typescript-eslint/restrict-template-expressions": "off",
+    "no-return-await": "off",
+    "@typescript-eslint/return-await": "off",
+    semi: "off",
+    "@typescript-eslint/semi": ["error", "always"],
+    "space-before-function-paren": "off",
+    "@typescript-eslint/space-before-function-paren": [
+      "error",
+      {
+        anonymous: "always",
+        named: "never",
+        asyncArrow: "always",
+      },
+    ],
+    "@typescript-eslint/strict-boolean-expressions": "off",
+    "@typescript-eslint/switch-exhaustiveness-check": "off",
+    "@typescript-eslint/triple-slash-reference": [
+      "error",
+      {
+        path: "never",
+        types: "always",
+        lib: "always",
+      },
+    ],
+    "@typescript-eslint/type-annotation-spacing": "error",
+    "@typescript-eslint/typedef": [
+      "error",
+      {
+        arrayDestructuring: false,
+        arrowParameter: false,
+        memberVariableDeclaration: false,
+        objectDestructuring: false,
+        parameter: false,
+        propertyDeclaration: true,
+        variableDeclaration: false,
+      },
+    ],
+    "@typescript-eslint/unbound-method": "off",
+    "@typescript-eslint/unified-signatures": "warn",
+  },
+  overrides: [
+    {
+      files: ["*.ts", "*.tsx"],
+      rules: {
+        "no-undef": "off",
+        "import/no-unresolved": "off",
+      },
+    },
+  ],
+};

package/rules/uni-app.js

@@ -0,0 +1,38 @@
+module.exports = {
+  globals: {
+    App: true,
+    Page: true,
+    Component: true,
+    Behavior: true,
+    getApp: true,
+    getCurrentPages: true,
+    plus: true,
+    uni: true,
+    Vue: true,
+    wx: true,
+    my: true,
+    swan: true,
+    tt: true,
+    qh: true,
+    qa: true,
+    xhs: true,
+    HWH5: true,
+    weex: true,
+    __id__: true,
+    __uniConfig: true,
+    __uniRoutes: true,
+    __registerPage: true,
+    UniViewJSBridge: true,
+    UniServiceJSBridge: true,
+    __DEV__: true,
+    __VIEW__: true,
+    __PLATFORM__: true,
+    __VERSION__: true,
+    __GLOBAL__: true,
+    __PLATFORM_TITLE__: true,
+    __PLATFORM_PREFIX__: true,
+    it: true,
+    describe: true,
+    expect: true,
+  },
+};

package/rules/vue.js

@@ -0,0 +1,46 @@
+module.exports = {
+  parser: "vue-eslint-parser",
+  plugins: ["vue"],
+  rules: {
+    "vue/comment-directive": "error",
+    "vue/jsx-uses-vars": "error",
+    "vue/no-shared-component-data": "error",
+    "vue/require-prop-type-constructor": "error",
+    "vue/require-valid-default-prop": "error",
+    "vue/require-v-for-key": "error",
+    "vue/no-use-v-if-with-v-for": "warn",
+    "vue/no-async-in-computed-properties": "error",
+    "vue/no-dupe-keys": "error",
+    "vue/no-duplicate-attributes": "error",
+    "vue/no-parsing-error": [
+      "error",
+      {
+        "x-invalid-end-tag": false,
+        "invalid-first-character-of-tag-name": false,
+      },
+    ],
+    "vue/no-reserved-keys": "error",
+    "vue/no-side-effects-in-computed-properties": "error",
+    "vue/no-template-key": "warn",
+    "vue/no-textarea-mustache": "error",
+    "vue/no-unused-components": "warn",
+    "vue/no-unused-vars": "warn",
+    "vue/require-component-is": "warn",
+    "vue/require-render-return": "error",
+    "vue/return-in-computed-property": "error",
+    "vue/use-v-on-exact": "error",
+    "vue/valid-template-root": "error",
+    "vue/valid-v-bind": "error",
+    "vue/valid-v-cloak": "error",
+    "vue/valid-v-else-if": "error",
+    "vue/valid-v-else": "error",
+    "vue/valid-v-for": "error",
+    "vue/valid-v-html": "error",
+    "vue/valid-v-if": "error",
+    "vue/valid-v-model": "error",
+    "vue/valid-v-on": "error",
+    "vue/valid-v-once": "error",
+    "vue/valid-v-pre": "error",
+    "vue/valid-v-show": "error",
+  },
+};

package/typescript/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["../index", "../rules/typescript"].map(require.resolve),
+};

package/typescript/node.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./index", "../rules/node"].map(require.resolve),
+};

package/typescript/react.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["../react", "../rules/typescript"].map(require.resolve),
+};

package/typescript/uni-app.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["./vue", "../rules/uni-app"].map(require.resolve),
+};