这是Heading标题
你好Rust世界Bold文本
这是第二行p标签
🎯 AutoCorrect 的愿景是提供一套标准化的文案较正方案。以便于在各类场景（例如：撰写书籍、文档、内容发布、项目源代码...）里面应用，让使用者轻松实现标准化、专业化的文案输出 / 校正。
AutoCorrect is a linter and formatter to help you to improve copywriting, correct spaces, words, punctuations between CJK (Chinese, Japanese, Korean).
Like Eslint, Rubocop, Gofmt ..., AutoCorrect allows us to check source code, and output as colorized diff with corrected suggest. You can integrate to CI (GitLab CI, GitHub Action, Travis CI....) for use to checking the contents in source code. Recognize the file name, and find out the strings and the comment part.
基于 Rust 编写的 CLI 工具，用于「自动纠正」或「检查并建议」文案，给 CJK（中文、日语、韩语）与英文混写的场景，补充正确的空格，纠正单词，同时尝试以安全的方式自动纠正标点符号等等。
类似 ESlint、Rubocop、Gofmt 等工具，AutoCorrect 可以用于 CI 环境，它提供 Lint 功能，能便捷的检测出项目中有问题的文案，起到统一规范的作用。
支持各种类型源代码文件，能自动识别文件名，并准确找到字符串、注释做自动纠正。
此方案最早于 2013 年 出现于 Ruby China 的项目，并逐步完善规则细节，当前准确率较高（极少数异常情况），你可以放心用来辅助你完成自动纠正动作。
Other implements for programming:
： in time)..gitignore or .autocorrectignore to ignore files that you want to ignore.
🍏 AutoCorrect 还为非技术人员提供了比较简单的桌面端版本，如有需要可访问 Download 页面来下载。
bash
$ curl -sSL https://git.io/JcGER | bash
After that, you will get /usr/local/bin/autocorrect command.
```bash
AutoCorrect 1.9.0
Jason Lee USAGE:
autocorrect [FLAGS] [OPTIONS] [file]... [SUBCOMMAND] FLAGS:
--debug Print debug message.
--type Directly use set file type.
--fix Automatically fix problems and rewrite file.
-h, --help Prints help information
--lint Lint and output problems.
-V, --version Prints version information OPTIONS:
-c, --config ARGS:
SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
init Init AutoCorrect config file.
update Update AutoCorrect to latest version.
``` After: 1.9.0 AutoCorrect allows you to upgrade itself by NOTE: This command need you input your password, because it will install bin into ```bash
$ autocorrect text.txt
你好 Hello 世界 $ autocorrect --fix text.txt
$ autocorrect --fix zh-CN.yml
$ autocorrect --fix
``` ```bash
$ autocorrect --lint --format json text.txt $ autocorrect --lint text.txt
``` You also can lint multiple files: NOTE: If you download fail, try to use Now the .autocorrectrc is allows use YAML, JSON format. Config file example: ```yml spellcheck:
# 0 - Disabled, 1 - Format and Lint, 2 - LintOnly
mode: 1
# Correct Words (Case insensitive) for by Spellcheck
words:
- GitHub
- App Store
# This means "appstore" into "App Store"
- AppStore = App Store
- Git
- Node.js
- nodejs = Node.js
- VIM
- DNS
- HTTP
- SSL
``` Use Sometimes, you may want to ignore some special files that not wants to check. By default, the file matched You can also use Disable with inline comment If you just want to disable some special lines in file, you can write a comment And then, you can use For example, in JavaScript: The output will: https://marketplace.visualstudio.com/items?itemName=huacnlee.auto-correct 内置 Visual Studio Code 插件，安装后会将 AutoCorrect 和 Visual Studio Code 完整集成，可以达到「保存自动格式化」或「纠正提示」。 如下图： https://github.com/marketplace/actions/huacnlee-autocorrect Add to your ```yml
steps:
- name: Check source code
uses: actions/checkout@main Add to your AutoCorrect also provide a JavaScript module via WebAssembly, you can use it in your JavaScript project. And then: ```js
const autocorrect = import('@huacnlee/autocorrect'); const raw = 你好 Hello 世界Upgrade
autocorrect update command.bash
$ autocorrect update
/usr/local/bin directory.Usage
Using CLI
Lint
diff
--> text.txt:1:3
- 你好Hello世界
+ 你好 Hello 世界
bash
$ autocorrect --lint
Configuration
bash
$ autocorrect init
Fetching https://github.com/huacnlee/autocorrect/raw/main/.autocorrectrc.template
AutoCorrect init config: .autocorrectrc
autocorrect init --local command again..autocorrectrc file has created.
Config for Speelcheck
Ignore option
.autocorrectignore to ignore files.gitignore rule will be ignored..autocorrectignore to ignore other files, format like .gitignore.autocorrect: false or autocorrect-disable,
when AutoCorrect matched comment include that, it will disable temporary.autocorrect: true or autocorrect-enable to reopen it again.js
function hello() {
console.log('现在这行开始autocorrect会暂时禁用');
console.log('这行也是disable的状态');
// autocorrect: true
let a = '现在起autocorrect回到了启用的状态';
}
js
function hello() {
console.log('现在这行开始autocorrect会暂时禁用');
console.log('这行也是disable的状态');
// autocorrect: true
let a = '现在起 autocorrect 回到了启用的状态';
}
VS Code Extension
GitHub Action
.github/workflows/ci.yml
GitLab CI
.gitlab-ci.yml, to use 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
Use for JavaScript
bash
yarn add @huacnlee/autocorrect
<p>你好Hello世界</p>;
autocorrect.then((autocorrect) => {
const out = autocorrect.formatHTML(raw);
// "
When you want use AutoCorrect in Node.js, you must install @huacnlee/autocorrect-node.
bash
yarn add @huacnlee/autocorrect-node
And then:
```js const autocorrect = require('@huacnlee/autocorrect-node');
autocorrect.format('你好Hello世界'); // "你好 Hello 世界" ```
In your Cargo.toml
toml
[dependencies]
autocorrect = "1.0.0"
Use autocorrect::format to format plain text.
````rust extern crate autocorrect;
fn main() { println!("{}", autocorrect::format("长桥LongBridge App下载")); // => "长桥 LongBridge App 下载"
println!("{}", autocorrect::format("Ruby 2.7版本第1次发布"));
// => "Ruby 2.7 版本第 1 次发布"
println!("{}", autocorrect::format("于3月10日开始"));
// => "于 3 月 10 日开始"
println!("{}", autocorrect::format("包装日期为2013年3月10日"));
// => "包装日期为 2013 年 3 月 10 日"
println!("{}", autocorrect::format("全世界已有数百家公司在生产环境中使用Rust，以达到快速、跨平台、低资源占用的目的。"));
// => "全世界已有数百家公司在生产环境中使用 Rust，以达到快速、跨平台、低资源占用的目的。"
println!("{}", autocorrect::format("既に、世界中の数百という企業がRustを採用し、高速で低リソースのクロスプラットフォームソリューションを実現しています。"));
// => "既に、世界中の数百という企業が Rust を採用し、高速で低リソースのクロスプラットフォームソリューションを実現しています。"
println!("{}", autocorrect::format("전 세계 수백 개의 회사가 프로덕션 환경에서 Rust를 사용하여 빠르고, 크로스 플랫폼 및 낮은 리소스 사용량을 달성했습니다."));
// => "전 세계 수백 개의 회사가 프로덕션 환경에서 Rust 를 사용하여 빠르고, 크로스 플랫폼 및 낮은 리소스 사용량을 달성했습니다."
println!("{}", autocorrect::format("需要符号?自动转换全角字符、数字:我们将在１６：３２分出发去ＣＢＤ中心.")
// => "需要符号？自动转换全角字符、数字：我们将在 16:32 分出发去 CBD 中心。"
```
Use autocorrect::format_html to format HTML content.
```rust extern crate autocorrect;
fn main() {
let html = r#"
你好Rust世界Bold文本 这是第二行p标签这是Heading标题
println!("{}", autocorrect::format_html(html));
// <article>
// <h1>这是 Heading 标题</h1>
// <div class="content">
// <p>你好 Rust 世界<strong>Bold 文本</strong></p>
// <p>这是第二行 p 标签</p>
// </div>
// </article>
} ````
MacBook Pro (13-inch, M1, 2020)
Use make bench to run benchmark tests.
See autocorrect/src/benches/example.rs for details.
bash
test bench_format_50 ... bench: 7,525 ns/iter (+/- 171)
test bench_format_100 ... bench: 13,586 ns/iter (+/- 304)
test bench_format_400 ... bench: 48,858 ns/iter (+/- 1,078)
test bench_format_html ... bench: 156,654 ns/iter (+/- 4,773)
test bench_format_javascript ... bench: 89,387 ns/iter (+/- 8,365)
test bench_format_json ... bench: 29,356 ns/iter (+/- 718)
test bench_format_json_with_2k_lines ... bench: 3,829,479 ns/iter (+/- 76,499)
test bench_markdown ... bench: 2,821,642 ns/iter (+/- 38,704)
test bench_spellcheck_50 ... bench: 37,371 ns/iter (+/- 844)
test bench_spellcheck_100 ... bench: 57,835 ns/iter (+/- 745)
test bench_spellcheck_400 ... bench: 195,606 ns/iter (+/- 2,996)
| Type | Total chars | Duration | | ---------- | ----------- | -------- | | format | 50 | 0.014 ms | | format | 100 | 0.019 ms | | format | 400 | 0.045 ms | | format | Markdown | 2.8 ms | | spellcheck | 50 | 0.037 ms | | spellcheck | 100 | 0.057 ms | | spellcheck | 400 | 0.195 ms |
With MDN Translated Content project, it's has about 30K files.
bash
~/work/translated-content $ autocorrect --fix
AutoCorrect spend time: 8402.538ms
This project under MIT license.