|
| 1 | +import { createRule } from "../utils" |
| 2 | +import type { AST } from "svelte-eslint-parser" |
| 3 | + |
| 4 | +export default createRule("html-closing-bracket-spacing", { |
| 5 | + meta: { |
| 6 | + docs: { |
| 7 | + description: "require or disallow a space before tag's closing brackets", |
| 8 | + category: "Stylistic Issues", |
| 9 | + conflictWithPrettier: true, |
| 10 | + recommended: false, |
| 11 | + }, |
| 12 | + schema: [ |
| 13 | + { |
| 14 | + type: "object", |
| 15 | + properties: { |
| 16 | + startTag: { |
| 17 | + enum: ["always", "never", "ignore"], |
| 18 | + }, |
| 19 | + endTag: { |
| 20 | + enum: ["always", "never", "ignore"], |
| 21 | + }, |
| 22 | + selfClosingTag: { |
| 23 | + enum: ["always", "never", "ignore"], |
| 24 | + }, |
| 25 | + }, |
| 26 | + additionalProperties: false, |
| 27 | + }, |
| 28 | + ], |
| 29 | + messages: { |
| 30 | + expectedSpace: "Expected space before '>', but not found.", |
| 31 | + unexpectedSpace: "Expected no space before '>', but found.", |
| 32 | + }, |
| 33 | + fixable: "whitespace", |
| 34 | + type: "layout", |
| 35 | + }, |
| 36 | + create(ctx) { |
| 37 | + const options = { |
| 38 | + startTag: "never", |
| 39 | + endTag: "never", |
| 40 | + selfClosingTag: "always", |
| 41 | + ...ctx.options[0], |
| 42 | + } |
| 43 | + const src = ctx.getSourceCode() |
| 44 | + |
| 45 | + /** |
| 46 | + * Returns true if string contains newline characters |
| 47 | + */ |
| 48 | + function containsNewline(string: string): boolean { |
| 49 | + return string.includes("\n") |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * Report |
| 54 | + */ |
| 55 | + function report( |
| 56 | + node: AST.SvelteStartTag | AST.SvelteEndTag, |
| 57 | + shouldHave: boolean, |
| 58 | + ) { |
| 59 | + const tagSrc = src.getText(node) |
| 60 | + const match = /(\s*)\/?>$/.exec(tagSrc) |
| 61 | + |
| 62 | + const end = node.range[1] |
| 63 | + const start = node.range[1] - match![0].length |
| 64 | + const loc = { |
| 65 | + start: src.getLocFromIndex(start), |
| 66 | + end: src.getLocFromIndex(end), |
| 67 | + } |
| 68 | + |
| 69 | + ctx.report({ |
| 70 | + loc, |
| 71 | + messageId: shouldHave ? "expectedSpace" : "unexpectedSpace", |
| 72 | + *fix(fixer) { |
| 73 | + if (shouldHave) { |
| 74 | + yield fixer.insertTextBeforeRange([start, end], " ") |
| 75 | + } else { |
| 76 | + const spaces = match![1] |
| 77 | + |
| 78 | + yield fixer.removeRange([start, start + spaces.length]) |
| 79 | + } |
| 80 | + }, |
| 81 | + }) |
| 82 | + } |
| 83 | + |
| 84 | + return { |
| 85 | + "SvelteStartTag, SvelteEndTag"( |
| 86 | + node: AST.SvelteStartTag | AST.SvelteEndTag, |
| 87 | + ) { |
| 88 | + const tagType = |
| 89 | + node.type === "SvelteEndTag" |
| 90 | + ? "endTag" |
| 91 | + : node.selfClosing |
| 92 | + ? "selfClosingTag" |
| 93 | + : "startTag" |
| 94 | + |
| 95 | + if (options[tagType] === "ignore") return |
| 96 | + |
| 97 | + const tagSrc = src.getText(node) |
| 98 | + const match = /(\s*)\/?>$/.exec(tagSrc) |
| 99 | + if (containsNewline(match![1])) return |
| 100 | + |
| 101 | + if (options[tagType] === "always" && !match![1]) { |
| 102 | + report(node, true) |
| 103 | + } else if (options[tagType] === "never" && match![1]) { |
| 104 | + report(node, false) |
| 105 | + } |
| 106 | + }, |
| 107 | + } |
| 108 | + }, |
| 109 | +}) |
0 commit comments