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

コマンドラインインターフェイス

使い方​

$ markuplint target.html
$ markuplint target.html target2.html
$ markuplint "**/*.html"

CLIはターゲットとなるHTMLファイルを可変長引数として受け取ります。また、glob形式も受け付けます。

成功した場合は終了コード0を返します。また、1つ以上の問題があった場合は1を返します。

オプション​

正規形オプション省略形オプション引数デフォルト値解説
--config-cファイルパスなし設定ファイルのパス
--fixなしなしfalseルールが対応していれば対象ファイルを修正します
--format-fJSON、Simple、GitHubもしくはStandardStandard出力形式
--no-search-configなしなしfalse設定ファイルを自動で検索しません
--ignore-extなしなしfalse拡張子の種類に関わらず受け取ったファイルを評価します
--no-import-preset-rulesなしなしfalse組み込みルールを利用しません
--localeなし言語コード（例：ja）OS設定によるメッセージの言語
--no-colorなしなしfalse出力をカラーリングしません
--problem-only-pなしfalse違反結果のみ出力します
--allow-warningsなしなしfalsewarningではステータスコード0を返します
--no-allow-empty-inputなしなしfalseファイルが見つからなかった場合にステータスコード1を返します
--show-confignone値なし, details値なし対象ファイルの適用された設定を出力します
--verboseなしなしfalse詳細な情報も同時に出力します
--include-node-modulesなしなしfalsenode_moduleディレクトリ内のファイルを含めて評価します
--severity-parse-errorなしerror、warningもしくはofferrorパースエラーの深刻度レベルを指定します
--max-countなし数値0表示する違反数を制限します。0は制限なしを意味します
--max-warningsなし数値-1警告数の上限を設定します。-1は制限なしを意味します

Particular run​

--help​

ヘルプを出力します。（省略形オプション: -h）

--version​

バージョンを出力します。（省略形オプション: -v）

--init​

初期化をします。設定ファイルをつくり、モジュールをインストールします。

$ npx markuplint --init

質問に対話的に答えることで、必要なモジュールをインストールします。

--max-count​

出力に表示される違反数を制限します。制限に達すると、残りのファイルはスキップされ、出力で「skipped」としてマークされます。このオプションは特に、多くの違反がある既存プロジェクトにMarkuplintを導入する際に、圧倒的な出力を管理し、パフォーマンスを向上させるのに役立ちます。

# 最初の10件の違反のみを表示
$ markuplint "**/*.html" --max-count=10

# 最初の違反のみを表示
$ markuplint index.html --max-count=1

# 制限なし（デフォルトの動作）
$ markuplint index.html --max-count=0

主な機能:

  • パフォーマンス最適化: 制限に達した時点でルール実行を停止し、大規模プロジェクトでのパフォーマンスを向上
  • 段階的導入: 管理可能な数の問題に集中することで段階的な改善を可能に
  • 情報表示: 違反が切り詰められた場合に情報メッセージを表示（標準形式のみ）
  • 形式互換性: すべての出力形式（--format=json、--format=simpleなど）でシームレスに動作
  • 修正互換性: --fixと併用する場合、完全な修正を保証するため制限は無視される

段階的改善の使用例:

  1. 現在の違反数を確認: markuplint "**/*.html" | wc -l で現在の違反数をカウント
  2. 制限を設定: CIで markuplint "**/*.html" --max-count=50 を実行
  3. 徐々に違反を修正し、制限値を減らしていく
  4. すべての違反が修正されたら最終的に制限を削除

注意: 制限によりスキップされたファイルは、出力で「skipped」としてマークされ、どのファイルが処理されなかったかが明確にわかります。

--max-warnings​

警告数の上限を設定します。警告数が指定した上限を超えた場合、Markuplintは非ゼロの終了コードで終了します。このオプションは既存プロジェクトでのMarkuplintの段階的導入に特に有用です。

# 警告を10個まで許可
$ markuplint "**/*.html" --max-warnings=10

# 警告を許可しない（厳密モード）
$ markuplint index.html --max-warnings=0

# 制限なし（デフォルトの動作）
$ markuplint index.html --max-warnings=-1

主な機能:

  • 段階的導入: 警告の閾値を設定することで段階的な改善を可能に
  • ファイル横断集計: 処理されるすべてのファイルの警告数をカウント
  • CI統合: 継続的統合での警告制限設定に最適
  • エラー優先: 警告制限に関係なく、エラーは常に非ゼロ終了コードを引き起こします

段階的改善の使用例:

  1. 現在の警告を確認: markuplint "**/*.html" --allow-warnings ですべての警告を確認
  2. 初期制限を設定: CIで markuplint "**/*.html" --max-warnings=50 を設定
  3. 徐々に警告を減らし、制限値を下げていく
  4. 最終的に --max-warnings=0 で警告ゼロを達成