Textlint命令行工具使用完全指南

Textlint命令行工具使用完全指南

textlint The pluggable natural language linter for text and markdown. 项目地址: https://gitcode.com/gh_mirrors/te/textlint

Textlint作为一款强大的文本检查工具，其命令行接口(CLI)提供了丰富的功能选项。本文将全面介绍textlint CLI的使用方法，帮助开发者高效地进行文本质量检查。

基础使用

Textlint CLI需要Node.js环境支持。最基本的用法是直接检查指定文件：

npx textlint README.md

Textlint支持多种文件路径指定方式：

• 使用glob模式匹配多个文件（注意需要加引号）
• 直接指定目录路径

# 使用glob模式
npx textlint "docs/**/*.md"

# 检查整个目录
npx textlint docs/

核心功能选项

Textlint提供了丰富的命令行选项，可以通过textlint --help查看完整列表。以下是几个关键功能：

1. 自动修复

# 自动修复可修复的问题
textlint --fix README.md

# 仅显示修复结果而不实际修改文件
textlint --fix --dry-run README.md

2. 输出控制

# 指定输出格式（支持多种格式）
textlint -f json README.md

# 将结果输出到文件
textlint -o report.json README.md

# 仅显示错误信息（隐藏警告）
textlint --quiet README.md

3. 规则配置

# 指定自定义配置文件
textlint -c .textlintrc.json README.md

# 临时添加规则或插件
textlint --rule textlint-rule-no-todo README.md

高级用法

管道输入处理

Textlint支持通过标准输入接收文本内容，这在与其他工具配合使用时特别有用：

cat README.md | textlint --stdin --stdin-filename "README.md"

注意：使用管道输入时必须指定--stdin-filename参数，以便textlint正确识别文件类型。

缓存机制

对于大型项目，启用缓存可以显著提升检查速度：

# 启用缓存
textlint --cache README.md

# 指定自定义缓存位置
textlint --cache --cache-location .cache/textlintcache README.md

退出码说明

Textlint的退出码具有特定含义，可用于自动化流程控制：

• 0：检查通过或无错误
• 1：发现可修复或不可修复的文本问题
• 2：发生严重错误（如配置加载失败）

实用技巧

1. 快速初始化配置：使用--init选项可以快速生成配置文件
2. 调试模式：添加--debug参数可输出详细的调试信息
3. 实验性功能：--experimental参数可启用实验性特性
4. 多规则目录：通过--rulesdir可以指定额外的规则目录

通过熟练掌握这些命令行选项，开发者可以灵活地将textlint集成到各种开发流程中，实现高效的文本质量管控。

textlint The pluggable natural language linter for text and markdown. 项目地址: https://gitcode.com/gh_mirrors/te/textlint