npm - @huaiyou/hooks-git - Versions diffs - 1.0.0 - Mend

@huaiyou/hooks-git 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/.husky/commit-msg ADDED Viewed

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+pnpm commitlint --edit $1

package/.husky/pre-commit ADDED Viewed

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+pnpm lint-staged

package/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,17 @@
+# @huaiyou/hooks-git
+## 1.0.0
+### Major Changes
+- fdfb6fc: 首次发布 @huaiyou 系列工具包 v1.0.0 正式版，包含api请求、工程配置、Git钩子、类型定义、UI组件、通用工具等核心能力，适配前端工程化开发全流程
+## 0.0.0
+### Initial Release
+- ✨ 集成 Husky 9.x Git 钩子
+- ✨ Commitlint 配置（Conventional Commits 规范）
+- ✨ Lint-staged 自动代码检查和格式化
+- ✨ Pre-commit 和 commit-msg 钩子
+- 📝 完整的使用文档和最佳实践指南

package/README.md ADDED Viewed

@@ -0,0 +1,246 @@
+# @huaiyou/hooks-git
+> Git 钩子配置，包含 Husky、Commitlint 和 Lint-staged，确保代码质量和提交规范。
+## 📦 安装
+```bash
+pnpm add -D @huaiyou/hooks-git husky @commitlint/cli lint-staged
+```
+## 🚀 快速开始
+### 1. 安装 Husky
+在项目根目录运行：
+```bash
+pnpm prepare
+```
+### 2. 复制配置文件
+将以下文件复制到项目根目录：
+**commitlint.config.js**:
+```javascript
+module.exports = require('@huaiyou/hooks-git/commitlint.config');
+```
+**lint-staged.config.js**:
+```javascript
+module.exports = require('@huaiyou/hooks-git/lint-staged.config');
+```
+### 3. 配置 Husky 钩子
+**创建 .husky/pre-commit**:
+```bash
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+pnpm lint-staged
+```
+**创建 .husky/commit-msg**:
+```bash
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+pnpm commitlint --edit $1
+```
+### 4. 添加脚本
+在 `package.json` 中：
+```json
+{
+  "scripts": {
+    "prepare": "husky install"
+  }
+}
+```
+## ✨ 特性
+### Commitlint
+强制执行 [Conventional Commits](https://www.conventionalcommits.org/) 规范：
+- ✅ **feat**: 新功能
+- ✅ **fix**: Bug 修复
+- ✅ **docs**: 文档更新
+- ✅ **style**: 代码格式（不影响代码运行）
+- ✅ **refactor**: 重构
+- ✅ **perf**: 性能优化
+- ✅ **test**: 测试相关
+- ✅ **build**: 构建系统或依赖
+- ✅ **ci**: CI 配置
+- ✅ **chore**: 其他修改
+- ✅ **revert**: 回退提交
+### Lint-staged
+在提交前自动运行代码检查和格式化：
+- **TypeScript/JavaScript**: ESLint + Prettier
+- **JSON/Markdown/YAML**: Prettier
+## 📝 提交消息格式
+### 基本格式
+```
+<type>(<scope>): <subject>
+<body>
+<footer>
+```
+### 示例
+```bash
+# 简单提交
+feat: add user authentication
+# 带作用域
+feat(auth): implement JWT token validation
+# 带详细描述
+fix(api): resolve CORS issue in production
+This fix addresses the CORS error that was preventing
+requests from the frontend in production environment.
+Closes #123
+```
+### 规则
+1. **type**: 必填，见上述类型列表
+2. **scope**: 可选，表示影响范围
+3. **subject**: 必填，简短描述（小写开头，不要句号）
+4. **body**: 可选，详细描述
+5. **footer**: 可选，关联 Issue 或 Breaking Changes
+## 🔧 自定义配置
+### 修改 Commitlint 规则
+创建 `commitlint.config.js`:
+```javascript
+const baseConfig = require('@huaiyou/hooks-git/commitlint.config');
+module.exports = {
+  ...baseConfig,
+  rules: {
+    ...baseConfig.rules,
+    'subject-max-length': [2, 'always', 100], // 自定义主题长度
+  },
+};
+```
+### 修改 Lint-staged 规则
+创建 `lint-staged.config.js`:
+```javascript
+const baseConfig = require('@huaiyou/hooks-git/lint-staged.config');
+module.exports = {
+  ...baseConfig,
+  '*.{ts,tsx}': [
+    'eslint --fix',
+    'prettier --write',
+    'vitest related --run', // 添加测试
+  ],
+};
+```
+## 🚫 跳过钩子
+### 临时跳过（不推荐）
+```bash
+# 跳过 pre-commit 钩子
+git commit --no-verify
+# 跳过 commit-msg 钩子
+git commit -m "message" --no-verify
+```
+### 禁用钩子
+```bash
+# 临时禁用 Husky
+export HUSKY=0
+# 提交
+git commit -m "message"
+# 重新启用
+unset HUSKY
+```
+## 📋 最佳实践
+1. **原子提交**: 每次提交只做一件事
+2. **清晰描述**: 提交信息要能让他人理解
+3. **关联 Issue**: 使用 `Closes #123` 关联问题
+4. **Breaking Changes**: 重大变更要在 footer 说明
+5. **定期提交**: 不要积累太多修改
+### Breaking Changes 示例
+```bash
+feat(api): change authentication method
+BREAKING CHANGE: The old API key authentication is replaced
+with JWT tokens. All clients must update to use the new
+authentication method.
+```
+## 🔍 故障排除
+### Husky 钩子不执行
+```bash
+# 重新安装 Husky
+rm -rf .husky
+pnpm prepare
+```
+### Commitlint 不工作
+```bash
+# 检查配置文件
+cat commitlint.config.js
+# 手动测试
+echo "test: message" | pnpm commitlint
+```
+### Lint-staged 不运行
+```bash
+# 检查配置
+cat lint-staged.config.js
+# 手动运行
+pnpm lint-staged
+```
+## 🤝 贡献
+欢迎提交 Issue 和 Pull Request！
+## 📄 License
+MIT

package/dist/index.cjs ADDED Viewed

@@ -0,0 +1,73 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+const types = {
+  feat: "\u2728 \u65B0\u529F\u80FD",
+  fix: "\u{1F41B} \u4FEE\u590D Bug",
+  docs: "\u{1F4DA} \u6587\u6863\u66F4\u65B0",
+  style: "\u{1F484} \u4EE3\u7801\u683C\u5F0F\uFF08\u4E0D\u5F71\u54CD\u903B\u8F91\uFF09",
+  refactor: "\u267B\uFE0F \u91CD\u6784\u4EE3\u7801\uFF08\u4E0D\u5F71\u54CD\u529F\u80FD\uFF09",
+  perf: "\u26A1 \u6027\u80FD\u4F18\u5316",
+  test: "\u{1F9EA} \u6D4B\u8BD5\u76F8\u5173",
+  chore: "\u{1F527} \u5DE5\u5177\u6216\u811A\u624B\u67B6\u53D8\u66F4",
+  ci: "\u2699\uFE0F CI/CD \u76F8\u5173",
+  build: "\u{1F6E0} \u6784\u5EFA\u7CFB\u7EDF\u6216\u5916\u90E8\u4F9D\u8D56\u53D8\u66F4",
+  revert: "\u23EA \u56DE\u6EDA\u63D0\u4EA4",
+  update: "\u2B06\uFE0F \u66F4\u65B0\u67D0\u529F\u80FD\uFF08\u975E\u65B0\u529F\u80FD/\u975E\u4FEE\u590D\uFF09"
+};
+const allowTypes = Object.keys(types);
+const rule$2 = (parsed, when, value) => {
+  const type = parsed.type;
+  if (!type) {
+    return [false, "\u2716 \u8BF7\u586B\u5199\u63D0\u4EA4\u7C7B\u578B\uFF08\u5982 feat / fix / docs\uFF09"];
+  }
+  if (!allowTypes.includes(type)) {
+    const list = allowTypes.map((k) => `- ${k}: ${types[k]}`).join("\n");
+    return [false, `\u2716 \u63D0\u4EA4\u7C7B\u578B\u4E0D\u5408\u6CD5\uFF0C\u8BF7\u4ECE\u4EE5\u4E0B\u7C7B\u578B\u4E2D\u9009\u62E9\uFF1A
+${list}`];
+  }
+  return [true];
+};
+const rule$1 = (parsed) => {
+  const subject = parsed.subject?.trim();
+  if (!subject) {
+    return [false, "\u2716 \u63D0\u4EA4\u63CF\u8FF0\uFF08subject\uFF09\u4E0D\u80FD\u4E3A\u7A7A\uFF0C\u8BF7\u8865\u5145\u4E00\u53E5\u6E05\u6670\u63CF\u8FF0"];
+  }
+  return [true];
+};
+const rule = (parsed, _when, value = 120) => {
+  const header = parsed.header || "";
+  if (header.length > value) {
+    return [false, `\u2716 \u63D0\u4EA4\u4FE1\u606F\u8FC7\u957F\uFF08\u5F53\u524D ${header.length} \u5B57\u7B26\uFF09\uFF0C\u6700\u5927\u5141\u8BB8 ${value} \u5B57\u7B26`];
+  }
+  return [true];
+};
+const rules = {
+  "zh-type-enum": rule$2,
+  "zh-subject-empty": rule$1,
+  "zh-header-max-length": rule
+};
+const plugin = {
+  rules
+};
+const config = {
+  plugins: ["@huaiyou/hooks-git"],
+  rules: {
+    "zh-type-enum": [2, "always"],
+    "zh-subject-empty": [2, "always"],
+    "zh-header-max-length": [2, "always", 72],
+    // Disable standard rules that we are replacing or don't need
+    "type-enum": [0],
+    "type-empty": [0],
+    "subject-empty": [0],
+    "header-max-length": [0]
+  }
+};
+exports.config = config;
+exports.default = plugin;
+exports.rules = rules;

package/package.json ADDED Viewed

@@ -0,0 +1,45 @@
+{
+  "name": "@huaiyou/hooks-git",
+  "version": "1.0.0",
+  "description": "Git hooks configuration with Husky, Commitlint and Lint-staged",
+  "files": [
+    ".husky",
+    "*.config.js",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "devDependencies": {
+    "@commitlint/types": "^19.8.1",
+    "@types/minimatch": "^6.0.0",
+    "typescript": "^5.9.3",
+    "unbuild": "^3.6.1",
+    "undici-types": "^7.16.0",
+    "vitest": "^2.1.8",
+    "@huaiyou/config-ts": "^1.0.0"
+  },
+  "dependencies": {
+    "minimatch": "^10.1.1"
+  },
+  "peerDependencies": {
+    "@commitlint/lint": ">=7.6.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:ui": "vitest --ui"
+  }
+}