improve(eslint-config-ts-lib): 改进执行 lint 的速度

Author: liujinxing

.prettierignore

@@ -0,0 +1,3 @@
+node_modules
+dist
+build

CHANGELOG.md

@@ -1,5 +1,12 @@
 # 变更说明
 
+## 0.14.4
+
+- improve(eslint-config-ts-lib): 改进执行 lint 的速度
+- fix(eslint-config-ts-lib): 修复 prettier 和 eslint 规则冲突的缺陷
+- breadchange(eslint-config-ts-lib): 增加 jsdoc 和 typescript 类型显式声明的规则
+- improve(ts-lib-scripts): 启用 eslint 的缓存
+
 ## v0.14.3 - 2021.8.19
 
 - fix(ts-lib-tools): 修复打包时包含了 jest 的 `__snapshots__` 目录的缺陷

e2e/eslint/class-use-this.ts

@@ -0,0 +1,5 @@
+export class Demo {
+  method_a(): any {
+    return this.method_a;
+  }
+}

e2e/eslint/method-reassign.ts

@@ -0,0 +1,9 @@
+/**
+ * 累加
+ *
+ * @param acc 累加值
+ * @param item 需要合并的项
+ */
+export function reduce(acc: Record<string, string>, item: string): void {
+  acc[item] = '123';
+}

e2e/jest-resolver-tsconfig-paths/__tests__/module-a.spec.ts

@@ -1,5 +1,5 @@
-import k from '@test/module-a/k';
 import moduleA from '@test/module-a';
