huacnlee/autocorrect

AutoCorrect for Rust

基于 Rust 编写的 CLI 工具，用于「自动纠正」或「检查并建议」文案，适用于 CJK（中文、日语、韩语）与英文混写场景，可自动补充正确空格、纠正标点符号。类似 ESLint、Rubocop、Gofmt 等工具，支持集成 CI 环境（GitLab CI、GitHub Action 等），能识别文件名并精准处理字符串及注释内容，确保项目文案规范统一。

VS Code 扩展

提供内置 VS Code 插件，安装后可实现「保存自动格式化」或「纠正提示」，完整集成开发流程。

插件地址：[***]

核心功能与特性

• 自动空格处理：在 CJK 与英文单词间自动添加空格
• 多文件类型支持：HTML、YAML、Rust、Go、SQL、Ruby、Python、Objective-C、Swift、Java、Kotlin、Dart、JavaScript、CSharp 等
• 字符转换：全角 [a-zA-Z0-9] 及时间中的「：」转换为半角
• 标点纠正：将 CJK 附近的标点符号转换为全角
• Lint 检查：支持输出 diff 或 JSON 结果，便于集成至各类环境（GitLab CI、GitHub Action、VS Code、Vim 等）
• 忽略机制：支持通过 .gitignore 或 .autocorrectignore 忽略指定文件

使用场景与适用范围

• 开发团队统一文案格式规范
• CI/CD 流程中自动检查代码注释及字符串文案
• 编辑器实时纠正文案格式
• 多语言项目中文案标准化处理

详细使用方法

Docker 部署与运行

拉取镜像

bash
docker pull huacnlee/autocorrect:latest

基本运行示例

检查文件（Lint）

bash
docker run --rm -v $(pwd):/app huacnlee/autocorrect autocorrect --lint /app/text.txt

自动修复文件

bash
docker run --rm -v $(pwd):/app huacnlee/autocorrect autocorrect --fix /app/text.txt

检查目录下所有文件

bash
docker run --rm -v $(pwd):/app huacnlee/autocorrect autocorrect --lint /app

Docker Compose 配置示例

yaml
version: '3'
services:
  autocorrect:
    image: huacnlee/autocorrect:latest
    volumes:
      - ./:/app  # 挂载当前目录到容器内/app
    command: autocorrect --lint /app  # 检查/app目录下所有文件

命令行工具（CLI）使用

基础命令

bash
# 查看帮助
autocorrect --help

# 检查文件并输出diff
autocorrect --lint text.txt

# 自动修复文件
autocorrect --fix text.txt

# 修复目录下所有文件
autocorrect --fix ./

# 输出JSON格式检查结果
autocorrect --lint --format json text.txt

Lint 输出示例

diff
  --> text.txt:1:3
- 你好Hello世界
+ 你好 Hello 世界

忽略文件配置

忽略规则文件

• 默认遵循 .gitignore 规则忽略文件
• 可创建 .autocorrectignore 文件（格式同 .gitignore）自定义忽略规则

文件内忽略标记

在文件顶部添加 autocorrect: false 可忽略整个文件：

js
// autocorrect: false
function hello() {
  console.log('这整个文件不会被autocorrect修改');
}

CI 集成

GitHub Action

在 .github/workflows/ci.yml 中添加：

yaml
steps:
  - name: Check source code
    uses: actions/checkout@main

  - name: AutoCorrect
    uses: huacnlee/autocorrect-action@main

GitLab CI

在 .gitlab-ci.yml 中添加：

yaml
autocorrect:
  stage: build
  image: huacnlee/autocorrect:latest
  script:
    - autocorrect --lint ./
  # 可选：允许失败
  # allow_failure: true

在 Rust 项目中使用

添加依赖

在 Cargo.toml 中添加：

toml
[dependencies]
autocorrect = "1.0.0"

代码示例

格式化纯文本

rust
extern crate autocorrect;

fn main() {
    println!("{}", autocorrect::format("长桥LongBridge App下载"));
    // => "长桥 LongBridge App 下载"

    println!("{}", autocorrect::format("需要符号?自动转换全角字符、数字:我们将在１６：３２分出发去ＣＢＤ中心."));
    // => "需要符号？自动转换全角字符、数字：我们将在 16:32 分出发去 CBD 中心。"
}

格式化 HTML 内容

rust
extern crate autocorrect;

fn main() {
    let html = r#"
    <article>
    <h1>这是Heading标题</h1>
    <div class="content">
    <p>你好Rust世界<strong>Bold文本</strong></p>
    </div>
    </article>
    "#;

    println!("{}", autocorrect::format_html(html));
    // <article>
    // <h1>这是 Heading 标题</h1>
    // <div class="content">
    //     <p>你好 Rust 世界<strong>Bold 文本</strong></p>
    // </div>
    // </article>
}

基准测试

文本格式化性能

TODO

• Vim 插件
• Git 提交信息格式化钩子
• 单行忽略功能

许可证

本项目基于 MIT 许可证开源。