@zpcscc/configs 2.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 zpcscc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,204 @@
+# @zpcscc/configs
+
+[![NPM version](https://img.shields.io/npm/v/@zpcscc/configs.svg?style=flat)](https://www.npmjs.com/package/@zpcscc/configs)
+[![NPM downloads](http://img.shields.io/npm/dm/@zpcscc/configs.svg?style=flat)](https://www.npmjs.com/package/@zpcscc/configs)
+
+# 简介
+
+通用配置库
+
+
+## 安装
+
+```sh
+npm install --save-dev @zpcscc/configs
+```
+
+## 使用
+
+### eslint
+
+`.eslintrc.js`
+
+#### 基础配置
+
+```javascript
+module.exports = {
+  extends: [require.resolve('@zpcscc/configs/eslint-config')],
+};
+```
+
+#### react的eslint配置
+
+```javascript
+module.exports = {
+  extends: [require.resolve('@zpcscc/configs/eslint-config/react')],
+};
+```
+
+#### vue的eslint配置
+
+```javascript
+module.exports = {
+  extends: [require.resolve('@zpcscc/configs/eslint-config/vue')],
+};
+```
+
+#### node的eslint配置
+
+```javascript
+module.exports = {
+  extends: [require.resolve('@zpcscc/configs/eslint-config/node')],
+};
+```
+
+#### 补充配置
+
+```javascript
+module.exports = {
+  // 由于使用了eslint-config-standard-with-typescript插件对ts的支持
+  // 部分规则需要tsconfig.json配置,需要在这里引入tsconfig.json文件
+  parserOptions: {
+    project: ['./tsconfig.json'],
+  },
+};
+```
+
+`tsconfig.json`
+
+tsconfig.json 文件中，也需要在 include 中引入.eslintrc.js 文件
+
+```json
+{
+  "include": [".eslintrc.js"]
+}
+```
+
+
+
+### prettier
+
+`.prettierrc`
+
+```js
+'@zpcscc/configs/prettier-config';
+```
+
+`.prettierrc.js`
+
+```js
+module.exports = {
+  ...require('@zpcscc/configs/prettier-config'),
+};
+```
+
+
+
+### stylelint
+
+`.stylelintrc`
+
+```json
+{
+  "extends": "@zpcscc/configs/stylelint-config"
+}
+```
+
+`stylelint.config.js`
+
+```js
+module.exports = { 
+  extends: ['@zpcscc/configs/stylelint-config'],
+}
+```
+
+
+
+### tsconfig
+
+`tsconfig.json`
+
+#### 基础配置
+
+```json
+{
+  "extends": "@zpcscc/configs/tsconfig/tsconfig.base.json",
+}
+```
+
+#### react的tsconfig配置
+
+```json
+{
+  "extends": "@zpcscc/configs/tsconfig/tsconfig.react.json",
+}
+```
+
+#### vue的tsconfig配置
+
+```json
+{
+  "extends": "@zpcscc/configs/tsconfig/tsconfig.vue.json",
+}
+```
+
+### commitlint
+
+`package.json`
+
+```json
+"scripts": {
+  "commit": "git add . && git-cz",
+},
+```
+
+`.czrc`
+
+```json
+{
+  "path": "@commitlint/cz-commitlint"
+}
+```
+
+`commitlint.config.js`
+
+```js
+module.exports = {
+  extends: ['@zpcscc/configs/commitlint-config'],
+};
+```
+
+上述文件设置好后，提交代码时使用下列命令
+
+```shell
+npm run commit
+```
+
+若要默认使用`git cz`则需全局安装相关依赖
+
+```shell
+npm i -g commitizen  inquirer@8 @commitlint/cz-commitlint
+```
+
+
+
+### types
+
+`types.d.ts`
+
+```bash
+// 基础配置
+/// <reference types="@zpcscc/configs/types" />
+// react配置
+/// <reference types="@zpcscc/configs/types/react" />
+// vue配置
+/// <reference types="@zpcscc/configs/types/vue" />
+```
+
+
+
+
+
+## License
+
+MIT © [zpcscc](https://github.com/zpcscc)

package/commitlint-config/index.js

@@ -0,0 +1,120 @@
+// https://github.com/conventional-changelog/commitlint/tree/master/docs
+module.exports = {
+  parserPreset: {
+    parserOpts: {
+      headerPattern: /^(.*)(?:\((.*)\))?!?: (.*)$/
+    }
+  },
+  rules: {
+    'body-leading-blank': [1, 'always'],
+    'body-max-line-length': [2, 'always', 100],
+    'footer-leading-blank': [1, 'always'],
+    'footer-max-line-length': [2, 'always', 100],
+    'header-max-length': [2, 'always', 100],
+    'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never'],
+    'type-enum': [2, 'always', ['✨feat', '🐛fix', '🔥update', '📚docs', '💎style', '📦refactor', '🚀perf', '🚨test', '🛠build', '⚙️ ci', '🗑revert']]
+  },
+  prompt: {
+    message: {
+      skip: '该字段可以通过回车跳过',
+      max: '最大字符数',
+      min: '最小字符数',
+      emptyWarning: '该字段不能为空',
+      upperLimitWarning: '超出字符数限制',
+      lowerLimitWarning: '字符小于下限'
+    },
+    questions: {
+      type: {
+        description: '选择当前 commit 的类型',
+        enum: {
+          '✨feat': {
+            description: '新功能',
+            title: '✨Features',
+            emoji: '✨'
+          },
+          '🔥update': {
+            description: '功能更新',
+            title: '🔥Update',
+            emoji: '🔥'
+          },
+          '🐛fix': {
+            description: '修复bug',
+            title: '🐛Bug Fixes',
+            emoji: '🐛'
+          },
+          '📚docs': {
+            description: '文档更新',
+            title: '📚Documentation',
+            emoji: '📚'
+          },
+          '💎style': {
+            description: '代码风格的更改(空格，逗号，缺少分号等)',
+            title: '💎Styles',
+            emoji: '💎'
+          },
+          '📦refactor': {
+            description: '代码重构(即不修复bug也不增加新功能)',
+            title: '📦Code Refactoring',
+            emoji: '📦'
+          },
+          '🚀perf': {
+            description: '性能提升',
+            title: '🚀Performance Improvements',
+            emoji: '🚀'
+          },
+          '🚨test': {
+            description: '添加测试文件或者更改测试文件',
+            title: '🚨Tests',
+            emoji: '🚨'
+          },
+          '🛠build': {
+            description: '构建系统或依赖更新，如webpack、rollup更改或者npm',
+            title: '🛠Builds',
+            emoji: '🛠'
+          },
+          '⚙️ ci': {
+            description: 'ci配置的更改，如 travis、github-ci',
+            title: '⚙️Continuous Integrations',
+            emoji: '⚙️'
+          },
+          '🗑revert': {
+            description: '恢复以前的提交（如git revert）',
+            title: '🗑Reverts',
+            emoji: '🗑'
+          }
+        }
+      },
+      scope: {
+        description: '变动访问，模块或者文件名'
+      },
+      subject: {
+        description: '写一个简短的描述'
+      },
+      body: {
+        description: '提供更改的详细说明'
+      },
+      isBreaking: {
+        description: '是否有破坏性更新?'
+      },
+      breakingBody: {
+        description: '破坏性变更的详细描述'
+      },
+      breaking: {
+        description: '破坏性变更的详细描述简短描述'
+      },
+      isIssueAffected: {
+        description: '此更改是否影响任何已知问题?'
+      },
+      issuesBody: {
+        description: '如果问题已解决，则提交需要一个主体。请输入提交本身的详细描述'
+      },
+      issues: {
+        description: '添加问题参考 (e.g. "fix #123", "re #123".)'
+      }
+    }
+  }
+};

package/eslint-config/index.js

@@ -0,0 +1,248 @@
+// 官方文档 https://eslint.org/
+// @ts-check
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  extends: [
+  // eslint 的官方推荐配置
+  'eslint:recommended',
+  // eslint的标准配置
+  'standard',
+  // ts的标准支持
+  'standard-with-typescript',
+  // 对eslint注释的提示
+  'plugin:eslint-comments/recommended',
+  // ts推荐配置，做了一些兼容处理
+  'plugin:@typescript-eslint/recommended',
+  // eslint-plugin-import---对import的导入进行检查
+  'plugin:import/recommended',
+  // eslint-import-resolver-typescript---import校验对typescript的支持。是eslint-plugin-import插件的补充
+  'plugin:import/typescript',
+  // unicorn的推荐配置
+  'plugin:unicorn/recommended',
+  // 对promise的推荐配置
+  'plugin:promise/recommended',
+  // sonarjs的推荐配置
+  'plugin:sonarjs/recommended',
+  // eslint-plugin-prettier的推荐配置，需要放在最后一位，内部启用了eslint-plugin-prettier插件
+  // 用于关闭eslint中的所有格式化配置，全部在.prettierrc中进行格式化配置
+  'plugin:prettier/recommended'],
+  // 如果要在rules中针对某个插件做具体配置，则需要在plugins里先引入对应插件
+  plugins: ['@typescript-eslint', 'sonarjs', 'unicorn', 'promise', 'import'],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  },
+  // 运行的环境
+  env: {
+    browser: true,
+    commonjs: true,
+    es2024: true,
+    node: true,
+    jest: true
+  },
+  settings: {
+    // eslint-import-resolver-typescript
+    'import/resolver': {
+      typescript: true,
+      node: true
+    }
+  },
+  rules: {
+    // 数组类型。这里不限制写法
+    '@typescript-eslint/array-type': 'off',
+    // 限制命名规则。这里关闭。命名希望灵活些
+    '@typescript-eslint/naming-convention': 'off',
+    // 限制模板表达式。关闭此校验，希望模板表达式更加灵活
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    // ts不允许有any类型。关闭此校验，特殊情况，需要any类型
+    '@typescript-eslint/no-explicit-any': 'off',
+    // 显示函数返回类型。关闭此校验，部分函数没有返回值。无需每个都显示类型
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    // 严格的逻辑表达式。关闭此选项，可以使用 !value 的方式来进行判断；
+    '@typescript-eslint/strict-boolean-expressions': 'off',
+    // 为了安全使用 ?? 替换 ||。关闭此选项，部分场景，需要手动选择??还是||； ??会把空字符串也认为是true
+    '@typescript-eslint/prefer-nullish-coalescing': 'off',
+    // 无混淆空表达式。默认所有void都不能直接返回，需要用{}包裹。这里排除掉箭头函数。
+    // 可以直接写成 onchange={(value)=> onChange(value) }
+    // 而不是 onchange={(value)=>{ onChange(value) }}
+    '@typescript-eslint/no-confusing-void-expression': ['warn', {
+      ignoreArrowShorthand: true
+    }],
+    // import 类型时，需要加 type
+    '@typescript-eslint/consistent-type-imports': 'warn',
+    // 禁止变量重新声明
+    '@typescript-eslint/no-redeclare': 'warn',
+    // 无浮动的promise，要求处理每个promise的then和catch。
+    '@typescript-eslint/no-floating-promises': 'off',
+    // 强制使用一致性类型断言。<>语法，或者as语法
+    '@typescript-eslint/consistent-type-assertions': 'off',
+    // 不得滥用promise，这里关闭
+    '@typescript-eslint/no-misused-promises': 'off',
+    // 限制 + 操作符，两边必须相同。这里关闭
+    '@typescript-eslint/restrict-plus-operands': 'off',
+    // 禁止未使用的表达式
+    'no-unused-expressions': 'off',
+    '@typescript-eslint/no-unused-expressions': ['error', {
+      allowShortCircuit: true,
+      allowTernary: true
+    }],
+    'no-return-await': 'off',
+    // 若函数是async，则返回值需要有await
+    '@typescript-eslint/return-await': ['error'],
+    // promise函数都需要使用async。这里关闭。
+    '@typescript-eslint/promise-function-async': 'off',
+    // 禁止某些支持 ES6 样式导入声明的三重斜杠指令
+    '@typescript-eslint/triple-slash-reference': 'off',
+    // 函数体周围是否强制使用大括号。这里关闭，不强制。部分小函数，单行可以实现时，无需大括号限制
+    'arrow-body-style': 'off',
+    // if语句是否需要加括号。设置为多行加括号，单行不需要加括号
+    curly: ['error', 'multi-line'],
+    'default-param-last': 'off',
+    // 禁止速记类型转换
+    'no-implicit-coercion': ['error'],
+    // 禁止console输入。这里关闭
+    'no-console': 'off',
+    // 禁止使用continue跳出循环。这里关闭
+    'no-continue': 'off',
+    // 使用更具有描述性的名称。这里关闭
+    'unicorn/prevent-abbreviations': 'off',
+    // 不允许使用 array的reduce方法。这里关闭
+    'unicorn/no-array-reduce': 'off',
+    // 不允许使用 new Array()声明数组。这里关闭
+    'unicorn/no-new-array': 'off',
+    // 不允许使用 新的特性。这里关闭
+    'unicorn/new-for-builtins': 'off',
+    // 不允许使用 array的forEach。这里管理
+    'unicorn/no-array-for-each': 'off',
+    // 在属性上使用析构函数变量。这里关闭
+    'unicorn/consistent-destructuring': 'off',
+    // 使用esm的格式，而不是commonjs。这里关闭。部分模块还是需要使用commonjs保证兼容性
+    'unicorn/prefer-module': 'off',
+    // 箭头函数移动到外部作用于。这里关闭。在react组件内，经常会使用到箭头函数
+    'unicorn/consistent-function-scoping': 'off',
+    // 禁止将函数直接传给方法。这里关闭。
+    'unicorn/no-array-callback-reference': 'off',
+    // 不使用 null。这里关闭。实际上，与后台交互时，经常需要用到null。也更有语义化。
+    'unicorn/no-null': 'off',
+    // 强制使用数字分隔符。这里关闭。
+    'unicorn/numeric-separators-style': 'off',
+    // 名称校验，这里关闭
+    'import/named': 'off',
+    // 禁止整个文件的注释，只允许注释文件块。这里关闭。
+    'eslint-comments/disable-enable-pair': 'off',
+    // 函数名称后需要跟一个空格。这里关闭
+    'space-before-function-paren': 'off',
+    // 返回值必须被使用。这里关闭
+    'sonarjs/no-ignored-return': 'off',
+    // 以下配置待整理完善，以上配置已整理，尽量不要动了。
+    'array-bracket-spacing': ['error', 'never'],
+    'arrow-parens': ['error', 'always'],
+    'arrow-spacing': ['error', {
+      after: true,
+      before: true
+    }],
+    camelcase: 'off',
+    'consistent-return': 'off',
+    'class-methods-use-this': 'off',
+    'default-case-last': ['error'],
+    'eol-last': ['error'],
+    eqeqeq: ['error', 'always', {
+      null: 'ignore'
+    }],
+    'func-names': ['warn', 'never', {
+      generators: 'as-needed'
+    }],
+    'func-style': ['error'],
+    'import/export': 'off',
+    'import/extensions': 'off',
+    'import/no-cycle': 'off',
+    'import/no-extraneous-dependencies': 'off',
+    'import/no-named-as-default': 'off',
+    'import/no-relative-packages': 'off',
+    'import/no-unresolved': 'off',
+    'import/prefer-default-export': 'off',
+    'keyword-spacing': ['error'],
+    'lines-between-class-members': 'off',
+    'max-classes-per-file': 'off',
+    'max-len': ['error', {
+      code: 180,
+      ignoreComments: true,
+      ignoreRegExpLiterals: true
+    }],
+    'no-bitwise': ['error'],
+    'no-class-assign': ['error'],
+    'no-cond-assign': ['error', 'except-parens'],
+    'no-const-assign': ['error'],
+    'no-constructor-return': ['error'],
+    'no-dupe-class-members': ['error'],
+    'no-duplicate-imports': ['error'],
+    'no-else-return': ['error'],
+    'no-eval': ['error'],
+    'no-inner-declarations': 'off',
+    'no-labels': ['error'],
+    'no-lonely-if': ['error'],
+    'no-new': ['error'],
+    'no-promise-executor-return': ['error'],
+    'no-param-reassign': ['error', {
+      props: false
+    }],
+    'no-plusplus': 'off',
+    'no-return-assign': ['error', 'except-parens'],
+    'no-shadow': 'off',
+    'no-mixed-spaces-and-tabs': ['error'],
+    'no-multi-assign': 'off',
+    'no-multiple-empty-lines': ['error'],
+    'no-nested-ternary': 'off',
+    'no-new-symbol': ['error'],
+    'no-spaced-func': ['error'],
+    'no-trailing-spaces': ['error'],
+    'no-use-before-define': 'off',
+    'no-useless-computed-key': ['error'],
+    'no-useless-concat': ['error'],
+    'no-useless-constructor': 'off',
+    'no-useless-return': ['error'],
+    'no-useless-rename': ['error'],
+    'no-undef': ['error'],
+    'no-unexpected-multiline': ['error'],
+    'no-unreachable-loop': ['error'],
+    'no-unneeded-ternary': ['error'],
+    'no-unused-vars': ['error', {
+      args: 'none',
+      vars: 'all'
+    }],
+    'no-var': ['error'],
+    'no-void': ['error'],
+    'object-shorthand': ['error', 'always', {
+      avoidQuotes: true,
+      ignoreConstructors: false
+    }],
+    'prefer-arrow-callback': ['error', {
+      allowNamedFunctions: false,
+      allowUnboundThis: true
+    }],
+    'prefer-const': ['error'],
+    'prefer-destructuring': 'off',
+    'prefer-rest-params': ['error'],
+    'prefer-template': ['error'],
+    'promise/always-return': 'off',
+    'promise/catch-or-return': 'off',
+    quotes: ['error'],
+    'require-atomic-updates': ['error'],
+    semi: ['error', 'always'],
+    'sonarjs/cognitive-complexity': 'off',
+    'sonarjs/no-nested-template-literals': 'off',
+    'sonarjs/no-duplicate-string': 'off',
+    'sonarjs/no-small-switch': 'off',
+    'sonarjs/prefer-immediate-return': 'off',
+    'space-before-blocks': ['error', 'always'],
+    'space-in-parens': ['error', 'never'],
+    'space-unary-ops': ['error', {
+      nonwords: false,
+      overrides: {}
+    }],
+    'symbol-description': ['error'],
+    'template-curly-spacing': ['error', 'never'],
+    'unicorn/filename-case': 'off'
+  }
+};

package/eslint-config/node/index.js

@@ -0,0 +1,11 @@
+// 官方文档 https://eslint.org/
+
+// @ts-check
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  extends: [
+  // 对node的提示
+  'plugin:n/recommended', require.resolve("../index")]
+};

package/eslint-config/react/index.js

@@ -0,0 +1,55 @@
+// @ts-check
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  extends: [
+  // 对react的推荐配置
+  'plugin:react/recommended',
+  // react17及以上，新的jsx转换规则，需要引入react/jsx-runtime以禁止部分规则
+  'plugin:react/jsx-runtime',
+  // react-hook的推荐配置
+  'plugin:react-hooks/recommended',
+  // 对jsx的支持与推荐配置
+  'plugin:jsx-a11y/recommended', require.resolve("../index")],
+  plugins: ['react', 'react-hooks'],
+  // 使用typescript解析器
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    // 使用额外的语言特性
+    ecmaFeatures: {
+      // 开启jsx支持
+      jsx: true,
+      sourceType: 'module'
+    }
+  },
+  settings: {
+    // eslint-plugin-react的配置https://github.com/jsx-eslint/eslint-plugin-react#configuration
+    react: {
+      version: 'detect'
+    }
+  },
+  rules: {
+    'react/destructuring-assignment': 'off',
+    // react17之后引入新的jsx转换。不再需要显示引入react。这两项规则需要关闭。
+    'react/jsx-uses-react': 'off',
+    'react/jsx-props-no-spreading': 'off',
+    // props类型检查.关闭此校验，ts有静态类型检查
+    'react/prop-types': 'off',
+    'react/react-in-jsx-scope': 'off',
+    'react/self-closing-comp': 'warn',
+    'react/sort-comp': 'off',
+    'react/no-access-state-in-setstate': 'off',
+    // 禁止未知属性。这里忽略emotion里的css属性报错。将css属性视为正常属性
+    'react/no-unknown-property': ['error', {
+      ignore: ['css']
+    }],
+    // useEffect数组的提示
+    'react-hooks/exhaustive-deps': 'off',
+    // 非button的元素点击事件必须同时有个键盘事件。这里关闭
+    'jsx-a11y/click-events-have-key-events': 'off',
+    // 交互式元素应是可聚焦的。这里关闭
+    'jsx-a11y/interactive-supports-focus': 'off'
+    // 强制填写了默认值的参数在最后。需关闭此选项，否则部分函数参数值，无法任意调整位置。
+  }
+};

