prettier-plugin-lint-md

why？

Prettier 3.0 有许多变动，其中有一条将不会自动在中英文符号插入空格提高可读性。

alt text

虽然从使用群体来说 Prettier 这个决定没有什么问题，不过确实也会导致编写起来会存在很多不便，所有就有了这个插件。

还有一些其他讨论： Markdown: Add an option to re-enable Prettier 2.x's automatic space insertion in CJK

工作原理

lint-md 是检查中文 Markdown 编写格式的工具，让你的文档更加优雅规范。

它内置了许多检查：

alt text

具体配置就是阮一峰写的中文技术文档的写作规范

这个插件就是结合 Prettier 让你在编写的过程中实时修订错误。

编写 markdown  => 发现问题 => lint-md 修订 => prettier 格式化 => 输出

使用

npm i prettier-plugin-lint-md prettier -D
# or
yarn add prettier-plugin-lint-md prettier -D
# pnpm
pnpm add prettier-plugin-lint-md prettier -D

在 Prettier 支持的配置文件，例如 .prettierrc.mjs

export default {
  // ...
  plugins: [`prettier-plugin-lint-md`],
};

上面的配置是 prettier 3.0 的配置，对于低版本的 prettier 不太清楚上面配置是否有效。如果需要导入 cjs 模板的可以使用 prettier-plugin-lint-md/dist/prettier-plugin-lint-md.cjs。

Node 调用

import prettierPluginLintMd, { PARSER_NAME } from 'prettier-plugin-lint-md';
import { format } from 'prettier';

const result = await format(code, {
  parser: PARSER_NAME,
  plugins: [prettierPluginLintMd],
});

更多示例可以参考 __test__ 目录。

默认 import 导入的是 es 模块，但是 cjs 模块也是在构建列表中，如果想要使用，可以通过下面的形式导入。

const prettierPluginLintMd = require('prettier-plugin-lint-md/dist/prettier-plugin-lint-md.cjs');
// prettierPluginLintMd 有可能需要结合 prettierPluginLintMd.default 来使用，具体看构建工具实现。
// 具体参考 [rollupjs.org/configuration-options](https://rollupjs.org/configuration-options/#output-exports)

配置

初始情况下开箱即用，如果需要对规则细致调整可以继续往下阅读。

lint-md 支持 .lintmdrc JSON 配置文件，prettier-plugin-lint-md 同样也支持，默认情况下会自动启用 .lintmdrc 文件内的配置。

如果想启用其他文件名称可以在配置文件传递 configFile 字段。

// .prettierrc.mjs
export default {
  // ...
  plugins: [`prettier-plugin-lint-md`],
  configFile: '.lintmdrc',
};

configFile 可以是一个绝对路径也可以是相对路径，如果是相对路径会根据根目录来计算，如果绝对路径则直接启用。

具体配置项

完整配置项内容点击查看

alt text

之后在 .prettierrc.mjs 写入需要调整的配置项即可，例如禁止 中文与英文之间需要增加空格

// .prettierrc.mjs
export default {
  // ...
  plugins: [`prettier-plugin-lint-md`],
  'space-around-alphabet': false,
};

不过需要额外注意两点：

1. 除了 configFile 其他都是 boolean，虽然规则值本身是 0, 1, 2 这样的字段 alt text 但是这些是 CLI 中使用的，在 prettier 中不需要警告，只需要修复所以是 true 和 false 。

2. 不支持 no-long-code，因为不支持自动修复，所以没必要存在。

configFile 配置会被手动传递的规则覆盖。

协议

MIT License

lint-md / prettier-plugin

readme

prettier-plugin-lint-md

工作原理

使用

Node 调用

配置

具体配置项

协议