textlint

项目介绍：textlint

什么是 textlint？

textlint 是一个可插拔的文本和 Markdown 校验工具，设计灵感来源于 ESLint，但专注于自然语言的检查。它允许开发者通过自定义规则和插件来解析和校验多种文本格式。

项目特点

• 无内置规则：textlint 本身不附带任何规则。用户可以根据需要，通过 npm 安装所需的校验规则，例如使用命令 npm install textlint-rule-xxx。
• 多格式支持：默认支持 Markdown 和纯文本，通过插件可以支持 HTML 和其他文件格式。
• 灵活的输出格式：支持自定义格式化器和格式化器捆绑包，以便将校验结果以不同形式呈现。

快速上手

想快速了解 textlint 的使用，用户可以查看其“快速入门”指南。安装 textlint 可以通过以下命令完成：

$ npm install textlint --save-dev

安装要求：

• 需要 Node.js 16 及以上版本。

textlint 推荐在本地安装。如果使用全局安装，需在对应的全局环境中安装每一个规则。

使用方法

textlint 不带任何默认规则。用户可以通过 .textlintrc.json 配置文件来运行 textlint。下面是一个快速入门示例：

1. 安装 textlint 和一个校验规则：

npm install --save-dev textlint textlint-rule-no-todo

2. 通过以下命令创建 .textlintrc.json 文件：

npx textlint --init

这个配置文件可以如下配置：

{
    "rules": {
        "no-todo": true
    }
}

3. 使用 textlint 校验文件：

npx textlint ./README.md

插件支持

textlint 支持通过插件扩展，如支持 HTML 的 textlint-plugin-html 插件。要支持新格式，只需安装相关插件并在 .textlintrc.json 文件中添加即可。

示例：

npm install textlint-plugin-html --save-dev

配置文件中添加插件：

{
    "plugins": [
        "html"
    ]
}

可修复的错误

部分规则是可使用 --fix 命令自动修复的：

npx textlint --fix README.md

对修复结果可以使用干运行模式 --dry-run 查看修正的差异：

npx textlint --fix --dry-run --format diff README.md

集成与扩展

textlint 可以与多种应用和编辑器集成，例如：

• 应用程序：standalone 的跨平台应用 textlint-app，无需 Node.js 环境。
• 构建系统插件：如 gulp 和 Grunt。
• 编辑器支持：Atom、SublimeText、Vim、VS Code 以及浏览器插件等。

参与贡献

如有 bug 或功能请求，可以在 GitHub 上创建问题报告。textlint 欢迎任何形式的贡献，详细信息请参考其贡献指南。

许可证

textlint 在 MIT 许可下发布，部分代码来自 ESLint。