zco-claude 0.0.8__py3-none-any.whl

ClaudeSettings/rules/go/.golangci.yml.template

@@ -0,0 +1,170 @@
+# golangci-lint 配置模板
+# 将此文件复制到项目根目录并重命名为 .golangci.yml
+
+run:
+  # 超时时间
+  timeout: 5m
+
+  # 要检查的目录
+  tests: true
+
+  # 要跳过的目录
+  skip-dirs:
+    - vendor
+    - third_party
+    - testdata
+    - examples
+    - .*
+
+# 启用的 linters
+linters:
+  enable:
+    # 基础检查
+    - gofmt          # 代码格式检查
+    - goimports      # import 顺序检查
+    - govet          # go vet 静态分析
+    - errcheck       # 错误检查
+    - staticcheck    # 静态分析
+    - unused         # 未使用代码检查
+    - gosimple       # 简化建议
+    - ineffassign    # 无效赋值检查
+    - typecheck      # 类型检查
+
+    # 代码质量
+    - gocyclo        # 圈复杂度检查
+    - funlen         # 函数长度检查
+    - gocognit       # 认知复杂度检查
+
+    # 错误处理
+    - goerr113       # 错误处理检查
+    - wrapcheck      # 错误包装检查
+
+    # 性能
+    - prealloc       # slice 预分配检查
+
+    # 风格
+    - stylecheck     # 代码风格检查
+    - revive         # golint 替代品
+
+    # 注释
+    - godot          # 注释格式检查
+    - godox          # TODO/FIXME 检查
+
+    # 安全
+    - gosec          # 安全检查
+
+  disable:
+    - deadcode       # 已被 unused 替代
+    - varcheck       # 已被 unused 替代
+    - structcheck    # 已被 unused 替代
+
+# Linters 配置
+linters-settings:
+  # 圈复杂度检查
+  gocyclo:
+    min-complexity: 10
+
+  # 函数长度检查
+  funlen:
+    lines: 50
+    statements: 40
+
+  # 认知复杂度检查
+  gocognit:
+    min-complexity: 15
+
+  # 错误检查
+  errcheck:
+    check-blank: true        # 检查 _ = err
+    check-type-assertions: true
+
+  # go vet 配置
+  govet:
+    check-shadowing: true
+    enable-all: true
+
+  # 注释格式检查
+  godot:
+    scope: declarations
+    capital: true
+
+  # TODO/FIXME 检查（允许使用 //; 前缀的注释）
+  godox:
+    keywords:
+      - TODO
+      - FIXME
+      - HACK
+      - OPTIMIZE
+      - DEPRECATED
+      - NOTE
+
+  # 安全检查
+  gosec:
+    severity: medium
+    confidence: medium
+    excludes:
+      - G104  # 允许未检查的错误（errcheck 会处理）
+
+  # 代码风格检查
+  stylecheck:
+    checks: ["all", "-ST1000", "-ST1003"]
+
+  # Revive 配置
+  revive:
+    confidence: 0.8
+    rules:
+      - name: exported
+        severity: warning
+      - name: unexported-return
+        severity: warning
+      - name: time-naming
+        severity: warning
+
+# Issues 配置
+issues:
+  # 排除规则
+  exclude-rules:
+    # 测试文件允许更长的函数
+    - path: _test\.go
+      linters:
+        - funlen
+        - gocyclo
+        - gocognit
+
+    # 允许在测试中使用点导入
+    - path: _test\.go
+      text: "should not use dot imports"
+
+    # 允许在 main.go 中使用全局变量
+    - path: cmd/.*main\.go
+      linters:
+        - gochecknoglobals
+
+    # 允许特定的 TODO/FIXME 注释（使用 //; 前缀 和 //@ 前缀）
+    - linters:
+        - godox
+      source: "//;"
+
+  # 最大 issues 数量（0 表示无限制）
+  max-issues-per-linter: 0
+  max-same-issues: 0
+
+  # 不排除新代码的 issues
+  new: false
+
+  # 显示所有 issues
+  exclude-use-default: false
+
+# 输出配置
+output:
+  # 输出格式：colored-line-number, line-number, json, tab, checkstyle
+  format: colored-line-number
+
+  # 打印 linter 名称
+  print-linter-name: true
+
+  # 使问题输出唯一
+  uniq-by-line: false
+
+  # 排序方式
+  sort-results: true

ClaudeSettings/rules/go/GoBuildAutoVersion.v250425.md

