@lint-md/cli

English | 简体中文

@lint-md/cli 是 Lint Markdown 的命令行工具，用于检查和修复中文 Markdown 文档中的格式问题。

项目定位

• 面向对象：中文技术文档、博客、知识库等 Markdown 内容。
• 核心能力：批量扫描、规则校验、自动修复（--fix）、CI 失败拦截。
• 运行方式：本包提供 CLI；规则引擎由 @lint-md/core 提供。

上下游关系

• 上游（依赖）：@lint-md/core（规则定义与 lint/fix 能力）。
• 当前仓库职责：参数解析、文件收集、并行执行、结果汇总与退出码控制。
• 下游（使用方）：文档仓库、写作流水线、CI/CD（如 GitHub Actions）中调用 lint-md。

安装

npm i -D @lint-md/cli

或全局安装：

npm i -g @lint-md/cli

快速开始

# 检查单个文件
lint-md README.md

# 检查目录内所有 Markdown 文件
lint-md "docs/**/*.md"

# 自动修复
lint-md "docs/**/*.md" --fix

Docker 使用

先构建镜像：

docker build -t lint-md .

只读检查场景：

docker run --rm \
  -v "$PWD:/work:ro" \
  -w /work \
  lint-md "docs/**/*.md"

对挂载目录执行 --fix 时，建议显式传入当前用户，避免把宿主文件写成容器内用户的属主：

docker run --rm \
  -u "$(id -u):$(id -g)" \
  -v "$PWD:/work" \
  -w /work \
  lint-md "docs/**/*.md" --fix

镜像默认使用非 root 用户运行；如果挂载目录权限较严格，--user 是最稳妥的用法。

常用参数

• `-c, —config…