{"id":15967774,"url":"https://github.com/huacnlee/vscode-autocorrect","last_synced_at":"2025-05-07T06:04:09.913Z","repository":{"id":46170426,"uuid":"381433174","full_name":"huacnlee/vscode-autocorrect","owner":"huacnlee","description":"AutoCorrect for VS Code","archived":false,"fork":false,"pushed_at":"2023-09-07T12:02:45.000Z","size":328,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-07T06:04:05.352Z","etag":null,"topics":["auto-correct","formatter","vscode","vscode-extension"],"latest_commit_sha":null,"homepage":"https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/huacnlee.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-29T16:40:11.000Z","updated_at":"2024-09-19T06:44:39.000Z","dependencies_parsed_at":"2023-01-23T11:00:28.194Z","dependency_job_id":null,"html_url":"https://github.com/huacnlee/vscode-autocorrect","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fvscode-autocorrect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fvscode-autocorrect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fvscode-autocorrect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/huacnlee%2Fvscode-autocorrect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/huacnlee","download_url":"https://codeload.github.com/huacnlee/vscode-autocorrect/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823921,"owners_count":21809713,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["auto-correct","formatter","vscode","vscode-extension"],"created_at":"2024-10-07T18:41:24.647Z","updated_at":"2025-05-07T06:04:09.891Z","avatar_url":"https://github.com/huacnlee.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AutoCorrect for Visual Studio Code\n\n[AutoCorrect](https://github.com/huacnlee/autocorrect) 用于「自动纠正」或「检查并建议」文案，给 CJK（中文、日语、韩语）与英文混写的场景，补充正确的空格，同时尝试以安全的方式自动纠正标点符号等等。\n\n类似 ESlint、Rubocop、Gofmt 等工具，[AutoCorrect](https://github.com/huacnlee/autocorrect) 结合 VS Code，它提供 Lint 功能能便捷的检测出项目中有问题的文案，起到统一规范的作用。\n\n支持各种类型文件支持，能自动识别文件名，并准确找到字符串、注释做自动纠正。\n\n## Show case\n\n### Linter\n\n[AutoCorrect](https://github.com/huacnlee/autocorrect) 可以在打开文件或保存文件后，对当前文件做 Lint 检查，并用颜色标注出有问题的部分。\n\n\u003cimg width=\"900\" alt=\"huacnlee.autocorrect\" src=\"https://user-images.githubusercontent.com/5518/191890126-4e0c99dc-91ce-4262-a774-3813a636eea1.png\"\u003e\n\n### Quickfix\n\n\u003cimg width=\"900\" src=\"https://user-images.githubusercontent.com/5518/191890586-f184b798-9432-48e8-a7ff-92b5c9f8f230.gif\" /\u003e\n\n## 保存格式化\n\n当开启 FormatOnSave 的时候，保存文件会自动纠正有问题的部分。\n\n\u003e NOTE: 某些时候你不想触发保存格式化，可以用 `Save Without Formatting` 命令来保存。\n\n## 配置\n\n可以通过修改 `settings.json` 来配置，或者进入设置界面：\n\n```json2\n{\n  // 完全开启/关闭 AutoCorrect，默认: true\n  \"autocorrect.enable\": true,\n  // 开启/关闭 AutoCorrect Lint 检查，默认: true\n  \"autocorrect.enableLint\": true,\n  // 是否启用 formatOnSave，默认: true\n  \"autocorrect.formatOnSave\": true,\n}\n```\n\n### AutoCorrect 配置文件\n\n参见：https://github.com/huacnlee/autocorrect#configuration\n\n支持 `.autocorrectrc` 配置文件，详见默认配置：[.autocorrect.default](https://github.com/huacnlee/autocorrect/blob/main/autocorrect/.autocorrectrc.default)\n\n```yml\nrules:\n  # 0 - off, 1 - err, 2 - warning\n  spellcheck: 1\n# 配置忽略某些特殊的文本\ntextRules:\n  # 让 \"hello世界\" 这个遇到的时候仅仅给警告\n  hello世界: 2\n  # 忽略 \"hi你好\"\n  hi你好: 0\n# 配置文件类型关联\nfileTypes:\n  # \"rb\": ruby\n  # \"Rakefile\": ruby\n  # \"*.js\": javascript\n  # \".mdx\": markdown\n# 配置拼写检查\nspellcheck:\n  # 名字纠正（主要不要用常见的英文单词）\n  words:\n    - GitHub\n    - App Store\n    # This means \"appstore\" into \"App Store\"\n    - AppStore = App Store\n    - Git\n    - Node.js\n    - nodejs = Node.js\n    - VIM\n    - DNS\n    - HTTP\n    - SSL\n```\n\n## 临时禁用 AutoCorrect\n\n某些时候或某些特殊场景你可能不期望 AutoCorrect 纠正，例如：\n\n- 本身需要验证错误文案的场景；\n- AutoCorrect 存在没有覆盖正确的场景（尤其是正则）；\n\n你可以在项目根目录准备一个 `.autocorrectignore` 来告诉 AutoCorrect 那些文件需要忽略，用法和 `.gitignore` 类似，同时 AutoCorrect 默认也会忽略 `.gitignore` 匹配的文件。\n\n此外，你还可以采用 `autocorrect: false` 或 `autocorrect-disable` 在文件内部禁用某些行，当 AutoCorrect 检测到此标记，将会暂时停用，直到遇到下一个 `autocorrect: true` 或 `autocorrect-enable` 将会恢复。\n\n例如：\n\n```js\nfunction hello() {\n  // autocorrect: false\n  console.log('现在这行开始autocorrect会暂时禁用');\n  console.log('这行也是disable的状态');\n  // autocorrect: true\n  let a = '现在起autocorrect回到了启用的状态';\n}\n```\n\n当纠正以后，处于 `autocorrect: false` 和 `autocorrect: true` 的部分 AutoCorrect 不会处理。\n\n```js\nfunction hello() {\n  // autocorrect: false\n  console.log('现在这行开始autocorrect会暂时禁用');\n  console.log('这行也是disable的状态');\n  // autocorrect: true\n  let a = '现在起 autocorrect 回到了启用的状态';\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuacnlee%2Fvscode-autocorrect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhuacnlee%2Fvscode-autocorrect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhuacnlee%2Fvscode-autocorrect/lists"}