package/eslint-config/vue/index.js

@@ -0,0 +1,16 @@
+// 官方文档 https://eslint.org/
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution');
+
+// @ts-check
+/**
+ * @type {import("eslint").Linter.Config}
+ */
+module.exports = {
+  extends: ['plugin:vue/vue3-recommended', '@vue/eslint-config-typescript', '@vue/eslint-config-prettier', require.resolve("../index")],
+  parser: 'vue-eslint-parser',
+  parserOptions: {
+    parser: '@typescript-eslint/parser',
+    sourceType: 'module'
+  }
+};

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "@zpcscc/configs",
+  "version": "2.0.0",
+  "description": "项目通用配置",
+  "keywords": [
+    "commitlint",
+    "eslint",
+    "prettier",
+    "stylelint",
+    "tsconfig",
+    "types",
+    "react",
+    "vue",
+    "configs"
+  ],
+  "homepage": "https://zpcscc.github.io/configs",
+  "repository": "https://github.com/zpcscc/configs",
+  "license": "MIT",
+  "author": {
+    "name": "zpcscc",
+    "email": "dxsixpc@gmail.com"
+  },
+  "files": [
+    "dist",
+    "commitlint-config",
+    "eslint-config",
+    "prettier-config",
+    "stylelint-config",
+    "tsconfig",
+    "types"
+  ],
+  "scripts": {
+    "build": "father build",
+    "build:watch": "father dev",
+    "commit": "git add . && git-cz",
+    "deploy": "pnpm run docs:build && pnpm run docs:deploy",
+    "dev": "dumi dev",
+    "docs:build": "dumi build",
+    "docs:deploy": "gh-pages -d docs-dist",
+    "doctor": "father doctor",
+    "prepublishOnly": "father doctor && pnpm run build && cp -r ./dist/* . && rm -rf dist",
+    "postpublish": "git clean -fd",
+    "start": "dumi dev"
+  },
+  "dependencies": {
+    "@babel/core": "^7.23.2",
+    "@babel/plugin-syntax-flow": "^7.22.5",
+    "@babel/plugin-transform-react-jsx": "^7.22.15",
+    "@babel/runtime": "^7.23.2",
+    "@commitlint/cz-commitlint": "^18.2.0",
+    "@rushstack/eslint-patch": "^1.5.1",
+    "@types/node": "^20.8.10",
+    "@types/react": "^18.2.34",
+    "@types/react-dom": "^18.2.14",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
+    "@vue/eslint-config-prettier": "^8.0.0",
+    "@vue/eslint-config-typescript": "^12.0.0",
+    "commitizen": "^4.0.3",
+    "cosmiconfig": "^8.3.6",
+    "eslint": "^8.52.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-standard": "^17.1.0",
+    "eslint-config-standard-with-typescript": "^39.1.1",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-import": "^2.29.0",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-n": "^16.2.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-sonarjs": "^0.22.0",
+    "eslint-plugin-unicorn": "^49.0.0",
+    "eslint-plugin-vue": "^9.18.1",
+    "inquirer": "^8.2.5",
+    "postcss": "^8.4.31",
+    "prettier": "^3.0.3",
+    "prettier-plugin-organize-imports": "^3.2.3",
+    "prettier-plugin-packagejson": "^2.4.6",
+    "stylelint": "^14.16.1",
+    "stylelint-config-idiomatic-order": "^9.0.0",
+    "stylelint-declaration-block-no-ignored-properties": "^2.7.0",
+    "vue-eslint-parser": "^9.3.2"
+  },
+  "devDependencies": {
+    "dumi": "^2.2.14",
+    "father": "^4.3.6",
+    "gh-pages": "^6.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-is": "^18.2.0",
+    "styled-components": "^6.1.0",
+    "tslib": "^2.6.2",
+    "typescript": "^5.2.2",
+    "webpack": "^5.89.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}

package/prettier-config/index.js

@@ -0,0 +1,71 @@
+// 官方文档 https://prettier.io/
+module.exports = {
+  // 额外的插件
+  plugins: [
+  // import格式化时自动排序
+  require.resolve('prettier-plugin-organize-imports'),
+  // package.json格式化时自动排序
+  require.resolve('prettier-plugin-packagejson')],
+  // import格式化自动排序时，不删除未使用的import
+  organizeImportsSkipDestructiveCodeActions: true,
+  // 结尾需要分号
+  semi: true,
+  // 使用单引号
+  singleQuote: true,
+  // 每行最大字符数量
+  printWidth: 100,
+  // 结尾逗号, 这里关闭，暂时不需要逗号
+  trailingComma: 'none',
+  // 每个缩进级别的空格数
+  tabWidth: 2,
+  // 是否使用制表符缩进
+  useTabs: false,
+  // 是否换行
+  proseWrap: 'never',
+  // 换行符，linux和macos中为'lf'，window中为'crlf'
+  endOfLine: 'lf',
+  // 在jsx中是否使用单引号
+  jsxSingleQuote: true,
+  // 对象和括号之间是否需要空格
+  bracketSpacing: true,
+  // 将多行html标签放在最后一行末尾。而不是重开一行。这里关闭，希望重开一行。
+  bracketSameLine: false,
+  // 箭头函数，只有一个参数的时候，也需要括号
+  arrowParens: 'always',
+  // 对象的 key 仅在必要时用引号
+  quoteProps: 'as-needed',
+  // 不需要写文件开头的 @prettier
+  requirePragma: false,
+  // 不需要自动在文件开头插入 @prettier
+  insertPragma: false,
+  // 根据显示样式决定 html 要不要折行, 默认css
+  htmlWhitespaceSensitivity: 'css',
+  // vue 文件中的 script 和 style 内不用缩进
+  vueIndentScriptAndStyle: false,
+  // 格式化嵌入的内容
+  embeddedLanguageFormatting: 'auto',
+  // html, vue, jsx 中每个属性占一行
+  singleAttributePerLine: false,
+  // 重写部分文件的规则
+  overrides: [{
+    files: ['.eslintrc', '.prettierrc', '.stylelintrc'],
+    options: {
+      parser: 'json'
+    }
+  }, {
+    files: 'package*.json',
+    options: {
+      printWidth: 1000
+    }
+  }, {
+    files: '*.yml',
+    options: {
+      singleQuote: false
+    }
+  }, {
+    files: '*.md',
+    options: {
+      proseWrap: 'preserve'
+    }
+  }]
+};

package/stylelint-config/index.js

@@ -0,0 +1,43 @@
+// 官方文档 https://stylelint.io/
+module.exports = {
+  extends: [
+  // 标准配置
+  'stylelint-config-standard',
+  // 惯用样式排序规则
+  'stylelint-config-idiomatic-order'],
+  plugins: [
+  // 避免属性冲突而忽略某些属性
+  'stylelint-declaration-block-no-ignored-properties'],
+  rules: {
+    // 缩进采用 2 个空格
+    indentation: 2,
+    // 声明中不允许出现“unknown”属性
+    'declaration-property-value-no-unknown': true,
+    // 不能为空css样式块
+    'block-no-empty': true,
+    // 指定css函数名为小写
+    'function-name-case': 'lower',
+    // 禁止低权重选择权出现在高权重选择器之后
+    'no-descending-specificity': true,
+    // 不允许重复选择器
+    'no-duplicate-selectors': true,
+    // 统一使用双引号
+    'string-quotes': 'double',
+    // 禁止使用!important
+    'declaration-no-important': true,
+    // 指定每行最大长度
+    'max-line-length': 80,
+    // 关键字大小写
+    'value-keyword-case': null,
+    // 指定类选择器的模式。
+    'selector-class-pattern': null,
+    // 指定关键帧名称的模式。
+    'keyframes-name-pattern': null,
+    // 声明前是否需要空行
+    'declaration-empty-line-before': null,
+    // 注释前是否需要空行
+    'comment-empty-line-before': null,
+    // 不允许出现用双斜杠注释掉的样式
+    'no-invalid-double-slash-comments': null
+  }
+};

package/tsconfig/tsconfig.base.json

@@ -0,0 +1,50 @@
+// 官方文档 https://www.typescriptlang.org/tsconfig
+{
+  // 从外部引用的基础配置
+  "compilerOptions": {
+    // 启用后，会开启ts所有的严格检查，可在下方单独某项进行关闭；
+    "strict": true,
+    // 启用后，TypeScript 将检查函数中的所有代码路径以确保它们返回值；
+    "noImplicitReturns": true,
+    // 启用后，不允许使用any；
+    "noImplicitAny": false,
+    // 设置项目的模块类型
+    "module": "ESNext",
+    // 指定模块的解析策略.
+    "moduleResolution": "Node",
+    // 指定编译后的版本。编译后的代码需要在什么版本的环境下运行
+    "target": "ESNext",
+    // 提供全局的ts类型api
+    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    // 模块导入修复。启用此项会自动启用 allowSyntheticDefaultImports
+    "esModuleInterop": true,
+    // 为你工程中的每个 TypeScript 或 JavaScript 文件生成 .d.ts 文件。
+    "declaration": true,
+    // 跳过声明文件的类型检查
+    "skipLibCheck": true,
+    // 解析json模块，允许导入带有“.json”扩展名的模块
+    "resolveJsonModule": true,
+    // 只发出.d.ts文件；不发出.js文件。仅用作导出ts类型时开启；
+    "emitDeclarationOnly": false,
+    // 在文件名中强制使用一致的大小写
+    "forceConsistentCasingInFileNames": true,
+    // 启用生成 sourcemap files；这些文件允许调试器和其他工具在使用实际生成的 JavaScript 文件时，显示原始的 TypeScript 代码。
+    "sourceMap": true,
+    // 报告未使用的局部变量的错误。建议开启
+    "noUnusedLocals": true,
+    // 严格的空检查；建议开启，方便提示某字段可能为null，undefined，false等情况
+    "strictNullChecks": true,
+    // 启用对装饰器的实验性支持
+    "experimentalDecorators": true,
+    // 允许默认全部导出，而不是 * as newName的形式
+    "allowSyntheticDefaultImports": true,
+    // 开启后，所有的文件都应是模块
+    "isolatedModules": false
+    // 模块导入修复。启用此项会自动启用 allowSyntheticDefaultImports // ts 5.0后才支持。
+    // "verbatimModuleSyntax": true
+    // 允许在项目中导入js文件
+    // "allowJs": true,
+    // 为js文件提供类型检查，与allowJs配合使用。开启后，需要同时配置 outDir
+    // "checkJs": true,
+  }
+}

package/tsconfig/tsconfig.react.json

@@ -0,0 +1,9 @@
+// 官方文档 https://www.typescriptlang.org/tsconfig
+{
+  "extends": "./tsconfig.base.json",
+  // 从外部引用的基础配置
+  "compilerOptions": {
+    // 控制 JSX 在 JavaScript 文件中的输出方式。 这只影响 .tsx 文件的 JS 文件输出；
+    "jsx": "react-jsx"
+  }
+}

package/tsconfig/tsconfig.vue.json

@@ -0,0 +1,13 @@
+// 官方文档 https://www.typescriptlang.org/tsconfig
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "useDefineForClassFields": true,
+    // vue 项目中，必须是preserve
+    "jsx": "preserve",
+    // 没有隐含的this。防止this指向错误
+    "noImplicitThis": true,
+    // Vite项目中必须开启
+    "isolatedModules": true
+  }
+}

