@html-eslint/eslint-plugin
Version:
ESLint plugin for html
91 lines (79 loc) • 2.11 kB
JavaScript
/**
* @typedef { import("@html-eslint/types").Tag } Tag
* @typedef { import("@html-eslint/types").AnyNode } AnyNode
* @typedef { import("../types").RuleModule<[]> } RuleModule
*/
const { RULE_CATEGORY } = require("../constants");
const { find } = require("./utils/array");
const { findAttr, isTag } = require("./utils/node");
const MESSAGE_IDS = {
MISSING: "missing",
EMPTY: "empty",
};
/**
* @param {AnyNode} node
* @returns {node is Tag}
*/
function isMetaViewport(node) {
if (isTag(node) && node.name === "meta") {
const nameAttribute = findAttr(node, "name");
return !!(
nameAttribute &&
nameAttribute.value &&
nameAttribute.value.value.toLowerCase() === "viewport"
);
}
return false;
}
/**
* @type {RuleModule}
*/
module.exports = {
meta: {
type: "code",
docs: {
description: 'Enforce to use `<meta name="viewport">` in `<head>`',
category: RULE_CATEGORY.ACCESSIBILITY,
recommended: false,
},
fixable: null,
schema: [],
messages: {
[MESSAGE_IDS.MISSING]: 'Missing `<meta name="viewport">`.',
[MESSAGE_IDS.EMPTY]:
'Unexpected empty `content` attribute in `<meta name="viewport">`.',
},
},
create(context) {
return {
Tag(node) {
if (node.name !== "head") {
return;
}
const metaViewport = find(node.children, isMetaViewport);
if (!metaViewport) {
context.report({
node,
messageId: MESSAGE_IDS.MISSING,
});
return;
}
const contentAttribute = findAttr(metaViewport, "content");
const isAttributeEmpty =
!contentAttribute ||
!contentAttribute.value ||
!contentAttribute.value.value.length;
if (isAttributeEmpty) {
const reportTarget =
!contentAttribute || !contentAttribute.value
? metaViewport
: contentAttribute;
context.report({
node: reportTarget,
messageId: MESSAGE_IDS.EMPTY,
});
}
},
};
},
};