如何忽略 remark-lint 的文件?

How to ignore files for remark-lint?

remark-lint 是一个用 JS 编写的 Markdown linter。如果提供了一套很好的规则。 Codacy 还使用此工具来检查上传的存储库是否存在警告和错误。

我的存储库包含 Markdown 中的 Apache 许可证,但不幸的是,许可证的编写者没有咨询和编辑来检查印刷错误,例如“标题后没有点”(因为它不是句子!)。无论如何,remark-lint 现在在抱怨,但如果我更改文档,它就不再是 Apache 许可证了。 (参见有关许可证检测工具的讨论,例如 GitHub 使用的工具。他们拒绝 Markdown 文件相同。)

我的问题是:如何配置 remark-lint 忽略文件 或更好 忽略每个 file/directory.

的规则

我阅读了:

但它没有说明如何像用户 linters 那样禁用内联规则或每个文件的每个配置。

由于remark-lint是一个备注插件it uses the same configuration files:

remark-lint is a remark plugin and when used on the CLI supports configuration through its configuration files

remark 的配置文件之一是.remarkignore。我认为 .remarkignore 文件包含类似

的内容
path/to/license.md

path/to/license/directory/

会成功的。

The format for ignore files is the same as .gitignore

要配置特定规则 per-directory,请尝试将 .remarkrc 文件放入要更改其规则的目录中。


警告:请注意上面第一个引用中的“在 CLI 上使用时”位。如果您通过 JavaScript API 使用 remark-lint,这可能不起作用。