问题描述
remark-lint是用JS编写的Markdown短毛绒。如果提供了一套不错的规则。 codacy也使用此工具来检查上载的存储库中是否存在警告和错误。
我的存储库在Markdown中包含一个Apache许可证,但是不幸的是,许可证的编写者没有咨询和编辑者来检查印刷错误,例如“标题后无点”(因为这不是一句话!)。无论如何,remark-lint现在在抱怨,但是如果我更改文档,那将不再是Apache许可。 (请参阅有关GitHub使用的许可证检测工具的讨论。他们拒绝Markdown文件是相同的。)
我的问题是:如何配置remark-lint以忽略文件或更好的以忽略每个文件/目录的规则。
我了解到:
但是它并没有说明如何像用户linters一样禁用每个文件的内联或每个配置的规则。
解决方法
由于remark-lint
是备注插件it uses the same configuration files:
remark-lint是一个 remark 插件,在CLI上使用时,可通过其configuration files
支持配置
备注的配置文件之一是.remarkignore
。我认为一个.remarkignore
文件包含
path/to/license.md
或
path/to/license/directory/
可以解决问题。
忽略文件的格式与
.gitignore
要为每个目录配置特定规则,请尝试在要更改规则的目录中放置一个.remarkrc
文件。
注意:请注意上面第一句中的“在CLI上使用时”位。如果您通过其JavaScript API使用remark-lint
,则可能无法正常工作。