メインコンテンツまでスキップ

設定

設定ファイル

設定ファイルは、適用するルールやオプションを指定するためのものです。通常、自動で読み込みされますが、CLIやAPIを使うことで明示的に期待通りの設定ファイルを読み込めます。

自動読み込みは、ターゲットが存在するディレクトリから再帰的に検索していきます。つまり、各ターゲットに最も近い設定ファイルを適用します。

📂 A
├── 📄 .markuplintrc # ①
└── 📂 B
├── 📄 index.html # <- ① A/.markuplintrc が適用される
└── 📂 C
├── 📄 index.html # <- ① A/.markuplintrc が適用される
└── 📂 D
├── 📄 .markuplintrc # ②
└── 📄 index.html # <- ② A/B/C/D/.markuplintrc が適用される
注記

Markuplintは、最も近いファイルを見つけると検索を中止します。ESLintのデフォルトとは異なりますESLint{ "root": true }と指定したときと同じ動作です。

設定ファイルをより上位のレイヤーに適用したい場合は、extendsフィールドを指定します。

ファイル形式とファイル名

ファイル名は.markuplintrcでなくても適用できます。

優先的に適用されるファイル名は以下のとおりです。

  • markuplintプロパティ(package.json内)
  • .markuplintrc.json
  • .markuplintrc.yaml
  • .markuplintrc.yml
  • .markuplintrc.js
  • .markuplintrc.cjs
  • markuplint.config.js
  • markuplint.config.cjs

.markuplintrcのフォーマットはJSON(コメント対応)かYAML形式となります。