为每个项目配置Atom的linter-markdown包的规则?

时间:2018-04-05 09:52:49

标签: markdown atom-editor

我正在使用Atom中的linter-markdown包来编写整洁的Markdown。

通常我更喜欢将包选项remark-preset-lint-markdown-style-guide激活。它会根据Ciro Santilli的Markdown Style Guide将规则预设linter-markdown添加到支票中。

但有时,例如在使用Slate时,外部因素迫使我打破一两个严格的Markdown风格指南规则。

对于这些情况,我希望能够手动停用这些规则,但仅适用于特定项目

.remarkrc使用支持remark-lint.remarkrc configuration file

如果我将包含以下内容的.remarkrc文件放在与相关Markdown文件相同的目录中,那么它确实会被选中。但是,随后出现了一个致命的错误,也就是如下所示。

{ "plugins": [ "remark-preset-lint-markdown-style-guide", ["no-multiple-toplevel-headings", false] ] }

Error: Could not find module `remark-preset-lint-markdown-style-guide`...

错误:

linter-markdown

是否有人知道根据每个项目自定义.Format.Fill Atom包的订单规则的好方法

2 个答案:

答案 0 :(得分:1)

我遇到了同样的问题,将.remarkrc文件放在我的主目录中。似乎要么:

  • 来自GitHub上的remarkjs/remark-lint页面的代码片段,因此您认为它是正确的,不包括查找基本文件(remark-preset-lint-recommended)所需的配置,或< / LI>
  • 基本文件已被删除或重命名。

在任何一种情况下,删除对基本文件的引用,以便代码段显示为:

{
  "plugins": [
    ["remark-lint-list-item-indent", false]
  ]
}

克服了我的直接问题 - 我不再标记每个列表项。我猜测linter-markdown有一组默认值从某个地方拉出来 - 大概是根据设置复选框。

编辑:经过更多的探索后,我在NPM page for installing the base file找到了一个引用。遵循这些说明也会使错误消失,但不是非常整齐 - 包安装在当前目录中。我在某种程度上通过安装在我的主目录中解决了这个问题,但那是一个很好的问题。它确实在那里找到了。显然,这里有更多要理解的内容,linter-markdown似乎使用不同的方法来设置默认值。

答案 1 :(得分:0)

我在markdown项目的根目录中有此配置,并且似乎工作正常:

{
  "plugins": [
    "remark-lint"
  ],
  "settings": {
    "commonmark": true,
    "blockquote-indentation": "2",
    "checkbox-character-style": {
      "checked": "x",
      "unchecked": " "
    },
    "code-block-style": "fenced",
    "heading-style": "atx",
    "list-item-spacing": false,
    "no-html": false,
    "no-shortcut-reference-link": true,
    "no-undefined-references": true,
    "ordered-list-marker-value": "ordered",
    "rule-style": "---",
    "unordered-list-marker-style": "-",
    "maximum-line-length": "120"
  }
}