给项目添加批处理的命令行工具

Author: yyle88

.github/workflows/release.yml

@@ -0,0 +1,118 @@
+name: create-release
+
+on:
+  push:
+    branches:
+      - main  # 监听 main 分支的 push 操作（编译和测试/代码检查）
+    tags:
+      - 'v*'  # 监听以 'v' 开头的标签的 push 操作（发布 Release）
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+          cache: true
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v8
+        with:
+          version: latest
+          args: --timeout=5m
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        go: [ "1.22.x", "1.23.x", "1.24.x", "stable" ]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ matrix.go }}
+          cache: true
+
+      - name: Run govulncheck
+        uses: golang/govulncheck-action@v1
+        with:
+          go-version-input: ${{ matrix.go }}
+          go-package: ./...
+        continue-on-error: true  # 报错时允许工作流继续执行，因为项目依赖的底层包也会有错，很难做到百分百没问题，只打印检测结果就行
+
+      - name: Run test
+        run: make test COVERAGE_DIR=/tmp/coverage
+
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results-${{ matrix.go }}
+          path: /tmp/coverage/
+          retention-days: 30
+
+      - name: Send goveralls coverage
+        uses: shogo82148/actions-goveralls@v1
+        with:
+          path-to-profile: /tmp/coverage/combined.txt
+          flag-name: Go-${{ matrix.go }}
+          parallel: true
+        if: ${{ github.event.repository.fork == false }}  # 仅在非 fork 时上传覆盖率
+
+  check-coverage:
+    name: Check coverage
+    needs: [ test ]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: shogo82148/actions-goveralls@v1
+        with:
+          parallel-finished: true
+        if: ${{ github.event.repository.fork == false }}  # 仅在非 fork 时检查覆盖率
+
+  # 代码质量分析
+  code-analysis:
+    name: CodeQL Analysis
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: go
+
+      - name: Auto Build
+        uses: github/codeql-action/autobuild@v3
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+
+  # 发布 Release
+  release:
+    name: Release a new version
+    needs: [ lint, test, check-coverage, code-analysis ]
+    runs-on: ubuntu-latest
+    # 仅在推送标签时执行 - && - 仅在非 fork 时执行发布
+    if: ${{ github.event.repository.fork == false && success() && startsWith(github.ref, 'refs/tags/v') }}
+    steps:
+      # 1. 检出代码
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # 获取完整历史用于生成更好的 release notes
+
+      # 2. 创建 Release 和上传源码包
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Makefile

@@ -0,0 +1,10 @@
+COVERAGE_DIR ?= .coverage.out
+
+# cp from: https://github.com/yyle88/gormrepo/blob/c31435669714611c9ebde6975060f48cd5634451/Makefile#L4
+test:
+	@if [ -d $(COVERAGE_DIR) ]; then rm -r $(COVERAGE_DIR); fi
+	@mkdir $(COVERAGE_DIR)
+	make test-with-flags TEST_FLAGS='-v -race -covermode atomic -coverprofile $$(COVERAGE_DIR)/combined.txt -bench=. -benchmem -timeout 20m'
+
+test-with-flags:
+	@go test $(TEST_FLAGS) ./...

README.md

