必須属性 (`required-attr`)

設定された属性もしくは仕様上必須となっている属性が要素上に存在しない場合に警告をします。

HTML Living Standardを基準としてMDN Web docsから最新情報を確認しています。 @markuplint/html-specに設定値を持っています。

ルールの詳細

<img> 要素の src 属性はHTML Living Standardでは必須となります。

👎 間違ったコード例

<img />

👍 正しいコード例

<img src="/path/to/image.png" />

{ "required-attr": "alt" } として alt 属性を必須とします。

👎 間違ったコード例

<img src="/path/to/image.png" />

👍 正しいコード例

<img src="/path/to/image.png" alt="alternative text" />

{
	"rules": {
		"required-attr": "alt"
	}
}

{
	"rules": {
		"required-attr": ["alt", "width", "height"]
	}
}

型: string | string[]

設定値	デフォルト	解説
`"属性名"`	[]	存在しないときに警告を出したい属性名の文字列、または、その配列。

通常は要素の種類ごとに必須属性を設定することになるので、required-attr ルールは nodeRules オプション内に設定すると良いでしょう。

以下は <img> 要素上で alt 属性を必須とする設定例です。

{
	"rules": {
		"required-attr": true
	},
	"nodeRules": [
		{
			"tagName": "img",
			"rules": {
				"required-attr": "alt"
			}
		}
	]
}