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

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

使い方

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

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

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

オプション

正規形オプション省略形オプション引数デフォルト値解説
--config-cファイルパスなし設定ファイルのパス
--fixなしなしfalseルールが対応していれば対象ファイルを修正します
--format-fJSONSimpleもしくはStandardStandard出力形式
--no-search-configなしなしfalse設定ファイルを自動で検索しません
--ignore-extなしなしfalse拡張子の種類に関わらず受け取ったファイルを評価します
--no-import-preset-rulesなしなしfalse組み込みルールを利用しません
--localeなしなしOS設定によるメッセージの言語
--no-colorなしなしfalse出力をカラーリングしません
--problem-only-pなしfalse違反結果のみ出力します
--verboseなしなしfalse詳細な情報も同時に出力します

Particular run

--help

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

--version

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

--init

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

$ npx markuplint --init

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

--create-rule

カスタムルールをつくるを御覧ください。