ccjk 14.2.2 → 15.0.0

package/templates/hooks/pre-commit-black.md

@@ -1,274 +0,0 @@
----
-id: pre-commit-black
-type: PreToolUse
-name: Black Pre-commit Hook
-description: Automatically format Python code with Black before git commits
-priority: 10
-matcher: Bash(git commit *)
-command: black .
-timeout: 30000
-enabled: true
-applicableTo: [python, django, flask, fastapi]
----
-
-# Black Pre-commit Hook
-
-## Description
-
-This hook automatically runs Black, the uncompromising Python code formatter, before every git commit. Black ensures consistent Python code formatting with minimal configuration required.
-
-## 描述
-
-此钩子在每次 git 提交前自动运行 Black（不妥协的 Python 代码格式化工具）。Black 确保 Python 代码格式一致，且需要的配置最少。
-
-## When it runs
-
-- **Trigger**: Before any `git commit` command
-- **Condition**: When Python files (`.py`) are detected in the project
-- **Scope**: Runs on all Python files in the project
-
-## 运行时机
-
-- **触发器**: 任何 `git commit` 命令之前
-- **条件**: 在项目中检测到 Python 文件（`.py`）时
-- **范围**: 在项目中所有 Python 文件上运行
-
-## Configuration
-
-### Prerequisites
-```bash
-# Install Black
-pip install black
-
-# Or with development dependencies
-pip install --dev black
-
-# Or using poetry
-poetry add --group dev black
-```
-
-### Basic Black Configuration
-```toml
-# pyproject.toml
-[tool.black]
-line-length = 88
-target-version = ['py38', 'py39', 'py310', 'py311']
-include = '\.pyi?$'
-extend-exclude = '''
-/(
-  # directories
-  \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | build
-  | dist
-)/
-'''
-```
-
-### Hook Configuration
-```yaml
-# In your CCJK configuration
-hooks:
-  pre-commit-black:
-    enabled: true
-    command: "black ."
-    timeout: 30000
-    checkFormatted: false
-```
-
-## 配置
-
-### 前置条件
-```bash
-# 安装 Black
-pip install black
-
-# 或作为开发依赖
-pip install --dev black
-
-# 或使用 poetry
-poetry add --group dev black
-```
-
-### 基本 Black 配置
-```toml
-# pyproject.toml
-[tool.black]
-line-length = 88
-target-version = ['py38', 'py39', 'py310', 'py311']
-include = '\.pyi?$'
-extend-exclude = '''
-/(
-  # directories
-  \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | build
-  | dist
-)/
-'''
-```
-
-## Customization
-
-### Custom Line Length
-```toml
-# pyproject.toml
-[tool.black]
-line-length = 100
-```
-
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black --line-length 100 ."
-```
-
-### Format Specific Directories Only
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black src/ tests/"
-    include: ["src/**/*.py", "tests/**/*.py"]
-```
-
-### Check Mode (Don't Write)
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black --check --diff ."
-    failOnUnformatted: true
-```
-
-### Skip String Normalization
-```toml
-# pyproject.toml
-[tool.black]
-skip-string-normalization = true
-```
-
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black --skip-string-normalization ."
-```
-
-### Integration with isort
-```yaml
-hooks:
-  pre-commit-isort:
-    command: "isort ."
-    priority: 11
-  pre-commit-black:
-    command: "black ."
-    priority: 10
-```
-
-## 自定义
-
-### 自定义行长度
-```toml
-# pyproject.toml
-[tool.black]
-line-length = 100
-```
-
-### 仅格式化特定目录
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black src/ tests/"
-    include: ["src/**/*.py", "tests/**/*.py"]
-```
-
-### 检查模式（不写入）
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black --check --diff ."
-    failOnUnformatted: true
-```
-
-## Error Handling
-
-- **Formatting applied**: Python files are automatically formatted and commit continues
-- **Syntax errors**: Commit is blocked with Python syntax error details
-- **Timeout**: Hook fails after 30 seconds
-- **Missing Black**: Hook is skipped with installation instructions
-- **Permission errors**: Hook fails with file access error details
-
-## 错误处理
-
-- **应用格式化**: Python 文件自动格式化并继续提交
-- **语法错误**: 阻止提交并显示 Python 语法错误详情
-- **超时**: 30 秒后钩子失败
-- **缺少 Black**: 跳过钩子并显示安装说明
-- **权限错误**: 钩子失败并显示文件访问错误详情
-
-## Advanced Configuration
-
-### Jupyter Notebook Support
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black --include '\.pyi?$|\.ipynb$' ."
-```
-
-### Multiple Python Versions
-```toml
-# pyproject.toml
-[tool.black]
-target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
-```
-
-### Preview Features
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black --preview ."
-```
-
-## 高级配置
-
-### Jupyter Notebook 支持
-```yaml
-hooks:
-  pre-commit-black:
-    command: "black --include '\.pyi?$|\.ipynb$' ."
-```
-
-### 多个 Python 版本
-```toml
-# pyproject.toml
-[tool.black]
-target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
-```
-
-## Performance Tips
-
-### Use .gitignore for Exclusions
-Black automatically respects `.gitignore` files, so large directories like `node_modules/` or `venv/` are automatically excluded.
-
-### Format Only Changed Files
-```bash
-# Use with pre-commit framework for better performance
-pip install pre-commit
-```
-
-## 性能提示
-
-### 使用 .gitignore 进行排除
-Black 自动遵循 `.gitignore` 文件，因此像 `node_modules/` 或 `venv/` 这样的大目录会自动排除。
-
-### 仅格式化更改的文件
-```bash
-# 使用 pre-commit 框架获得更好的性能
-pip install pre-commit
-```