@@ -0,0 +1,95 @@
+# GoBuild  动态编译版本管理
+
+## 说明
+go释放的二进制文件, 应该自携带版本信息
+
+## 实现步骤
+
+#### 1.  定义全局变量并绑定到  flag
+
+将版本信息变量声明为包级变量：
+
+```go
+package main
+
+import flag
+import fmt
+import os
+
+var (
+	xBuildDesc string
+	AppName    string = "{AppName}"
+	GitCommit  string = "unset" // 默认 Commit，编译时覆盖
+	GitBranch  string = "unset" // 默认 分支，编译时覆盖
+	BuildTime  string = "unset" // 默认构建时间，编译时覆盖
+	CI_JOB_URL string = "unset" // 默认 CI Job URL，编译时覆盖
+)
+
+func co_parse_flag() {
+    //@NOTE: 绑定版本信息到 flag, 注意 flag.Parse() 只能执行一次
+    versionFlag := flag.Bool("version", false, "Print version and exit")
+	verboseFlag := flag.Bool("show-info", false, "Print verbose info and exit")
+    helpFlag := flag.Bool("h", false, "Display this help message")
+    flag.Parse()
+
+	if *versionFlag {
+		fmt.Fprint(os.Stdout, version)
+		os.Exit(0)
+	}
+
+	xBuildDesc := fmt.Sprintf(" AppName: %s \n Version: %s \n CommitID: %s \n Branch: %s \n BuildTime: %s \n CI_JOB_URL:%s \n",
+		AppName, version, GitCommit, GitBranch, BuildTime, CI_JOB_URL,
+	)
+
+	if *verboseFlag {
+		fmt.Fprint(os.Stdout, xBuildDesc)
+		os.Exit(0)
+	}
+
+    if *helpFlag {
+		flag.Usage()
+		os.Exit(0)
+	}
+}
+
+func main(){
+    //; 如果有其他自定义的 flag 配置需要前置
+    //flag.StringVar(&configFilePath, "c", "conf/app.conf", "Path to config file")
+    //; 注意 flag.Parse() 全局只能执行一次
+    co_parse_flag()
+
+    //; 后续是原业务逻辑代码
+}
+```
+
+#### 2.  编译时动态注入值
+
+在编译命令中使用  `-ldflags`  覆盖全局变量值：(Makefile), 参考如下是
+
+```Makefile
+DIST_GitCommit ?= $(shell git rev-parse --short HEAD 2>/dev/null || echo "commit_id")
+DIST_GitBranch ?= $(shell git rev-parse --abbrev-ref HEAD 2>/dev/null || echo "branch")
+DIST_CI_JOB_URL ?= $(shell echo ${CI_JOB_URL:-"unset"})
+# DIST_BuildTime := $(shell date +'%Y-%m-%dT%H%M%S%Z')
+DIST_BuildTime := $(shell date +'%Y%m%d_%H%M%S')
+DIST_AppName := "AppName"
+
+build:
+	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags="-s -w \
+    -X 'main.GitCommit=${DIST_GitCommit}' \
+    -X 'main.GitBranch=${DIST_GitBranch}' \
+    -X 'main.BuildTime=${DIST_BuildTime}' \
+	-X 'main.CI_JOB_URL=${DIST_CI_JOB_URL}' " \
+    -o ${BINARY}
+#    // ...  自定义更多的参数
+```
+
+- **效果**：`Version`、`GitCommit`、`BuildTime`  会被编译时注入的值覆盖。
+
+#### 3.  测试
+
+```shell
+make build
+./{BINARY} -version
+./{BINARY} -show-info
+```

ClaudeSettings/rules/go/check-standards.sh

