0

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

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

我的问题是:如何配置 remark-lint 以忽略文件或更好地忽略每个文件/目录的规则。

我读到:

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

4

1 回答 1

2

Since remark-lint is a remark plugin it uses the same configuration files:

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

One of remark's configuration files is .remarkignore. I think a .remarkignore file containing something like

path/to/license.md

or

path/to/license/directory/

will do the trick.

The format for ignore files is the same as .gitignore

To configure specific rules per-directory, try putting a .remarkrc file in the directory whose rules you wish to change.


Caveat: note the "when used on the CLI" bit in the first quote above. If you're using remark-lint via its JavaScript API this might not work.

于 2020-09-05T10:48:59.557 回答