package/templates/hooks/pre-commit-eslint.md

@@ -1,153 +0,0 @@
----
-id: pre-commit-eslint
-type: PreToolUse
-name: ESLint Pre-commit Hook
-description: Automatically run ESLint with auto-fix before git commits
-priority: 10
-matcher: Bash(git commit *)
-command: npx eslint --fix .
-timeout: 30000
-enabled: true
-applicableTo: [typescript, javascript, react, vue, node]
----
-
-# ESLint Pre-commit Hook
-
-## Description
-
-This hook automatically runs ESLint with the `--fix` flag before every git commit, ensuring code quality and consistent formatting. It will attempt to automatically fix linting issues and prevent commits if unfixable errors remain.
-
-## 描述
-
-此钩子在每次 git 提交前自动运行 ESLint 并使用 `--fix` 标志，确保代码质量和一致的格式。它会尝试自动修复 lint 问题，如果存在无法修复的错误则阻止提交。
-
-## When it runs
-
-- **Trigger**: Before any `git commit` command
-- **Condition**: When ESLint configuration is detected (`.eslintrc.*` or `eslint` in package.json)
-- **Scope**: Runs on all staged files
-
-## 运行时机
-
-- **触发器**: 任何 `git commit` 命令之前
-- **条件**: 检测到 ESLint 配置时（`.eslintrc.*` 或 package.json 中的 `eslint`）
-- **范围**: 在所有暂存文件上运行
-
-## Configuration
-
-### Prerequisites
-```bash
-# Install ESLint if not already installed
-npm install --save-dev eslint
-
-# Initialize ESLint configuration
-npx eslint --init
-```
-
-### Custom ESLint Configuration
-```json
-// .eslintrc.json
-{
-  "extends": ["@antfu/eslint-config"],
-  "rules": {
-    "no-console": "warn",
-    "no-unused-vars": "error"
-  }
-}
-```
-
-### Hook Configuration
-```yaml
-# In your CCJK configuration
-hooks:
-  pre-commit-eslint:
-    enabled: true
-    command: "npx eslint --fix ."
-    timeout: 30000
-    failOnError: true
-```
-
-## 配置
-
-### 前置条件
-```bash
-# 如果尚未安装 ESLint，请安装
-npm install --save-dev eslint
-
-# 初始化 ESLint 配置
-npx eslint --init
-```
-
-### 自定义 ESLint 配置
-```json
-// .eslintrc.json
-{
-  "extends": ["@antfu/eslint-config"],
-  "rules": {
-    "no-console": "warn",
-    "no-unused-vars": "error"
-  }
-}
-```
-
-## Customization
-
-### Skip Hook for Specific Commits
-```bash
-# Skip all pre-commit hooks
-git commit --no-verify -m "emergency fix"
-
-# Or use environment variable
-SKIP_HOOKS=true git commit -m "skip hooks"
-```
-
-### Custom Command Override
-```yaml
-hooks:
-  pre-commit-eslint:
-    command: "npx eslint --fix --ext .js,.ts,.vue src/"
-    include: ["src/**/*"]
-    exclude: ["dist/**/*", "node_modules/**/*"]
-```
-
-### Integration with Staged Files Only
-```yaml
-hooks:
-  pre-commit-eslint:
-    command: "npx lint-staged"
-    # Requires lint-staged configuration in package.json
-```
-
-## 自定义
-
-### 跳过特定提交的钩子
-```bash
-# 跳过所有预提交钩子
-git commit --no-verify -m "紧急修复"
-
-# 或使用环境变量
-SKIP_HOOKS=true git commit -m "跳过钩子"
-```
-
-### 自定义命令覆盖
-```yaml
-hooks:
-  pre-commit-eslint:
-    command: "npx eslint --fix --ext .js,.ts,.vue src/"
-    include: ["src/**/*"]
-    exclude: ["dist/**/*", "node_modules/**/*"]
-```
-
-## Error Handling
-
-- **Auto-fixable errors**: Automatically fixed and commit continues
-- **Non-fixable errors**: Commit is blocked with error details
-- **Timeout**: Hook fails after 30 seconds
-- **Missing ESLint**: Hook is skipped with warning
-
-## 错误处理
-
-- **可自动修复的错误**: 自动修复并继续提交
-- **不可修复的错误**: 阻止提交并显示错误详情
-- **超时**: 30 秒后钩子失败
-- **缺少 ESLint**: 跳过钩子并显示警告