@@ -0,0 +1,128 @@
+#!/bin/bash
+
+# Go 编程标准检查脚本
+
+set -e
+
+echo "🔍 开始检查 Go 编程标准..."
+echo ""
+
+# 颜色定义
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+YELLOW='\033[1;33m'
+NC='\033[0m' # No Color
+
+FAILED=0
+
+# 1. 检查代码格式
+echo "📝 [1/7] 检查代码格式..."
+if ! gofmt -l . | grep -q ".go"; then
+    echo -e "${GREEN}✓ 代码格式正确${NC}"
+else
+    echo -e "${RED}✗ 以下文件格式不正确:${NC}"
+    gofmt -l .
+    FAILED=1
+fi
+echo ""
+
+# 2. 检查 imports
+echo "📦 [2/7] 检查 imports 顺序..."
+if command -v goimports &> /dev/null; then
+    if ! goimports -l . | grep -q ".go"; then
+        echo -e "${GREEN}✓ Imports 顺序正确${NC}"
+    else
+        echo -e "${RED}✗ 以下文件 imports 顺序不正确:${NC}"
+        goimports -l .
+        FAILED=1
+    fi
+else
+    echo -e "${YELLOW}⚠ goimports 未安装，跳过检查${NC}"
+fi
+echo ""
+
+# 3. 运行测试
+echo "🧪 [3/7] 运行测试..."
+if go test ./... -v; then
+    echo -e "${GREEN}✓ 所有测试通过${NC}"
+else
+    echo -e "${RED}✗ 测试失败${NC}"
+    FAILED=1
+fi
+echo ""
+
+# 4. 检查测试覆盖率
+echo "📊 [4/7] 检查测试覆盖率..."
+COVERAGE=$(go test ./... -cover -coverprofile=coverage.out 2>&1 | grep "coverage:" | awk '{sum+=$NF; count++} END {if (count>0) print sum/count; else print 0}' | sed 's/%//')
+
+if [ -z "$COVERAGE" ]; then
+    echo -e "${YELLOW}⚠ 无法计算覆盖率${NC}"
+else
+    if (( $(echo "$COVERAGE >= 80" | bc -l) )); then
+        echo -e "${GREEN}✓ 测试覆盖率: ${COVERAGE}% (≥ 80%)${NC}"
+    else
+        echo -e "${RED}✗ 测试覆盖率: ${COVERAGE}% (< 80%)${NC}"
+        FAILED=1
+    fi
+fi
+echo ""
+
+# 5. 检查竞态条件
+echo "🏃 [5/7] 检查竞态条件..."
+if go test -race ./... > /dev/null 2>&1; then
+    echo -e "${GREEN}✓ 无竞态条件${NC}"
+else
+    echo -e "${RED}✗ 检测到竞态条件${NC}"
+    FAILED=1
+fi
+echo ""
+
+# 6. 运行 linter
+echo "🔍 [6/7] 运行 linter..."
+if command -v golangci-lint &> /dev/null; then
+    if golangci-lint run ./...; then
+        echo -e "${GREEN}✓ Linter 检查通过${NC}"
+    else
+        echo -e "${RED}✗ Linter 检查失败${NC}"
+        FAILED=1
+    fi
+else
+    echo -e "${YELLOW}⚠ golangci-lint 未安装，跳过检查${NC}"
+    echo "   安装命令: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b \$(go env GOPATH)/bin"
+fi
+echo ""
+
+# 7. 检查注释规范
+echo "💬 [7/7] 检查注释规范..."
+echo "   查找所有功能注释 (//@NOTE:):"
+
+# 统计各类非代码注释
+TODO_COUNT=$(grep -r "TODO:" . --include="*.go" 2>/dev/null | wc -l || echo 0)
+FIXME_COUNT=$(grep -r "FIXME:" . --include="*.go" 2>/dev/null | wc -l || echo 0)
+HACK_COUNT=$(grep -r "HACK:" . --include="*.go" 2>/dev/null | wc -l || echo 0)
+DEPRECATED_COUNT=$(grep -r "DEPRECATED:" . --include="*.go" 2>/dev/null | wc -l || echo 0)
+
+echo "   - TODO: $TODO_COUNT 项"
+echo "   - FIXME: $FIXME_COUNT 项"
+echo "   - HACK: $HACK_COUNT 项"
+echo "   - DEPRECATED: $DEPRECATED_COUNT 项"
+
+if [ "$FIXME_COUNT" -gt 0 ]; then
+    echo -e "${YELLOW}   ⚠ 有 $FIXME_COUNT 个 FIXME 需要修复${NC}"
+fi
+
+if [ "$DEPRECATED_COUNT" -gt 0 ]; then
+    echo -e "${YELLOW}   ⚠ 有 $DEPRECATED_COUNT 个废弃代码需要清理${NC}"
+fi
+
+echo ""
+
+# 8. 总结
+echo "================================"
+if [ $FAILED -eq 0 ]; then
+    echo -e "${GREEN}✓ 所有检查通过！${NC}"
+    exit 0
+else
+    echo -e "${RED}✗ 检查失败，请修复上述问题${NC}"
+    exit 1
+fi