+import k from '@test/module-a/k';
 
 it('module-a', () => {
   expect(k).toBeDefined();

e2e/jest-resolver-tsconfig-paths/modules/module-a/k.ts

@@ -1,3 +1,6 @@
-export default function a() {
+/**
+ * 测试函数
+ */
+export default function a(): string {
   return 'x';
 }

examples/package.json

@@ -19,7 +19,7 @@
     "lint-staged": "^8.1.7",
     "react": "^16.8.6",
     "rimraf": "^2.6.3",
-    "typescript": "^4.3.5"
+    "typescript": "^4.4.2"
   },
   "prettier": {
     "printWidth": 80,

package.json

@@ -21,7 +21,7 @@
     "husky": "^4.2.5",
     "lerna": "^3.16.4",
     "lint-staged": "^8.1.7",
-    "typescript": "^4.3.5",
+    "typescript": "^4.4.2",
     "typescript-plugin-css-modules": "^3.4.0"
   },
   "eslintConfig": {

packages/babel-preset-ts-lib/create.js

@@ -16,7 +16,6 @@ module.exports = function create(_api, _opts, env) {
           },
         },
       ],
-      // eslint-disable-next-line prettier/prettier
       isEnvProduction && [
         require('@babel/preset-env').default,
         {

packages/babel-preset-ts-lib/src/build-source.ts

@@ -1,4 +1,6 @@
-import { transform, TransformOptions } from '@babel/core';
+import type { TransformOptions } from '@babel/core';
+import { transform } from '@babel/core';
+
 import tsLibBabelPreset from '../index';
 
 const transformOptions: TransformOptions = {
@@ -8,9 +10,10 @@ const transformOptions: TransformOptions = {
 
 /**
  * 编译源码
+ *
  * @param source 源码
  */
-export default function buildSource(source: string) {
+export default function buildSource(source: string): string {
   const babelFileResult = transform(source, transformOptions);
   return babelFileResult.code;
 }

packages/eslint-config-ts-lib-fast/index.js

@@ -1,9 +1,5 @@
 const eslintConfig = {
   extends: ['ts-lib'],
-  rules: {
-    'prettier/prettier': 'off',
-    'import/no-cycle': 'off',
-  },
 };
 
 module.exports = eslintConfig;

packages/eslint-config-ts-lib/.npmignore

@@ -1 +1,2 @@
 tsconfig.json
+scripts

packages/eslint-config-ts-lib/README.md

@@ -1,3 +1,123 @@
 # eslint-config-ts-lib
 
 [ts-lib-scripts](https://github.com/sinoui/ts-lib-scripts) 创建的 ts 库项目使用的 ESLint 配置
+
+## 安装
+
+```bash
+yarn add eslint-config-ts-lib typescript --dev
+```
+
+## 使用
+
+```json
+{
+  "eslintConfig": {
+    "extends": "ts-lib"
+  }
+}
+```
+
+## 包含的规则
+
+- [for-direction](./docs/rules/for-direction.md)
+- [getter-return](./docs/rules/getter-return.md)
+- [no-async-promise-executor](./docs/rules/no-async-promise-executor.md)
+- [no-compare-neg-zero](./docs/rules/no-compare-neg-zero.md)
+- [no-cond-assign](./docs/rules/no-cond-assign.md)
+- [no-constant-condition](./docs/rules/no-constant-condition.md)
+- [no-control-regex](./docs/rules/no-control-regex.md)
+- [no-debugger](./docs/rules/no-debugger.md)
+- [no-dupe-args](./docs/rules/no-dupe-args.md)
+- [no-dupe-else-if](./docs/rules/no-dupe-else-if.md)
+- [no-dupe-keys](./docs/rules/no-dupe-keys.md)
+- [no-duplicate-case](./docs/rules/no-duplicate-case.md)
+- [no-empty](./docs/rules/no-empty.md)
+- [no-empty-character-class](./docs/rules/no-empty-character-class.md)
+- [no-ex-assign](./docs/rules/no-ex-assign.md)
+- [no-extra-boolean-cast](./docs/rules/no-extra-boolean-cast.md)
+- [no-extra-semi](./docs/rules/no-extra-semi.md)
+- [no-func-assign](./docs/rules/no-func-assign.md)
+- [no-import-assign](./docs/rules/no-import-assign.md)
+- [no-inner-declarations](./docs/rules/no-inner-declarations.md)
+- [no-invalid-regexp](./docs/rules/no-invalid-regexp.md)
+- [no-irregular-whitespace](./docs/rules/no-irregular-whitespace.md)
+- [no-misleading-character-class](./docs/rules/no-misleading-character-class.md)
+- [no-obj-calls](./docs/rules/no-obj-calls.md)
+- [no-prototype-builtins](./docs/rules/no-prototype-builtins.md)
+- [no-regex-spaces](./docs/rules/no-regex-spaces.md)
+- [no-setter-return](./docs/rules/no-setter-return.md)
+- [no-sparse-arrays](./docs/rules/no-sparse-arrays.md)
+- [no-unexpected-multiline](./docs/rules/no-unexpected-multiline.md)
+- [no-unreachable](./docs/rules/no-unreachable.md)
+- [no-unsafe-finally](./docs/rules/no-unsafe-finally.md)
+- [no-unsafe-negation](./docs/rules/no-unsafe-negation.md)
+- [use-isnan](./docs/rules/use-isnan.md)
+- [valid-typeof](./docs/rules/valid-typeof.md)
+- [no-case-declarations](./docs/rules/no-case-declarations.md)
+- [no-empty-pattern](./docs/rules/no-empty-pattern.md)
+- [no-fallthrough](./docs/rules/no-fallthrough.md)
+- [no-global-assign](./docs/rules/no-global-assign.md)
+- [no-octal](./docs/rules/no-octal.md)
+- [no-redeclare](./docs/rules/no-redeclare.md)
+- [no-self-assign](./docs/rules/no-self-assign.md)
+- [no-unused-labels](./docs/rules/no-unused-labels.md)
+- [no-useless-catch](./docs/rules/no-useless-catch.md)
+- [no-useless-escape](./docs/rules/no-useless-escape.md)
+- [no-with](./docs/rules/no-with.md)
+- [no-delete-var](./docs/rules/no-delete-var.md)
+- [no-shadow-restricted-names](./docs/rules/no-shadow-restricted-names.md)
+- [no-undef](./docs/rules/no-undef.md)
+- [no-unused-vars](./docs/rules/no-unused-vars.md)
+- [no-mixed-spaces-and-tabs](./docs/rules/no-mixed-spaces-and-tabs.md)
+- [constructor-super](./docs/rules/constructor-super.md)
+- [no-class-assign](./docs/rules/no-class-assign.md)
+- [no-const-assign](./docs/rules/no-const-assign.md)
+- [no-dupe-class-members](./docs/rules/no-dupe-class-members.md)
+- [no-new-symbol](./docs/rules/no-new-symbol.md)
+- [no-this-before-super](./docs/rules/no-this-before-super.md)
+- [require-yield](./docs/rules/require-yield.md)
+- [react/no-danger-with-children](./docs/rules/react/no-danger-with-children.md)
+- [react/display-name](./docs/rules/react/display-name.md)
+- [react/no-children-prop](./docs/rules/react/no-children-prop.md)
+- [react/no-deprecated](./docs/rules/react/no-deprecated.md)
+- [react/no-direct-mutation-state](./docs/rules/react/no-direct-mutation-state.md)
+- [react/no-find-dom-node](./docs/rules/react/no-find-dom-node.md)
+- [react/no-render-return-value](./docs/rules/react/no-render-return-value.md)
+- [react/no-is-mounted](./docs/rules/react/no-is-mounted.md)
+- [react/no-string-refs](./docs/rules/react/no-string-refs.md)
+- [react/no-unescaped-entities](./docs/rules/react/no-unescaped-entities.md)
+- [react/no-unknown-property](./docs/rules/react/no-unknown-property.md)
+- [react/react-in-jsx-scope](./docs/rules/react/react-in-jsx-scope.md)
+- [react/prop-types](./docs/rules/react/prop-types.md)
+- [react/require-render-return](./docs/rules/react/require-render-return.md)
+- [react/jsx-key](./docs/rules/react/jsx-key.md)
+- [react/jsx-no-comment-textnodes](./docs/rules/react/jsx-no-comment-textnodes.md)
+- [react/jsx-no-duplicate-props](./docs/rules/react/jsx-no-duplicate-props.md)
+- [react/jsx-no-target-blank](./docs/rules/react/jsx-no-target-blank.md)
+- [react/jsx-no-undef](./docs/rules/react/jsx-no-undef.md)
+- [react/jsx-uses-react](./docs/rules/react/jsx-uses-react.md)
+- [react/jsx-uses-vars](./docs/rules/react/jsx-uses-vars.md)
+- [@typescript-eslint/ban-ts-comment](./docs/rules/@typescript-eslint/ban-ts-comment.md)
+- [@typescript-eslint/adjacent-overload-signatures](./docs/rules/@typescript-eslint/adjacent-overload-signatures.md)
+- [@typescript-eslint/explicit-module-boundary-types](./docs/rules/@typescript-eslint/explicit-module-boundary-types.md)
+- [@typescript-eslint/no-explicit-any](./docs/rules/@typescript-eslint/no-explicit-any.md)
+- [@typescript-eslint/ban-types](./docs/rules/@typescript-eslint/ban-types.md)
+- [@typescript-eslint/no-extra-non-null-assertion](./docs/rules/@typescript-eslint/no-extra-non-null-assertion.md)
+- [@typescript-eslint/no-inferrable-types](./docs/rules/@typescript-eslint/no-inferrable-types.md)
+- [@typescript-eslint/no-empty-interface](./docs/rules/@typescript-eslint/no-empty-interface.md)
+- [@typescript-eslint/no-misused-new](./docs/rules/@typescript-eslint/no-misused-new.md)
+- [@typescript-eslint/no-namespace](./docs/rules/@typescript-eslint/no-namespace.md)
+- [@typescript-eslint/no-var-requires](./docs/rules/@typescript-eslint/no-var-requires.md)
+- [@typescript-eslint/no-non-null-asserted-optional-chain](./docs/rules/@typescript-eslint/no-non-null-asserted-optional-chain.md)
+- [@typescript-eslint/no-non-null-assertion](./docs/rules/@typescript-eslint/no-non-null-assertion.md)
+- [@typescript-eslint/no-this-alias](./docs/rules/@typescript-eslint/no-this-alias.md)
+- [@typescript-eslint/prefer-namespace-keyword](./docs/rules/@typescript-eslint/prefer-namespace-keyword.md)
+- [@typescript-eslint/prefer-as-const](./docs/rules/@typescript-eslint/prefer-as-const.md)
+- [@typescript-eslint/triple-slash-reference](./docs/rules/@typescript-eslint/triple-slash-reference.md)
+- [@typescript-eslint/no-empty-function](./docs/rules/@typescript-eslint/no-empty-function.md)
+- [@typescript-eslint/no-array-constructor](./docs/rules/@typescript-eslint/no-array-constructor.md)
+- [@typescript-eslint/no-extra-semi](./docs/rules/@typescript-eslint/no-extra-semi.md)
+- [@typescript-eslint/no-unused-vars](./docs/rules/@typescript-eslint/no-unused-vars.md)
+- [react-hooks/exhaustive-deps](./docs/rules/react-hooks/exhaustive-deps.md)
+- [react-hooks/rules-of-hooks](./docs/rules/react-hooks/rules-of-hooks.md)

packages/eslint-config-ts-lib/docs/rules/@typescript-eslint/adjacent-overload-signatures.md

@@ -0,0 +1,97 @@
+# @typescript-eslint/adjacent-overload-signatures
+
+> 来自 [plugin:@typescript-eslint/recommended](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin) 的规则。
+
+# Require that member overloads be consecutive (`adjacent-overload-signatures`)
+
+Grouping overloaded members together can improve readability of the code.
+
+## Rule Details
+
+This rule aims to standardize the way overloaded members are organized.
+
+The following patterns are considered warnings:
+
+```ts
+declare namespace Foo {
+  export function foo(s: string): void;
+  export function foo(n: number): void;
+  export function bar(): void;
+  export function foo(sn: string | number): void;
+}
+
+type Foo = {
+  foo(s: string): void;
+  foo(n: number): void;
+  bar(): void;
+  foo(sn: string | number): void;
+};
+
+interface Foo {
+  foo(s: string): void;
+  foo(n: number): void;
+  bar(): void;
+  foo(sn: string | number): void;
+}
+
+class Foo {
+  foo(s: string): void;
+  foo(n: number): void;
+  bar(): void {}
+  foo(sn: string | number): void {}
+}
+
+export function foo(s: string): void;
+export function foo(n: number): void;
+export function bar(): void;
+export function foo(sn: string | number): void;
+```
+
+The following patterns are not warnings:
+
+```ts
+declare namespace Foo {
+  export function foo(s: string): void;
+  export function foo(n: number): void;
+  export function foo(sn: string | number): void;
+  export function bar(): void;
+}
+
+type Foo = {
+  foo(s: string): void;
+  foo(n: number): void;
+  foo(sn: string | number): void;
+  bar(): void;
+};
+
+interface Foo {
+  foo(s: string): void;
+  foo(n: number): void;
+  foo(sn: string | number): void;
+  bar(): void;
+}
+
+class Foo {
+  foo(s: string): void;
+  foo(n: number): void;
+  foo(sn: string | number): void {}
+  bar(): void {}
+}
+
+export function bar(): void;
+export function foo(s: string): void;
+export function foo(n: number): void;
+export function foo(sn: string | number): void;
+```
+
+## When Not To Use It
+
+If you don't care about the general structure of the code, then you will not need this rule.
+
+## Compatibility
+
+- TSLint: [adjacent-overload-signatures](https://palantir.github.io/tslint/rules/adjacent-overload-signatures/)
+
+## 参考文档
+
+- [@typescript-eslint/adjacent-overload-signatures 官方文档](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/docs/rules/adjacent-overload-signatures.md)