@@ -1,30 +1,47 @@
+[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/go-xlan/clang-format/release.yml?branch=main&label=BUILD)](https://github.com/go-xlan/clang-format/actions/workflows/release.yml?query=branch%3Amain)
+[![GoDoc](https://pkg.go.dev/badge/github.com/go-xlan/clang-format)](https://pkg.go.dev/github.com/go-xlan/clang-format)
+[![Coverage Status](https://img.shields.io/coveralls/github/go-xlan/clang-format/main.svg)](https://coveralls.io/github/go-xlan/clang-format?branch=main)
+[![Supported Go Versions](https://img.shields.io/badge/Go-1.22-lightgrey.svg)](https://go.dev/)
+[![GitHub Release](https://img.shields.io/github/release/go-xlan/clang-format.svg)](https://github.com/go-xlan/clang-format/releases)
+[![Go Report Card](https://goreportcard.com/badge/github.com/go-xlan/clang-format)](https://goreportcard.com/report/github.com/go-xlan/clang-format)
+
 # clang-format
 
-Go wrapper for clang-format with Protocol Buffers formatting capabilities.
+Go package for clang-format with Protocol Buffers and C/C++ batch formatting capabilities.
 
 ---
 
+<!-- TEMPLATE (EN) BEGIN: LANGUAGE NAVIGATION -->
 ## CHINESE README
 
 [中文说明](README.zh.md)
+<!-- TEMPLATE (EN) END: LANGUAGE NAVIGATION -->
 
 ## Key Features
 
-🎯 **Intelligent Proto Formatting**: Smart clang-format wrapper with Google style defaults  
-⚡ **Dual Operation Modes**: Both preview (DryRun) and in-place formatting support  
+🎯 **Intelligent Proto Formatting**: Smart clang-format package with Google style defaults  
+⚡ **Two Operation Modes**: Both preview (DryRun) and in-place formatting support  
 🔄 **Batch Processing**: Recursive project-wide .proto file formatting  
 🌍 **Configurable Styles**: Customizable formatting styles with JSON configuration  
 📋 **Comprehensive Logging**: Detailed operation logs with structured output
 
-## Install
+## Installation
+
+### Get the Package
 
 ```bash
-go install github.com/go-xlan/clang-format@latest
+go get github.com/go-xlan/clang-format@latest
+```
+
+### Get CLI Command
+
+```bash
+go install github.com/go-xlan/clang-format/cmd/clang-format-batch@latest
 ```
 
 ## Prerequisites
 
-Install clang-format on your system:
+Setup clang-format as requirement:
 
 ```bash
 # macOS
@@ -37,7 +54,25 @@ sudo apt-get install clang-format
 clang-format --version
 ```
 
-## Usage
+## Quick Start
+
+### Command Line Usage
+
+```bash
+# Format all .proto files in current project
+clang-format-batch --extensions=".proto"
+
+# Format C/C++ files
+clang-format-batch --extensions=".c,.cpp,.h"
+
+# Format multiple file types
+clang-format-batch --extensions=".proto,.c,.cpp,.h"
+
+# Use short flag
+clang-format-batch -e ".proto,.cc,.hh"
+```
+
+## Library Usage
 
 ### Protocol Buffers Formatting (Primary Use Case)
 
@@ -97,7 +132,7 @@ must.Done(clangformat.Format(execConfig, "example.cpp", style))
 
 - `NewStyle()` - Creates default Google-based style configuration
 - `DryRun(config, path, style)` - Preview formatting without file modification
-- `Format(config, path, style)` - Apply formatting directly to file
+- `Format(config, path, style)` - Use formatting on file
 
 ### protoformat Package
 
@@ -111,13 +146,14 @@ must.Done(clangformat.Format(execConfig, "example.cpp", style))
 ```go
 type Style struct {
     BasedOnStyle                string // "Google", "LLVM", "Chromium", etc.
-    IndentWidth                 int    // Number of spaces for indentation
+    IndentWidth                 int    // Count of spaces for indentation
     ColumnLimit                 int    // Maximum line length (0 = no limit)
-    AlignConsecutiveAssignments bool   // Align assignments at equal signs
+    AlignConsecutiveAssignments bool   // Align assignments at assignment signs
 }
 ```
 
 <!-- TEMPLATE (EN) BEGIN: STANDARD PROJECT FOOTER -->
+<!-- VERSION 2025-09-06 04:53:24.895249 +0000 UTC -->
 
 ## 📄 License
 
@@ -132,26 +168,26 @@ Contributions are welcome! Report bugs, suggest features, and contribute code:
 - 🐛 **Found a bug?** Open an issue on GitHub with reproduction steps
 - 💡 **Have a feature idea?** Create an issue to discuss the suggestion
 - 📖 **Documentation confusing?** Report it so we can improve
-- 🚀 **Need new features?** Share your use cases to help us understand requirements
-- ⚡ **Performance issue?** Help us optimize by reporting slow operations
+- 🚀 **Need new features?** Share the use cases to help us understand requirements
+- ⚡ **Performance issue?** Help us optimize through reporting slow operations
 - 🔧 **Configuration problem?** Ask questions about complex setups
-- 📢 **Follow project progress?** Watch the repo for new releases and features
-- 🌟 **Success stories?** Share how this package improved your workflow
-- 💬 **General feedback?** All suggestions and comments are welcome
+- 📢 **Follow project progress?** Watch the repo to get new releases and features
+- 🌟 **Success stories?** Share how this package improved the workflow
+- 💬 **Feedback?** We welcome suggestions and comments
 
 ---
 
 ## 🔧 Development
 
 New code contributions, follow this process:
 
-1. **Fork**: Fork the repo on GitHub (using the webpage interface).
+1. **Fork**: Fork the repo on GitHub (using the webpage UI).
 2. **Clone**: Clone the forked project (`git clone https://github.com/yourname/repo-name.git`).
 3. **Navigate**: Navigate to the cloned project (`cd repo-name`)
 4. **Branch**: Create a feature branch (`git checkout -b feature/xxx`).
-5. **Code**: Implement your changes with comprehensive tests
+5. **Code**: Implement the changes with comprehensive tests
 6. **Testing**: (Golang project) Ensure tests pass (`go test ./...`) and follow Go code style conventions
-7. **Documentation**: Update documentation for user-facing changes and use meaningful commit messages
+7. **Documentation**: Update documentation to support client-facing changes and use significant commit messages
 8. **Stage**: Stage changes (`git add .`)
 9. **Commit**: Commit changes (`git commit -m "Add feature xxx"`) ensuring backward compatible code
 10. **Push**: Push to the branch (`git push origin feature/xxx`).
@@ -163,7 +199,7 @@ Please ensure tests pass and include relevant documentation updates.
 
 ## 🌟 Support
 
-Welcome to contribute to this project by submitting pull requests and reporting issues.
+Welcome to contribute to this project via submitting merge requests and reporting issues.
 
 **Project Support:**
 
@@ -172,7 +208,7 @@ Welcome to contribute to this project by submitting pull requests and reporting
 - 📝 **Write tech blogs** about development tools and workflows - we provide content writing support
 - 🌟 **Join the ecosystem** - committed to supporting open source and the (golang) development scene
 
-**Happy Coding with this package!** 🎉
+**Have Fun Coding with this package!** 🎉
 
 <!-- TEMPLATE (EN) END: STANDARD PROJECT FOOTER -->
 

README.zh.md

@@ -1,28 +1,47 @@
+[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/go-xlan/clang-format/release.yml?branch=main&label=BUILD)](https://github.com/go-xlan/clang-format/actions/workflows/release.yml?query=branch%3Amain)
+[![GoDoc](https://pkg.go.dev/badge/github.com/go-xlan/clang-format)](https://pkg.go.dev/github.com/go-xlan/clang-format)
+[![Coverage Status](https://img.shields.io/coveralls/github/go-xlan/clang-format/main.svg)](https://coveralls.io/github/go-xlan/clang-format?branch=main)
+[![Supported Go Versions](https://img.shields.io/badge/Go-1.22-lightgrey.svg)](https://go.dev/)
+[![GitHub Release](https://img.shields.io/github/release/go-xlan/clang-format.svg)](https://github.com/go-xlan/clang-format/releases)
+[![Go Report Card](https://goreportcard.com/badge/github.com/go-xlan/clang-format)](https://goreportcard.com/report/github.com/go-xlan/clang-format)
+
 # clang-format
 
-clang-format 的 Go 封装工具，专为 Protocol Buffers 格式化而设计。
+clang-format 的 Go 封装工具，支持 Protocol Buffers 和 C/C++ 批量格式化功能。
+
+---
 
+<!-- TEMPLATE (ZH) BEGIN: LANGUAGE NAVIGATION -->
 ## 英文文档
 
 [ENGLISH README](README.md)
+<!-- TEMPLATE (ZH) END: LANGUAGE NAVIGATION -->
 
 ## 核心特性
 
-🎯 **智能 Proto 格式化**: 智能的 clang-format 包装器，默认使用 Google 样式  
-⚡ **双重操作模式**: 支持预览（DryRun）和就地格式化两种模式  
+🎯 **智能 Proto 格式化**: 智能的 clang-format 包，默认使用 Google 样式  
+⚡ **两种操作模式**: 支持预览（DryRun）和就地格式化两种模式  
 🔄 **批量处理**: 递归的项目级 .proto 文件格式化  
 🌍 **可配置样式**: 支持 JSON 配置的自定义格式化样式  
 📋 **全面日志**: 详细的操作日志和结构化输出
 
 ## 安装
 
+### 获取包
+
+```bash
+go get github.com/go-xlan/clang-format@latest
+```
+
+### 获取 CLI 命令
+
 ```bash
-go install github.com/go-xlan/clang-format@latest
+go install github.com/go-xlan/clang-format/cmd/clang-format-batch@latest
 ```
 
 ## 前置要求
 
-在系统中安装 clang-format：
+作为必要条件配置 clang-format：
 
 ```bash
 # macOS
@@ -35,7 +54,25 @@ sudo apt-get install clang-format
 clang-format --version
 ```
 
-## 使用方法
+## 快速开始
+
+### 命令行使用
+
+```bash
+# 格式化当前项目中的所有 .proto 文件
+clang-format-batch --extensions=".proto"
+
+# 格式化 C/C++ 文件
+clang-format-batch --extensions=".c,.cpp,.h"
+
+# 格式化多种文件类型
+clang-format-batch --extensions=".proto,.c,.cpp,.h"
+
+# 使用短标志
+clang-format-batch -e ".proto,.cc,.hh"
+```
+
+## 库使用方法
 
 ### Protocol Buffers 格式化（主要功能）
 
@@ -116,6 +153,7 @@ type Style struct {
 ```
 
 <!-- TEMPLATE (ZH) BEGIN: STANDARD PROJECT FOOTER -->
+<!-- VERSION 2025-09-06 04:53:24.895249 +0000 UTC -->
 
 ## 📄 许可证类型
 
@@ -135,7 +173,7 @@ MIT 许可证。详见 [LICENSE](LICENSE)。
 - 🔧 **配置困扰？** 询问复杂设置的相关问题
 - 📢 **关注进展？** 关注仓库以获取新版本和功能
 - 🌟 **成功案例？** 分享这个包如何改善工作流程
-- 💬 **意见反馈？** 欢迎所有建议和宝贵意见
+- 💬 **反馈意见？** 欢迎提出建议和意见
 
 ---
 
@@ -170,7 +208,7 @@ MIT 许可证。详见 [LICENSE](LICENSE)。
 - 📝 **撰写博客**关于开发工具和工作流程 - 我们提供写作支持
 - 🌟 **加入生态** - 致力于支持开源和（golang）开发场景
 
-**使用这个包快乐编程！** 🎉
+**使用这个包编程快乐！** 🎉
 
 <!-- TEMPLATE (ZH) END: STANDARD PROJECT FOOTER -->