commit-pack 1.0.15 → 1.0.16

package/README.md

@@ -1,6 +1,6 @@
 # auto-commit
 
-## 1. 说明
+## 1. 概述
 
 Eslint 代码质量
 
@@ -20,56 +20,44 @@ commitizen 自动化脚本生成 commit message
 
 vscode 插件
 
-## 2. 步骤
+## 2. 快速入门
 
-### 🍀 Eslint
+</br>
 
-```sh
-pnpm add -D eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin
+### 🚀 安装
 ```
-
-==.eslintrc==
-
-```json
-{
-  // 表示这是根配置文件，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"]
-}
+pnpm add -D commit-pack@latest
 ```
+```
+bun add -d commit-pack@latest
+```
+```
+npm i -D commit-pack@latest
+```
+```
+yarn add -D commit-pack@latest
+```
+</br>
 
-==.eslintrcignore==
-
-```json
-node_modules/
-
-README.md
+### 🍀 初始化
+```
+pnpm exec commit-pack-init
+```
+```
+bux commit-pack-init
+```
+```
+npx commit-pack-init
+```
+```
+yarn dlx commit-pack-init
 ```
 
-脚本
 
-```json
-"lint": "eslint ./ --ext .ts,.tsx,.json --max-warnings=0",
-```
 
-### 🍀 prettier
 
-```sh
-pnpm add -D prettier
-```
 
-==.prettierrc==
+**.prettierrc**
 
 ```json
 {
@@ -85,54 +73,44 @@ pnpm add -D prettier
 }
 ```
 
-==.prettierrcignore==
-
-```json
-node_modules/
-
-README.md
-```
-
-脚本
 
-```json
-"format": "prettier --config .prettierrc '.' --write"
-```
-
-### 🍀 eslint-config-prettier && eslint-plugin-prettier
 
-```sh
-pnpm add -D eslint-config-prettier eslint-plugin-prettier
-```
-
-==.eslintrc==
+**.eslintrc**
 
 ````json
 {
-  // 表示这是根配置文件，ESLint 不会在父目录中查找其他配置文件。
+  // 这是根配置文件，ESLint 不会在父目录中查找其他配置文件。
   "root": true,
+
   // 指定要使用的解析器，这里是 TypeScript 的解析器。
   "parser": "@typescript-eslint/parser",
+
   "extends": [
-    // 扩展 ESLint 推荐的规则。
+    // 扩展 ESLint 推荐的规则
     "eslint:recommended",
-    // 扩展 @typescript-eslint/eslint-plugin 推荐的规则。
+
+    // 扩展 @typescript-eslint/eslint-plugin 推荐规则
     "plugin:@typescript-eslint/recommended",
-    // 扩展 @typescript-eslint/eslint-plugin 推荐的规则，禁用与 eslint:recommended 冲突的规则。
+
+    // 扩展 @typescript-eslint/eslint-plugin 推荐的规则，禁用与 eslint:recommended 冲突的规则
     "plugin:@typescript-eslint/eslint-recommended",
-    // 扩展 Prettier 配置以禁用可能与 Prettier 冲突的 ESLint 规则。即 eslint-config-prettier 确保放在最后
+
+    // 扩展 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"
   }
@@ -140,55 +118,8 @@ pnpm add -D eslint-config-prettier eslint-plugin-prettier
 ```
 ````
 
-### 🍀 husky
-
-```sh
-pnpm add -D husky
-```
-
-```sh
-pnpm exec husky init
-```
-
-脚本
-
-```
-"prepare": "husky install"
-```
-
-==.husky/pre-commit==
-
-```
-pnpm run lint
-```
-
-### 🍀 int-staged
-
-```sh
- pnpm add -D lint-staged
-```
-
-==.lintstagedrc==
 
-```sh
-{
-  "*.{js,jsx,ts,tsx}": ["eslint --fix", "prettier --write"]
-}
-```
-
-==更改 .husky/pre-commit==
-
-```
-npx lint-staged
-```
-
-### 🍀 commitlint
-
-```sh
- pnpm add -D @commitlint/cli @commitlint/config-conventional
-```
-
-==.commitlintrc.json==
+**.commitlintrc.json**
 
 ```json
 {
@@ -223,27 +154,7 @@ npx lint-staged
 }
 ```
 
-==.husky/commit-msg==
-
-```sh
-echo 'npx --no -- commitlint --edit "$1"' > .husky/commit-msg
-```
-
-### 🍀 commitizen
-
-```sh
-pnpm add -D commitizen@4.2.4  commitlint-config-cz  cz-customizabl  cz-custom
-```
-
-==.czrc==
-
-```json
-{
-  "path": "cz-customizable"
-}
-```
-
-==.cz-config.js==
+**.cz-config.js**
 
 ```js
 module.exports = {
@@ -287,13 +198,3 @@ module.exports = {
   subjectLimit: 49,
 };
 ```
-
-==package.json==
-
-```json
-  "config": {
-    "commitizen": {
-      "path": "node_modules/cz-customizable"
-    }
-  },
-```

package/bin/index.mjs

@@ -37,6 +37,13 @@ console.log(chalk.green(`检测到使用的包管理器：${packageManager}`))
 const packageJsonPath = path.join(projectRoot, 'package.json')
 const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'))
 
+// 检查是否已经初始化过
+const initFlagPath = path.join(projectRoot, '.commit-pack-init')
+if (fs.existsSync(initFlagPath)) {
+  console.log(chalk.yellow('已检测到初始化标志文件，跳过初始化'))
+  process.exit(0)
+}
+
 // 确保 devDependencies 存在
 if (!packageJson.devDependencies) {
   packageJson.devDependencies = {}
@@ -214,3 +221,7 @@ if (modified) {
   fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2), 'utf8')
   console.log(chalk.green('已更新 package.json'))
 }
+
+// 创建初始化标志文件
+fs.writeFileSync(initFlagPath, 'initialized', 'utf8')
+console.log(chalk.green('已创建初始化标志文件'))

package/lib/index.mjs

@@ -35,6 +35,13 @@ console.log(_chalk.default.green(`检测到使用的包管理器：${packageMana
 const packageJsonPath = _path.default.join(projectRoot, 'package.json');
 const packageJson = JSON.parse(_fs.default.readFileSync(packageJsonPath, 'utf8'));
 
+// 检查是否已经初始化过
+const initFlagPath = _path.default.join(projectRoot, '.commit-pack-init');
+if (_fs.default.existsSync(initFlagPath)) {
+  console.log(_chalk.default.yellow('已检测到初始化标志文件，跳过初始化'));
+  process.exit(0);
+}
+
 // 确保 devDependencies 存在
 if (!packageJson.devDependencies) {
   packageJson.devDependencies = {};
@@ -188,3 +195,7 @@ if (modified) {
   _fs.default.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2), 'utf8');
   console.log(_chalk.default.green('已更新 package.json'));
 }
+
+// 创建初始化标志文件
+_fs.default.writeFileSync(initFlagPath, 'initialized', 'utf8');
+console.log(_chalk.default.green('已创建初始化标志文件'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commit-pack",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "A setup package to automatly check project's style and commit configuration",
   "main": "lib/index.js",
   "bin": {

package/setup-script/cz-config.sh

@@ -1,18 +1,18 @@
 cat > .cz-config.js << 'EOF'
 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相关修改' }
+      { 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: [