autocorrect

AutoCorrect

> AutoCorrect 的愿景是提供一套标准化的文案校正方案。以便于在各类场景（例如：撰写书籍、文档、内容发布、项目源代码...）里面应用，让使用者轻松实现标准化、专业化的文案输出 / 校正。 AutoCorrect is a linter and formatter to help you to improve copywriting, correct spaces, words, and punctuations between CJK (Chinese, Japanese, Korean). Like Eslint, Rubocop and Gofmt ..., AutoCorrect allows us to check source code, and output as colorized diff with corrected suggestions. You can integrate to CI (GitLab CI, GitHub Action, Travis CI....) for use to check the contents in source code. Recognize the file name, and find out the strings and the comment part. AutoCorrect 是一个基于 Rust 编写的工具，用于「自动纠正」或「检查并建议」文案，给 CJK（中文、日语、韩语）与英文混写的场景，补充正确的空格，纠正单词，同时尝试以安全的方式自动纠正标点符号等等。 类似 ESlint、Rubocop、Gofmt 等工具，AutoCorrect 可以用于 CI 环境，它提供 Lint 功能，能便捷的检测出项目中有问题的文案，起到统一规范的作用。 支持各种类型源代码文件，能自动识别文件名，并准确找到字符串、注释做自动纠正。 > 此方案最早于 [2013 年](https://github.com/huacnlee/auto-correct/commit/47d7b7836f3e5f97dd31b5dc477eb0dbf8176e6b) 出现于 Ruby China 的项目，并逐步完善规则细节，当前准确率较高（极少数异常情况），你可以放心用来辅助你完成自动纠正动作。 ## Features - Add spacing between CJK (Chinese, Japanese, Korean) and English words. - Correct punctuations into full-width near the CJK. - Correct punctuations into half-width in English content. - (Experimental) Spellcheck and correct words with your dictionary. - Lint checking and output diff or JSON result, so you can integrate everywhere (GitLab CI, GitHub Action, VS Code, Vim, Emacs...) - Allows using `.gitignore` or `.autocorrectignore` to ignore files that you want to ignore. - Support more than [28 file types](https://github.com/huacnlee/autocorrect/tree/main/autocorrect/grammar) (Markdown, JSON, YAML, JavaScript, HTML ...), use AST parser to only check for strings, and comments. - LSP server: [autocorrect-lsp](https://github.com/huacnlee/autocorrect/tree/main/autocorrect-lsp) - Based on [typos](https://github.com/crate-ci/typos) for spellcheck (LSP only). - Cross-platform for Linux, macOS, Windows, and WebAssembly, and as Native SDK for programming (Node.js, JavaScript Browser, Ruby, Python, Java). ## 典型应用场景 - 撰写书籍、文档，新闻媒体等内容发布，应用于 Markdown、AsciiDoc、HTML 等文档场景，确保文案的标准化、专业化（案例：[MDN 项目](https://github.com/mdn/translated-content/pulls?q=is%3Apr+is%3Aclosed+author%3Ahuacnlee)、[少数派](https://sspai.com/search/post/AutoCorrect)）。 - 集成 GitLab CI、GitHub Action、Travis CI 等 CI 环境，需要对项目进行自动化检查。 - 集成到 Docusaurus、Hexo、Hugo、Jekyll、Gatsby 等静态网站生成器，在生成的时候自动格式化。 - 利用语言支持的 SDK 集成到应用程序，在存储或输出网站内容的时候格式化，提升网站品质（如：[Ruby China](https://ruby-china.org)、[V2EX](https://www.v2ex.com)、[Longbridge](https://longportapp.com/news)）。 - 作为 VS Code、Intellij Platform IDE（已支持）、Vim、Emacs (待实现) 插件，需要对文案进行检查（Linter & Formatter），依靠 LintResult 给出的（Annotator、Diagnostic）提示。 - 基于 [WebAssembly](https://www.npmjs.com/package/@huacnlee/autocorrect) 实现，作为 Chrome、Safari 等浏览器插件，应用于任何网站（待实现） - 也可以集成到 WYSIWYG Editor 里面，例如（ProseMirror、CKEditor、Slate、Draft.js、Tiptap、Monaco Editor、CodeMirror 等）。 ## Installation Install on macOS You can install it via [Homebrew](https://brew.sh): ```bash $ brew install autocorrect ``` Install on Windows You can install it via [Scoop](https://scoop.sh): ```bash $ scoop install autocorrect ``` Or you can just install it via this on Unix-like system: ```bash $ curl -sSL https://git.io/JcGER | sh ``` After that, you will get `autocorrect` command. ```bash $ autocorrect -V AutoCorrect 2.4.0 ``` Or install NPM: ```bash $ yarn add autocorrect-node $ yarn autocorrect -V ``` ## Upgrade > Since: 1.9.0 AutoCorrect allows you to upgrade itself by `autocorrect update` command. ```bash $ autocorrect update ``` > NOTE: This command need you input your password, because it will install bin into `/usr/local/bin` directory. ## Usage - [Use in CLI](#use-in-cli) - [Use in NPM](#use-in-npm) - [Configuration](#configuration) - [VS Code Extension](#vs-code-extension) - [Zed extension](https://github.com/huacnlee/zed-autocorrect) - [Intellij Platform Plugin](#intellij-platform-plugin) - [GitHub Action](#github-action) - [GitLab CI](#gitlab-ci) - [Work with ReviewDog](#work-with-reviewdog) - [Use for programming](#use-for-programming) ### Use in CLI ```bash $ autocorrect text.txt 你好 Hello 世界 $ echo "hello世界" | autocorrect --stdin hello 世界 $ autocorrect --fix text.txt $ autocorrect --fix zh-CN.yml $ autocorrect --fix ``` #### Lint ```bash $ autocorrect --lint --format json text.txt $ autocorrect --lint text.txt ``` ```diff Error: 1, Warning: 0 text.txt:1:3 -你好Hello世界 +你好 Hello 世界 ``` You also can lint multiple files: ```bash $ autocorrect --lint ``` How to lint all changed files in Git: ```bash $ git diff --name-only | xargs autocorrect --lint ``` ### Use in NPM > since: 2.7.0 AutoCorrect has been published in NPM with CLI command support. If you want to use it in Frontend or Node.js project, you can just install `autocorrect-node` package for without install AutoCorrect bin. ```bash cd your-project yarn add autocorrect-node ``` Now you can run `yarn autocorrect` command in your project. This command is same as `autocorrect` command. ```bash $ yarn autocorrect -h ``` More docs: [autocorrect-node/README.md](autocorrect-node/README.md) ### Configuration > Default config: [.autocorrect.default](https://github.com/huacnlee/autocorrect/blob/main/autocorrect/.autocorrectrc.default) ```bash $ autocorrect init AutoCorrect init config: .autocorrectrc ``` > NOTE: If you download fail, try to use `autocorrect init --local` command again. Now the `.autocorrectrc` file has been created. > .autocorrectrc is allows use YAML, JSON format. Config file example: ``` … ``` #### Ignore option > Since: 2.2.0 When you want to config some special words or texts to ignore on format or lint. The `textRules` config may help you. For example, we want: - `Hello世界` - To just give a warning. - `Hi你好` - To ignore. Use can config: ```yml textRules: Hello世界: 2 Hi你好: 0 ``` After that, AutoCorrect will follow your `textRules` to process. #### Ignore files **Use `.autocorrectignore` to ignore files** Sometimes, you may want to ignore some special files that not want to check. By default, the file matched `.gitignore` rule will be ignored. You can also use `.autocorrectignore` to ignore other files, format like `.gitignore`. #### Disable by inline comment If you just want to disable some special lines in a file, you can write a comment `autocorrect-disable`, when AutoCorrect matched the comment include that, it will disable temporarily. And then, you can use `autocorrect-enable` to reopen it again. For example, in JavaScript: ```js function hello() { // autocorrect-disable console.log("现在这行开始autocorrect会暂时禁用"); console.log("这行也是disable的状态"); // autocorrect-enable let a = "现在起autocorrect回到了启用的状态"; } ``` The output will: ```js function hello() { // autocorrect-disable console.log("现在这行开始autocorrect会暂时禁用"); console.log("这行也是disable的状态"); // autocorrect-enable let a = "现在起 autocorrect 回到了启用的状态"; } ``` #### Disable some rules > Since: 2.0 You can use `autocorrect-disable ` in a comment to disable some rules. > Rule names please see: [Configuration](#configuration) ```js function hello() { // autocorrect-disable space-word console.log("现在这行开始autocorrect会暂时禁用."); // autocorrect-disable fullwidth console.log("这行也是disable的状态."); // autocorrect-enable let a = "现在起autocorrect回到了启用的状态."; } ``` Will get: ```js function hello() { // autocorrect-disable space-word console.log("现在这行开始autocorrect会暂时禁用。"); // autocorrect-disable fullwidth, space-word console.log("这行也是disable的状态."); // autocorrect-enable let a = "现在起 autocorrect 回到了启用的状态。"; } ``` ### VS Code Extension https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect Screenshot: ### Intellij Platform Plugin https://github.com/huacnlee/autocorrect-idea-plugin ### GitHub Action https://github.com/huacnlee/autocorrect-action Add to your `.github/workflows/ci.yml` ```yml steps: - name: Check source code uses: actions/checkout@v4 - name: AutoCorrect uses: huacnlee/autocorrect-action@main ``` ### GitLab CI Add to your `.gitlab-ci.yml`, to use [huacnlee/autocorrect](https://hub.docker.com/r/huacnlee/autocorrect) Docker image to check. ```yml autocorrect: stage: build image: huacnlee/autocorrect:latest script: - autocorrect --lint # Enable allow_failure if you wants. # allow_failure: true ``` ### Work with ReviewDog > Since: 2.8.0 AutoCorrect can work with [reviewdog](https://github.com/reviewdog/reviewdog), so you can use it in CI/CD. ReviewDog will post a comment to your PR with the AutoCorrect change suggestions. Then the PR committer can easy to accept the suggestions. Use `--format rdjson` option to output the lint results as the [reviewdog](https://github.com/reviewdog/reviewdog) supported format. ```bash autocorrect --lint --format rdjson | reviewdog -f=rdjson -reporter=github-pr-review ``` Use [huacnlee/autocorrect-action](https://github.com/huacnlee/autocorrect-action) can help you setup GitHub Action. ### Use for programming AutoCorrect makes for support use in many programming languages. - Rust - [autocorrect](https://crates.io/crates/autocorrect) - Ruby - [autocorrect-rb](https://rubygems.org/gems/autocorrect-rb) - Go - [autocorrect-go](https://pkg.go.dev/github.com/longbridge/autocorrect) - Python - [autocorrect-py](https://pypi.org/project/autocorrect-py/) - Node.js - [autocorrect-node](https://www.npmjs.com/package/autocorrect-node) - JavaScript (Browser) - [autocorrect-wasm](https://www.npmjs.com/package/@huacnlee/autocorrect) - Java - [autocorrect-java](https://mvnrepository.com/artifact/io.github.huacnlee/autocorrect-java) ## Benchmark > MacBook Pro (13-inch, Apple M3, 2023) Use `make bench` to run benchmark tests. See [autocorrect/src/benches/example.rs](https://github.com/huacnlee/autocorrect/blob/main/autocorrect/src/benches/example.rs) for details. ``` … ``` ### Real world benchmark With [MDN Translated Content](https://github.com/mdn/translated-content) project, it has about 30K files. ```bash ~/work/translated-content $ autocorrect --fix AutoCorrect spend time: 8402.538ms ``` ## Other Extensions The other implementations from the community. - [prettier-plugin-autocorrect](https://github.com/un-ts/prettier/tree/master/packages/autocorrect) - [autocorrect-popclip](https://github.com/TomBener/autocorrect-popclip) - [autocorrect-markdown.vim](https://github.com/aisensiy/dotfiles/blob/master/nvim/after/ftplugin/markdown.vim) - [obsidian-autocorrect](https://github.com/b-yp/obsidian-autocorrect) ## User cases - [MDN Web Docs](https://developer.mozilla.org/zh-CN) - [Apache APISIX](https://apisix.apache.org/zh) - [Rust Book CN](https://kaisery.github.io/trpl-zh-cn) - [Ruby China](https://ruby-china.org) - [JuiceFS](https://juicefs.com) - [GreptimeDB](https://greptime.com) ## License This project under MIT license.