AutoCorrect for Visual Studio Code

AutoCorrect 用于「自动纠正」或「检查并建议」文案，给 CJK（中文、日语、韩语）与英文混写的场景，补充正确的空格，同时尝试以安全的方式自动纠正标点符号等等。

类似 ESlint、Rubocop、Gofmt 等工具，AutoCorrect 结合 VS Code，它提供 Lint 功能能便捷的检测出项目中有问题的文案，起到统一规范的作用。

支持各种类型文件支持，能自动识别文件名，并准确找到字符串、注释做自动纠正。

Show case

Linter

AutoCorrect 可以在打开文件或保存文件后，对当前文件做 Lint 检查，并用颜色标注出有问题的部分。

Quickfix

保存格式化

当开启 FormatOnSave 的时候，保存文件会自动纠正有问题的部分。

NOTE: 某些时候你不想触发保存格式化，可以用 Save Without Formatting 命令来保存。

配置

可以通过修改 settings.json 来配置，或者进入设置界面：

{
  // 完全开启/关闭 AutoCorrect，默认: true
  "autocorrect.enable": true,
  // 开启/关闭 AutoCorrect Lint 检查，默认: true
  "autocorrect.enableLint": true,
  // 是否启用 formatOnSave，默认: true
  "autocorrect.formatOnSave": true,
}

AutoCorrect 配置文件

参见：https://github.com/huacnlee/autocorrect#configuration

支持 .autocorrectrc 配置文件，详见默认配置：.autocorrect.default

rules:
  # 0 - off, 1 - err, 2 - warning
  spellcheck: 1
# 配置忽略某些特殊的文本
textRules:
  # 让 "hello世界" 这个遇到的时候仅仅给警告
  hello世界: 2
  # 忽略 "hi你好"
  hi你好: 0
# 配置文件类型关联
fileTypes:
  # "rb": ruby
  # "Rakefile": ruby
  # "*.js": javascript
  # ".mdx": markdown
# 配置拼写检查
spellcheck:
  # 名字纠正（主要不要用常见的英文单词）
  words:
    - GitHub
    - App Store
    # This means "appstore" into "App Store"
    - AppStore = App Store
    - Git
    - Node.js
    - nodejs = Node.js
    - VIM
    - DNS
    - HTTP
    - SSL

临时禁用 AutoCorrect

某些时候或某些特殊场景你可能不期望 AutoCorrect 纠正，例如：

本身需要验证错误文案的场景；
AutoCorrect 存在没有覆盖正确的场景（尤其是正则）；

你可以在项目根目录准备一个 .autocorrectignore 来告诉 AutoCorrect 那些文件需要忽略，用法和 .gitignore 类似，同时 AutoCorrect 默认也会忽略 .gitignore 匹配的文件。

此外，你还可以采用 autocorrect: false 或 autocorrect-disable 在文件内部禁用某些行，当 AutoCorrect 检测到此标记，将会暂时停用，直到遇到下一个 autocorrect: true 或 autocorrect-enable 将会恢复。

例如：

function hello() {
  // autocorrect: false
  console.log('现在这行开始autocorrect会暂时禁用');
  console.log('这行也是disable的状态');
  // autocorrect: true
  let a = '现在起autocorrect回到了启用的状态';
}

当纠正以后，处于 autocorrect: false 和 autocorrect: true 的部分 AutoCorrect 不会处理。

function hello() {
  // autocorrect: false
  console.log('现在这行开始autocorrect会暂时禁用');
  console.log('这行也是disable的状态');
  // autocorrect: true
  let a = '现在起 autocorrect 回到了启用的状态';
}

AutoCorrect

Jason Lee