package/templates/hooks/pre-commit-gofmt.md

@@ -1,284 +0,0 @@
----
-id: pre-commit-gofmt
-type: PreToolUse
-name: Go Format Pre-commit Hook
-description: Automatically format Go code with gofmt before git commits
-priority: 10
-matcher: Bash(git commit *)
-command: gofmt -w .
-timeout: 30000
-enabled: true
-applicableTo: [go, golang]
----
-
-# Go Format Pre-commit Hook
-
-## Description
-
-This hook automatically runs `gofmt` to format Go code before every git commit. Go's official formatter ensures consistent code formatting across all Go projects with zero configuration.
-
-## 描述
-
-此钩子在每次 git 提交前自动运行 `gofmt` 格式化 Go 代码。Go 的官方格式化工具确保所有 Go 项目的代码格式一致，无需任何配置。
-
-## When it runs
-
-- **Trigger**: Before any `git commit` command
-- **Condition**: When Go files (`.go`) are detected in the project
-- **Scope**: Runs on all Go files in the project recursively
-
-## 运行时机
-
-- **触发器**: 任何 `git commit` 命令之前
-- **条件**: 在项目中检测到 Go 文件（`.go`）时
-- **范围**: 递归地在项目中所有 Go 文件上运行
-
-## Configuration
-
-### Prerequisites
-```bash
-# Go should be installed with gofmt included
-go version
-
-# Verify gofmt is available
-gofmt -h
-```
-
-### Basic Hook Configuration
-```yaml
-# In your CCJK configuration
-hooks:
-  pre-commit-gofmt:
-    enabled: true
-    command: "gofmt -w ."
-    timeout: 30000
-    recursive: true
-```
-
-### Go Module Structure
-```
-project/
-├── go.mod
-├── go.sum
-├── main.go
-├── cmd/
-│   └── app/
-│       └── main.go
-├── internal/
-│   ├── handler/
-│   │   └── handler.go
-│   └── service/
-│       └── service.go
-└── pkg/
-    └── utils/
-        └── utils.go
-```
-
-## 配置
-
-### 前置条件
-```bash
-# 应该安装 Go，其中包含 gofmt
-go version
-
-# 验证 gofmt 可用
-gofmt -h
-```
-
-### 基本钩子配置
-```yaml
-# 在您的 CCJK 配置中
-hooks:
-  pre-commit-gofmt:
-    enabled: true
-    command: "gofmt -w ."
-    timeout: 30000
-    recursive: true
-```
-
-## Customization
-
-### Format Specific Directories Only
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "gofmt -w ./cmd ./internal ./pkg"
-    include: ["cmd/**/*.go", "internal/**/*.go", "pkg/**/*.go"]
-```
-
-### Check Format Without Writing
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "gofmt -d ."
-    failOnUnformatted: true
-    description: "Check Go formatting without modifying files"
-```
-
-### Use goimports Instead
-```yaml
-hooks:
-  pre-commit-goimports:
-    command: "goimports -w ."
-    priority: 10
-    description: "Format Go code and organize imports"
-```
-
-### Combine with Other Go Tools
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "gofmt -w ."
-    priority: 12
-  pre-commit-goimports:
-    command: "goimports -w ."
-    priority: 11
-  pre-commit-golint:
-    command: "golangci-lint run --fix"
-    priority: 10
-```
-
-### Exclude Generated Files
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "find . -name '*.go' -not -path './vendor/*' -not -name '*_gen.go' -exec gofmt -w {} +"
-    exclude: ["vendor/**/*", "*_gen.go", "*.pb.go"]
-```
-
-## 自定义
-
-### 仅格式化特定目录
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "gofmt -w ./cmd ./internal ./pkg"
-    include: ["cmd/**/*.go", "internal/**/*.go", "pkg/**/*.go"]
-```
-
-### 检查格式而不写入
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "gofmt -d ."
-    failOnUnformatted: true
-    description: "检查 Go 格式而不修改文件"
-```
-
-### 使用 goimports 替代
-```yaml
-hooks:
-  pre-commit-goimports:
-    command: "goimports -w ."
-    priority: 10
-    description: "格式化 Go 代码并整理导入"
-```
-
-## Error Handling
-
-- **Formatting applied**: Go files are automatically formatted and commit continues
-- **Syntax errors**: Commit is blocked with Go syntax error details
-- **Timeout**: Hook fails after 30 seconds
-- **Missing gofmt**: Hook is skipped with Go installation instructions
-- **Permission errors**: Hook fails with file access error details
-
-## 错误处理
-
-- **应用格式化**: Go 文件自动格式化并继续提交
-- **语法错误**: 阻止提交并显示 Go 语法错误详情
-- **超时**: 30 秒后钩子失败
-- **缺少 gofmt**: 跳过钩子并显示 Go 安装说明
-- **权限错误**: 钩子失败并显示文件访问错误详情
-
-## Advanced Configuration
-
-### Integration with Go Modules
-```yaml
-hooks:
-  pre-commit-go-mod-tidy:
-    command: "go mod tidy"
-    priority: 13
-  pre-commit-gofmt:
-    command: "gofmt -w ."
-    priority: 12
-  pre-commit-go-vet:
-    command: "go vet ./..."
-    priority: 11
-```
-
-### Custom gofmt Options
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "gofmt -s -w ."  # -s flag simplifies code
-    description: "Format and simplify Go code"
-```
-
-### Cross-Platform Compatibility
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: |
-      if command -v gofmt >/dev/null 2>&1; then
-        gofmt -w .
-      else
-        echo "gofmt not found, please install Go"
-        exit 1
-      fi
-```
-
-## 高级配置
-
-### 与 Go Modules 集成
-```yaml
-hooks:
-  pre-commit-go-mod-tidy:
-    command: "go mod tidy"
-    priority: 13
-  pre-commit-gofmt:
-    command: "gofmt -w ."
-    priority: 12
-  pre-commit-go-vet:
-    command: "go vet ./..."
-    priority: 11
-```
-
-### 自定义 gofmt 选项
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "gofmt -s -w ."  # -s 标志简化代码
-    description: "格式化并简化 Go 代码"
-```
-
-## Performance Tips
-
-### Use Go Build Cache
-```bash
-# Enable Go build cache for faster operations
-export GOCACHE=$(go env GOCACHE)
-```
-
-### Parallel Processing for Large Projects
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "find . -name '*.go' -not -path './vendor/*' | xargs -P 4 -I {} gofmt -w {}"
-    description: "Format Go files in parallel"
-```
-
-## 性能提示
-
-### 使用 Go 构建缓存
-```bash
-# 启用 Go 构建缓存以加快操作速度
-export GOCACHE=$(go env GOCACHE)
-```
-
-### 大型项目的并行处理
-```yaml
-hooks:
-  pre-commit-gofmt:
-    command: "find . -name '*.go' -not -path './vendor/*' | xargs -P 4 -I {} gofmt -w {}"
-    description: "并行格式化 Go 文件"
-```