Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (commit-pack) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

auto-commit

1. 说明

Eslint 代码质量

Prettier 代码风格

eslint-config-prettier 关闭所有可能干扰 Prettier 规则的 ESLint 规则

eslint-plugin-prettier 将 Prettier 规则转换为 ESLint 规则

Husky 自动化检查修改（git hook）

lint-staged 只对已更改文件检查

commitlint 检查提交信息规范性

commitizen 自动化脚本生成 commit message

vscode 插件

2. 步骤

🍀 Eslint

pnpm add -D eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin

==.eslintrc==

{
  // 表示这是根配置文件，ESLint 不会在父目录中查找其他配置文件。
  "root": true,
  // 指定要使用的解析器，这里是 TypeScript 的解析器。
  "parser": "@typescript-eslint/parser",
  "extends": [
    // 扩展 ESLint 推荐的规则。
    "eslint:recommended",
    // 扩展 @typescript-eslint/eslint-plugin 推荐的规则。
    "plugin:@typescript-eslint/recommended",
    // 扩展 @typescript-eslint/eslint-plugin 推荐的规则，禁用与 eslint:recommended 冲突的规则。
    "plugin:@typescript-eslint/eslint-recommended"
  ],
  // 指定要使用的插件，这里是 @typescript-eslint 插件。
  "plugins": ["@typescript-eslint"]
}

==.eslintrcignore==

node_modules/

README.md

脚本

"lint": "eslint ./ --ext .ts,.tsx,.json --max-warnings=0",

🍀 prettier

pnpm add -D prettier

==.prettierrc==

{
  "singleQuote": true,
  "printWidth": 100,
  "jsxSingleQuote": true,
  "bracketSameLine": true,
  "semi": false,
  "plugins": ["prettier-plugin-tailwindcss"],
  "tabWidth": 2,
  "bracketSpacing": true,
  "trailingComma": "none"
}

==.prettierrcignore==

node_modules/

README.md

脚本

"format": "prettier --config .prettierrc '.' --write"

🍀 eslint-config-prettier && eslint-plugin-prettier

pnpm add -D eslint-config-prettier eslint-plugin-prettier

==.eslintrc==

{
  // 表示这是根配置文件，ESLint 不会在父目录中查找其他配置文件。
  "root": true,
  // 指定要使用的解析器，这里是 TypeScript 的解析器。
  "parser": "@typescript-eslint/parser",
  "extends": [
    // 扩展 ESLint 推荐的规则。
    "eslint:recommended",
    // 扩展 @typescript-eslint/eslint-plugin 推荐的规则。
    "plugin:@typescript-eslint/recommended",
    // 扩展 @typescript-eslint/eslint-plugin 推荐的规则，禁用与 eslint:recommended 冲突的规则。
    "plugin:@typescript-eslint/eslint-recommended",
    // 扩展 Prettier 配置以禁用可能与 Prettier 冲突的 ESLint 规则。即 eslint-config-prettier 确保放在最后
    "prettier"
  ],
  // 指定要使用的插件，这里是 @typescript-eslint 和 Prettier 插件。
  "plugins": [
    "@typescript-eslint",
    "prettier"
  ],
  "rules": {
    // 将 Prettier 格式化强制为 ESLint 错误。
    "prettier/prettier": "error",
    // 禁用强制在箭头函数体周围使用大括号的规则。
    "arrow-body-style": "off",
    // 禁用强制为回调使用箭头函数的规则。
    "prefer-arrow-callback": "off"
  }
}
```

🍀 husky

pnpm add -D husky

pnpm exec husky init

脚本

"prepare": "husky install"

==.husky/pre-commit==

pnpm run lint

🍀 int-staged

 pnpm add -D lint-staged

==.lintstagedrc==

{
  "*.{js,jsx,ts,tsx}": ["eslint --fix", "prettier --write"]
}

==更改 .husky/pre-commit==

npx lint-staged

🍀 commitlint

 pnpm add -D @commitlint/cli @commitlint/config-conventional

==.commitlintrc.json==

{
  "extends": ["@commitlint/config-conventional"],
  "parserPreset": {
    "parserOpts": {
      "headerPattern": "^(.+?)\\((.+?)\\): (.+)$",
      "headerCorrespondence": ["type", "scope", "subject"]
    }
  },
  "rules": {
    "scope-empty": [2, "never"],
    "type-enum": [
      2,
      "always",
      [
        "✨ feat",
        "🐛 fix",
        "🎉 init",
        "✏️ docs",
        "💄 style",
        "♻️ refactor",
        "⚡️ perf",
        "✅ test",
        "⏪️ revert",
        "📦 build",
        "🚀 chore",
        "👷 ci"
      ]
    ]
  }
}

==.husky/commit-msg==

echo 'npx --no -- commitlint --edit "$1"' > .husky/commit-msg

🍀 commitizen

pnpm add -D commitizen@4.2.4  commitlint-config-cz  cz-customizabl  cz-custom

==.czrc==

{
  "path": "cz-customizable"
}

==.cz-config.js==

module.exports = {
  types: [
    { value: "✨ feat", name: "  ✨  feat: 新功能" },
    { value: "🐛 fix", name: "  🐛 fix: 修复bug" },
    { value: "🎉 init", name: "  🎉 init: 初始化" },
    { value: "✏️ docs", name: "  ✏️ docs: 文档变更" },
    { value: "💄 style", name: "  💄 style: 更改样式" },
    { value: "♻️ refactor", name: "  ♻️ refactor: 重构" },
    { value: "⚡️ perf", name: "  ⚡️ perf: 性能优化" },
    { value: "✅ test", name: "  ✅  test: 测试" },
    { value: "⏪️ revert", name: "  ⏪️ revert: 回退" },
    { value: "📦 build", name: "  📦 build: 打包" },
    { value: "🚀 chore", name: "  🚀 chore: 构建/工程依赖/工具" },
    { value: "👷 ci", name: "  👷 ci: CI related changes" },
  ],

  scopes: [
    { name: "components" },
    { name: "page" },
    { name: "css" },
    { name: "api" },
    { name: "README.md" },
    { name: "custom" },
  ],

  messages: {
    type: "请选择提交类型(必填)",
    scope: "请选择文件修改范围(必填):",
    customScope: "请输自定义文件修改范围(必填)",
    subject: "请简要描述提交(必填)",
    body: "请输入详细描述(可选)",
    breaking: "列出任何breaking changes(可选)",
    footer: "请输入要关闭的issue(可选)",
    confirmCommit: "确定提交吗",
  },

  allowCustomScopes: true,
  allowBreakingChanges: ["✨ feat", "🐛 fix"],
  subjectLimit: 49,
};

==package.json==

  "config": {
    "commitizen": {
      "path": "node_modules/cz-customizable"
    }
  },