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

required-element

指定された要素がドキュメントまたは要素に表示されなかった場合、警告します。セレクターを使用して指定します。

これは必要な要素を検索するための汎用的なルールです。

備考

h1要素が必要な場合はrequired-h1ルールを使用してください。ランドマーク要素が必要な場合はlandmark-rolesルールを使用してください。HTML標準に準拠しているかどうかはpermitted-contentsルールを使用してください。

❌ 間違ったコード例

<!-- "required-element": ["meta[charset=\"UTF-8\"]"] -->
<head>
  <title>Page title</title>
</head>

✅ 正しいコード例

<!-- "required-element": ["meta[charset=\"UTF-8\"]"] -->
<head>
  <meta charset="UTF-8" />
  <title>Page title</title>
</head>

Interface​

{
  "required-element": string[]
}

Options​

{
  "required-element": {
    "options": {
      "ignoreHasMutableContents"?: boolean
    }
  }
}
PropertyTypeDefault ValueDescription
ignoreHasMutableContentsboolean"true"Pugのようなプリプロセッサ言語やVueのようなコンポーネントライブラリにおけるミュータブルな子要素を含む場合、無視します。（Pugも、Vueも、それぞれ@markuplint/pug-parserや@markuplint/vue-parserが必要です）

Default Severity​

error

設定例​

rulesに指定すると、ドキュメント全体から要素を検索します。

{
  "rules": {
    "required-element": ["meta[charset=\"UTF-8\"]"]
  }
}

nodeRulesまたは childNodeRulesに指定されている場合、ターゲット要素の子要素から要素を検索します。

{
  "nodeRules": [
    {
      "selector": "head",
      "rules": {
        "required-element": ["meta[charset=\"UTF-8\"]"]
      }
    }
  ]
}