【问题标题】:How to ignore files for remark-lint?如何忽略 remark-lint 的文件?
【发布时间】:2020-12-24 09:33:33
【问题描述】:

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

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

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

我读到了:

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

【问题讨论】:

    标签: markdown lint remarkjs


    【解决方案1】:

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

    remark-lint 是一个 remark 插件,在 CLI 上使用时支持通过其configuration files进行配置

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

    path/to/license.md
    

    path/to/license/directory/
    

    会成功的。

    忽略文件格式同.gitignore

    要为每个目录配置特定规则,请尝试将.remarkrc 文件放入您要更改其规则的目录中。


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

    【讨论】:

    • 根据我的测试:.remarkignore 未被 remark-lint 读取。
    猜你喜欢
    • 2021-12-22
    • 2019-05-26
    • 1970-01-01
    • 2018-11-06
    • 2014-02-02
    • 2019-08-22
    • 2012-07-15
    • 2015-01-29
    • 1970-01-01
    相关资源
    最近更新 更多