|
| 1 | +import type { AST } from "svelte-eslint-parser" |
| 2 | +import { createRule } from "../utils" |
| 3 | +import { getNodeName, isVoidHtmlElement } from "../utils/ast-utils" |
| 4 | + |
| 5 | +const TYPE_MESSAGES = { |
| 6 | + normal: "HTML elements", |
| 7 | + void: "HTML void elements", |
| 8 | + component: "Svelte custom components", |
| 9 | + svelte: "Svelte special elements", |
| 10 | +} |
| 11 | + |
| 12 | +type ElementTypes = "normal" | "void" | "component" | "svelte" |
| 13 | + |
| 14 | +export default createRule("html-self-closing", { |
| 15 | + meta: { |
| 16 | + docs: { |
| 17 | + description: "enforce self-closing style", |
| 18 | + category: "Stylistic Issues", |
| 19 | + recommended: false, |
| 20 | + conflictWithPrettier: true, |
| 21 | + }, |
| 22 | + type: "layout", |
| 23 | + fixable: "code", |
| 24 | + messages: { |
| 25 | + requireClosing: "Require self-closing on {{type}}.", |
| 26 | + disallowClosing: "Disallow self-closing on {{type}}.", |
| 27 | + }, |
| 28 | + schema: [ |
| 29 | + { |
| 30 | + type: "object", |
| 31 | + properties: { |
| 32 | + void: { |
| 33 | + enum: ["never", "always", "ignore"], |
| 34 | + }, |
| 35 | + normal: { |
| 36 | + enum: ["never", "always", "ignore"], |
| 37 | + }, |
| 38 | + component: { |
| 39 | + enum: ["never", "always", "ignore"], |
| 40 | + }, |
| 41 | + svelte: { |
| 42 | + enum: ["never", "always", "ignore"], |
| 43 | + }, |
| 44 | + }, |
| 45 | + additionalProperties: false, |
| 46 | + }, |
| 47 | + ], |
| 48 | + }, |
| 49 | + create(ctx) { |
| 50 | + const options = { |
| 51 | + void: "always", |
| 52 | + normal: "always", |
| 53 | + component: "always", |
| 54 | + svelte: "always", |
| 55 | + ...ctx.options?.[0], |
| 56 | + } |
| 57 | + |
| 58 | + /** |
| 59 | + * Get SvelteElement type. |
| 60 | + * If element is custom component "component" is returned |
| 61 | + * If element is svelte special element such as svelte:self "svelte" is returned |
| 62 | + * If element is void element "void" is returned |
| 63 | + * otherwise "normal" is returned |
| 64 | + */ |
| 65 | + function getElementType(node: AST.SvelteElement): ElementTypes { |
| 66 | + if (node.kind === "component") return "component" |
| 67 | + if (node.kind === "special") return "svelte" |
| 68 | + if (isVoidHtmlElement(node)) return "void" |
| 69 | + return "normal" |
| 70 | + } |
| 71 | + |
| 72 | + /** |
| 73 | + * Returns true if element has no children, or has only whitespace text |
| 74 | + */ |
| 75 | + function isElementEmpty(node: AST.SvelteElement): boolean { |
| 76 | + if (node.children.length <= 0) return true |
| 77 | + |
| 78 | + for (const child of node.children) { |
| 79 | + if (child.type !== "SvelteText") return false |
| 80 | + if (!/^\s*$/.test(child.value)) return false |
| 81 | + } |
| 82 | + |
| 83 | + return true |
| 84 | + } |
| 85 | + |
| 86 | + /** |
| 87 | + * Report |
| 88 | + */ |
| 89 | + function report(node: AST.SvelteElement, close: boolean) { |
| 90 | + const elementType = getElementType(node) |
| 91 | + |
| 92 | + ctx.report({ |
| 93 | + node, |
| 94 | + messageId: close ? "requireClosing" : "disallowClosing", |
| 95 | + data: { |
| 96 | + type: TYPE_MESSAGES[elementType], |
| 97 | + }, |
| 98 | + *fix(fixer) { |
| 99 | + if (close) { |
| 100 | + for (const child of node.children) { |
| 101 | + yield fixer.removeRange(child.range) |
| 102 | + } |
| 103 | + |
| 104 | + yield fixer.insertTextBeforeRange( |
| 105 | + [node.startTag.range[1] - 1, node.startTag.range[1]], |
| 106 | + "/", |
| 107 | + ) |
| 108 | + |
| 109 | + if (node.endTag) yield fixer.removeRange(node.endTag.range) |
| 110 | + } else { |
| 111 | + yield fixer.removeRange([ |
| 112 | + node.startTag.range[1] - 2, |
| 113 | + node.startTag.range[1] - 1, |
| 114 | + ]) |
| 115 | + |
| 116 | + if (!isVoidHtmlElement(node)) |
| 117 | + yield fixer.insertTextAfter(node, `</${getNodeName(node)}>`) |
| 118 | + } |
| 119 | + }, |
| 120 | + }) |
| 121 | + } |
| 122 | + |
| 123 | + return { |
| 124 | + SvelteElement(node: AST.SvelteElement) { |
| 125 | + if (!isElementEmpty(node)) return |
| 126 | + |
| 127 | + const elementType = getElementType(node) |
| 128 | + |
| 129 | + const elementTypeOptions = options[elementType] |
| 130 | + if (elementTypeOptions === "ignore") return |
| 131 | + const shouldBeClosed = elementTypeOptions === "always" |
| 132 | + |
| 133 | + if (shouldBeClosed && !node.startTag.selfClosing) { |
| 134 | + report(node, true) |
| 135 | + } else if (!shouldBeClosed && node.startTag.selfClosing) { |
| 136 | + report(node, false) |
| 137 | + } |
| 138 | + }, |
| 139 | + } |
| 140 | + }, |
| 141 | +}) |
0 commit comments