require-head-tag-content-or-attributes
Require top-level headTags entries to provide either meaningful attributes or non-empty innerHTML.
Targeted pattern scopeโ
This rule targets docusaurus.config.* files and inspects the top-level headTags array.
What this rule reportsโ
This rule reports head-tag entries that do not provide meaningful attributes and do not provide non-empty innerHTML.
Why this rule existsโ
A head-tag entry without attributes or inline content cannot contribute meaningful output and usually indicates unfinished configuration.
โ Incorrectโ
export default {
headTags: [{ tagName: "meta" }],
};
export default {
headTags: [{ tagName: "script", innerHTML: "" }],
};
โ Correctโ
export default {
headTags: [
{
tagName: "meta",
attributes: { name: "theme-color", content: "#25c2a0" },
},
],
};
Behavior and migration notesโ
This rule reports only. It does not autofix, because the correct missing attributes or inline content depend on author intent.
When not to use itโ
Do not use this rule if your project intentionally emits placeholder head-tag objects for a later transform step.
Rule catalog ID: R075