More than 5 years have passed since last update.

Atomのlinter-markdownを.remarkrcで設定する方法

Last updated at 2017-08-26Posted at 2017-03-04

最初に結論から

Atomのlinter-markdownプラグインは、内部的にremark-lintを使っている
デフォルト設定のまま使うときは、システムへのremark-lintインストールは不要
設定ファイル名は.remarkrc(JSON)または.remarkrc.yaml(YAML)
設定ファイルを作った場合はシステムへのremark-lintインストールが必須
- プリセットのパッケージremark-preset-lint-consistentとremark-preset-lint-recommendedも同時にインストールする
- インストールはnpmを使ってローカル(.remarkrcと同じ階層)にインストール

インストールコマンドはこんな感じで。

% npm install remark-lint
% npm install remark-preset-lint-consistent
% npm install remark-preset-lint-recommended

JSONが好きな人は.remarkrcを作成

{
  "plugins": [
    "remark-preset-lint-consistent",
    "remark-preset-lint-recommended",
    ["remark-lint-list-item-indent", "space"],
    ["remark-lint-code-block-style", false],
    ["remark-lint-no-shortcut-reference-link", false]
  ]
}

YAMLが好きな人は.remarkrc.yamlを作成

plugins:
- remark-preset-lint-consistent
- remark-preset-lint-recommended
- # 箇条書きリストのインデントは(タブではなく)スペース
  - remark-lint-list-item-indent
  - space
- # Qiitaのコードブロックで警告が出ないように
  - remark-lint-code-block-style
  - false
- # Qiitaの注釈で警告が出ないように
  - remark-lint-no-shortcut-reference-link
  - false

同階層に.remarkrcと.remarkrc.yamlが両方存在した場合は両方有効になりますが、設定項目がかぶった場合はJSONの.remarkrcが優先されるようです。

バージョン組み合わせ

Atomのlinter-markdownパッケージのバージョンと、remark-lintのバージョンの組み合わせに要注意です。

この記事を投稿した2017/3/3時点では、linter-markdown 3.1.0がremark-lint 6.0.0に対応しておらず、古いremark-lintをインストールする必要がありました。2017/4/18時点ではlinter-markdownが4.0.0にバージョンアップしており、remark-lintの最新版で動く事を確認済みです。

バージョン組み合わせ	OK	NG	NG	NG	OK
linter-markdown	4.0.0	3.1.0	3.1.0	3.1.0	3.1.0
remark-lint	6.0.0	6.0.0	5.4.0	5.4.0	5.4.0
remark-preset-lint-consistent	2.0.0	2.0.0	2.0.0	1.0.0	1.0.0
remark-preset-lint-recommended	2.0.0	2.0.0	1.0.0	2.0.0	1.0.0

古いremark-lintのインストールコマンドと設定ファイルの記法も念のため残しておきます。特に設定ファイルの記法は最新版と違うので要注意。

古いバージョンのインストール

% npm install remark-lint@5.4.0
% npm install remark-preset-lint-consistent@1.0.0
% npm install remark-preset-lint-recommended@1.0.0

.remarkrc(古い記法)

{
  "presets": [
    "lint-consistent",
    "lint-recommended"
  ],
  "plugins": {
    "lint": {
      "list-item-indent": "space",
      "code-block-style": false,
      "no-shortcut-reference-link": false
    }
  }
}

.remarkrc.yaml(古い記法)

presets:
  - lint-consistent
  - lint-recommended
plugins:
  lint:
    list-item-indent: space
    code-block-style: false
    no-shortcut-reference-link: false

格闘記録(読み飛ばし可)

例のごとく、上記結論に至るまでの格闘記録を時系列で書きました。
興味があればどうぞ。

プロローグ

Markdown文章は今までMacDownで書いてたんですが、メインエディタのAtomに統一したいなーと思いまして、この記事とか参考に一通りMarkdown用のプラグインを入れました。
[さんざん悩んだマークダウンエディタの最終決定は「Atom」快適に使えるようにする設定と必須のパッケージ厳選18個]
(http://www.kotalog.net/archives/6038)

ついでならMarkdown用のLinterも入れようと思いlinter-markdownプラグインもインストールしたのですが、その設定でもう果てしなく果てしなくハマってしまいました。特に日本語の情報が少ない少ない。。。

AtomにもLinterにもNode.jsにもMarkdownにもまだ不慣れだったので、これを機に勉強がてらとことんハマって、日本語でQiita記事にまとめておく覚悟を決めたのでした。自分でQiitaに書いたこともなかったですし。

これは壮絶なるエラーとの格闘サーガ三部作、最終話となります！

Episode I: [Titaniumで自動インストールされたnodeやnpmが/usr/local配下に残っていた件] (http://qiita.com/the_red/items/aeee6d328995f557cfbf)
Episode II: [Homebrewでnodebrewのインストールに失敗した時の対処(Perl, CPAN絡み)] (http://qiita.com/the_red/items/fd04d97947b9b0bd7a57)
Anthology: [AtomのLinterでエラー内容をコピペできない時はGitHubの最新版をインストールしよう！] (http://qiita.com/the_red/items/ebbece2411f55450db72)
Episode III: Atomのlinter-markdownを.remarkrcで設定する方法 (本エントリ)