package/types/files.d.ts

@@ -0,0 +1,240 @@
+// 一些文件类型
+
+// CSS modules
+type CSSModuleClasses = Readonly<Record<string, string>>;
+
+declare module '*.module.css' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.scss' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.sass' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.less' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.styl' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.stylus' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.pcss' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+declare module '*.module.sss' {
+  const classes: CSSModuleClasses;
+  export default classes;
+}
+
+// CSS
+declare module '*.css' {
+  const css: string;
+  export default css;
+}
+declare module '*.scss' {
+  const css: string;
+  export default css;
+}
+declare module '*.sass' {
+  const css: string;
+  export default css;
+}
+declare module '*.less' {
+  const css: string;
+  export default css;
+}
+declare module '*.styl' {
+  const css: string;
+  export default css;
+}
+declare module '*.stylus' {
+  const css: string;
+  export default css;
+}
+declare module '*.pcss' {
+  const css: string;
+  export default css;
+}
+declare module '*.sss' {
+  const css: string;
+  export default css;
+}
+
+// images
+declare module '*.png' {
+  const src: string;
+  export default src;
+}
+declare module '*.jpg' {
+  const src: string;
+  export default src;
+}
+declare module '*.jpeg' {
+  const src: string;
+  export default src;
+}
+declare module '*.jfif' {
+  const src: string;
+  export default src;
+}
+declare module '*.pjpeg' {
+  const src: string;
+  export default src;
+}
+declare module '*.pjp' {
+  const src: string;
+  export default src;
+}
+declare module '*.gif' {
+  const src: string;
+  export default src;
+}
+declare module '*.svg' {
+  const src: string;
+  export default src;
+}
+declare module '*.ico' {
+  const src: string;
+  export default src;
+}
+declare module '*.webp' {
+  const src: string;
+  export default src;
+}
+declare module '*.avif' {
+  const src: string;
+  export default src;
+}
+
+// media
+declare module '*.mp4' {
+  const src: string;
+  export default src;
+}
+declare module '*.webm' {
+  const src: string;
+  export default src;
+}
+declare module '*.ogg' {
+  const src: string;
+  export default src;
+}
+declare module '*.mp3' {
+  const src: string;
+  export default src;
+}
+declare module '*.wav' {
+  const src: string;
+  export default src;
+}
+declare module '*.flac' {
+  const src: string;
+  export default src;
+}
+declare module '*.aac' {
+  const src: string;
+  export default src;
+}
+
+// fonts
+declare module '*.woff' {
+  const src: string;
+  export default src;
+}
+declare module '*.woff2' {
+  const src: string;
+  export default src;
+}
+declare module '*.eot' {
+  const src: string;
+  export default src;
+}
+declare module '*.ttf' {
+  const src: string;
+  export default src;
+}
+declare module '*.otf' {
+  const src: string;
+  export default src;
+}
+
+// other
+declare module '*.webmanifest' {
+  const src: string;
+  export default src;
+}
+declare module '*.pdf' {
+  const src: string;
+  export default src;
+}
+declare module '*.txt' {
+  const src: string;
+  export default src;
+}
+
+// wasm?init
+declare module '*.wasm?init' {
+  const initWasm: (options: WebAssembly.Imports) => Promise<WebAssembly.Instance>;
+  export default initWasm;
+}
+
+// web worker
+declare module '*?worker' {
+  const workerConstructor: new () => Worker;
+  export default workerConstructor;
+}
+
+declare module '*?worker&inline' {
+  const workerConstructor: new () => Worker;
+  export default workerConstructor;
+}
+
+declare module '*?worker&url' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?sharedworker' {
+  const sharedWorkerConstructor: new () => SharedWorker;
+  export default sharedWorkerConstructor;
+}
+
+declare module '*?sharedworker&inline' {
+  const sharedWorkerConstructor: new () => SharedWorker;
+  export default sharedWorkerConstructor;
+}
+
+declare module '*?sharedworker&url' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?raw' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?url' {
+  const src: string;
+  export default src;
+}
+
+declare module '*?inline' {
+  const src: string;
+  export default src;
+}
+
+declare module '*.bmp' {
+  const src: string;
+  export default src;
+}

package/types/index.d.ts

@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+/* eslint-disable multiline-comment-style */
+/// <reference types="node" />
+/// <reference types="./files" />

package/types/react.d.ts

@@ -0,0 +1,5 @@
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+/* eslint-disable multiline-comment-style */
+/// <reference types="./index" />
+/// <reference types="react" />
+/// <reference types="react-dom" />

package/types/vue.d.ts

@@ -0,0 +1,3 @@
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+/* eslint-disable multiline-comment-style */
+/// <reference types="./index" />