|
| 1 | +import type { AST } from "svelte-eslint-parser" |
| 2 | +import { isNotClosingBraceToken, isNotOpeningBraceToken } from "eslint-utils" |
| 3 | +import type { NodeOrToken } from "../types" |
| 4 | +import { createRule } from "../utils" |
| 5 | + |
| 6 | +const QUOTE_CHARS = { |
| 7 | + double: '"', |
| 8 | + single: "'", |
| 9 | +} |
| 10 | +const QUOTE_NAMES = { |
| 11 | + double: "double quotes", |
| 12 | + single: "single quotes", |
| 13 | + unquoted: "unquoted", |
| 14 | +} |
| 15 | + |
| 16 | +export default createRule("html-quotes", { |
| 17 | + meta: { |
| 18 | + docs: { |
| 19 | + description: "enforce quotes style of HTML attributes", |
| 20 | + category: "Stylistic Issues", |
| 21 | + recommended: false, |
| 22 | + }, |
| 23 | + fixable: "code", |
| 24 | + schema: [ |
| 25 | + { |
| 26 | + type: "object", |
| 27 | + properties: { |
| 28 | + prefer: { enum: ["double", "single"] }, |
| 29 | + dynamic: { |
| 30 | + type: "object", |
| 31 | + properties: { |
| 32 | + quoted: { type: "boolean" }, |
| 33 | + avoidInvalidUnquotedInHTML: { type: "boolean" }, |
| 34 | + }, |
| 35 | + additionalProperties: false, |
| 36 | + }, |
| 37 | + }, |
| 38 | + additionalProperties: false, |
| 39 | + }, |
| 40 | + ], |
| 41 | + messages: { |
| 42 | + expectedEnclosed: "Expected to be enclosed by quotes.", |
| 43 | + expectedEnclosedBy: "Expected to be enclosed by {{kind}}.", |
| 44 | + unexpectedEnclosed: "Unexpected to be enclosed by any quotes.", |
| 45 | + }, |
| 46 | + type: "layout", // "problem", |
| 47 | + }, |
| 48 | + create(context) { |
| 49 | + const sourceCode = context.getSourceCode() |
| 50 | + const preferQuote: "double" | "single" = |
| 51 | + context.options[0]?.prefer ?? "double" |
| 52 | + const dynamicQuote = context.options[0]?.dynamic?.quoted |
| 53 | + ? preferQuote |
| 54 | + : "unquoted" |
| 55 | + const avoidInvalidUnquotedInHTML = Boolean( |
| 56 | + context.options[0]?.dynamic?.avoidInvalidUnquotedInHTML, |
| 57 | + ) |
| 58 | + |
| 59 | + type QuoteAndRange = { |
| 60 | + quote: "unquoted" | "double" | "single" |
| 61 | + range: [number, number] |
| 62 | + } |
| 63 | + |
| 64 | + /** Get the quote and range from given attribute values */ |
| 65 | + function getQuoteAndRange( |
| 66 | + attr: |
| 67 | + | AST.SvelteAttribute |
| 68 | + | AST.SvelteDirective |
| 69 | + | AST.SvelteSpecialDirective, |
| 70 | + valueTokens: NodeOrToken[], |
| 71 | + ): QuoteAndRange | null { |
| 72 | + const valueFirstToken = valueTokens[0] |
| 73 | + const valueLastToken = valueTokens[valueTokens.length - 1] |
| 74 | + const eqToken = sourceCode.getTokenAfter(attr.key) |
| 75 | + if ( |
| 76 | + !eqToken || |
| 77 | + eqToken.value !== "=" || |
| 78 | + valueFirstToken.range![0] < eqToken.range[1] |
| 79 | + ) { |
| 80 | + // invalid |
| 81 | + return null |
| 82 | + } |
| 83 | + const beforeTokens = sourceCode.getTokensBetween(eqToken, valueFirstToken) |
| 84 | + if (beforeTokens.length === 0) { |
| 85 | + return { |
| 86 | + quote: "unquoted", |
| 87 | + range: [valueFirstToken.range![0], valueLastToken.range![1]], |
| 88 | + } |
| 89 | + } else if ( |
| 90 | + beforeTokens.length > 1 || |
| 91 | + (beforeTokens[0].value !== '"' && beforeTokens[0].value !== "'") |
| 92 | + ) { |
| 93 | + // invalid |
| 94 | + return null |
| 95 | + } |
| 96 | + const beforeToken = beforeTokens[0] |
| 97 | + const afterToken = sourceCode.getTokenAfter(valueLastToken) |
| 98 | + if (!afterToken || afterToken.value !== beforeToken.value) { |
| 99 | + // invalid |
| 100 | + return null |
| 101 | + } |
| 102 | + |
| 103 | + return { |
| 104 | + quote: beforeToken.value === '"' ? "double" : "single", |
| 105 | + range: [beforeToken.range[0], afterToken.range[1]], |
| 106 | + } |
| 107 | + } |
| 108 | + |
| 109 | + /** Checks whether the given text can remove quotes in HTML. */ |
| 110 | + function canBeUnquotedInHTML(text: string) { |
| 111 | + return !/[\s"'<=>`]/u.test(text) |
| 112 | + } |
| 113 | + |
| 114 | + /** Verify quote */ |
| 115 | + function verifyQuote( |
| 116 | + prefer: "double" | "single" | "unquoted", |
| 117 | + quoteAndRange: QuoteAndRange | null, |
| 118 | + ) { |
| 119 | + if (!quoteAndRange) { |
| 120 | + // invalid |
| 121 | + return |
| 122 | + } |
| 123 | + if (quoteAndRange.quote === prefer) { |
| 124 | + // valid |
| 125 | + return |
| 126 | + } |
| 127 | + |
| 128 | + let messageId: string |
| 129 | + let expectedQuote = prefer |
| 130 | + if (quoteAndRange.quote !== "unquoted") { |
| 131 | + if (expectedQuote === "unquoted") { |
| 132 | + messageId = "unexpectedEnclosed" |
| 133 | + } else { |
| 134 | + const contentText = sourceCode.text.slice( |
| 135 | + quoteAndRange.range[0] + 1, |
| 136 | + quoteAndRange.range[1] - 1, |
| 137 | + ) |
| 138 | + const needEscape = contentText.includes(QUOTE_CHARS[expectedQuote]) |
| 139 | + if (needEscape) { |
| 140 | + // avoid escape |
| 141 | + return |
| 142 | + } |
| 143 | + messageId = "expectedEnclosedBy" |
| 144 | + } |
| 145 | + } else { |
| 146 | + const contentText = sourceCode.text.slice(...quoteAndRange.range) |
| 147 | + const needEscapeDoubleQuote = contentText.includes('"') |
| 148 | + const needEscapeSingleQuote = contentText.includes("'") |
| 149 | + if (needEscapeDoubleQuote && needEscapeSingleQuote) { |
| 150 | + // avoid escape |
| 151 | + return |
| 152 | + } |
| 153 | + if (needEscapeDoubleQuote && expectedQuote === "double") { |
| 154 | + expectedQuote = "single" |
| 155 | + messageId = "expectedEnclosed" |
| 156 | + } else if (needEscapeSingleQuote && expectedQuote === "single") { |
| 157 | + expectedQuote = "double" |
| 158 | + messageId = "expectedEnclosed" |
| 159 | + } else { |
| 160 | + messageId = "expectedEnclosedBy" |
| 161 | + } |
| 162 | + } |
| 163 | + |
| 164 | + context.report({ |
| 165 | + loc: { |
| 166 | + start: sourceCode.getLocFromIndex(quoteAndRange.range[0]), |
| 167 | + end: sourceCode.getLocFromIndex(quoteAndRange.range[1]), |
| 168 | + }, |
| 169 | + messageId, |
| 170 | + data: { kind: QUOTE_NAMES[expectedQuote] }, |
| 171 | + *fix(fixer) { |
| 172 | + if (expectedQuote !== "unquoted") { |
| 173 | + yield fixer.insertTextBeforeRange( |
| 174 | + [quoteAndRange.range[0], quoteAndRange.range[0]], |
| 175 | + QUOTE_CHARS[expectedQuote], |
| 176 | + ) |
| 177 | + } |
| 178 | + if (quoteAndRange.quote !== "unquoted") { |
| 179 | + yield fixer.removeRange([ |
| 180 | + quoteAndRange.range[0], |
| 181 | + quoteAndRange.range[0] + 1, |
| 182 | + ]) |
| 183 | + yield fixer.removeRange([ |
| 184 | + quoteAndRange.range[1] - 1, |
| 185 | + quoteAndRange.range[1], |
| 186 | + ]) |
| 187 | + } |
| 188 | + |
| 189 | + if (expectedQuote !== "unquoted") { |
| 190 | + yield fixer.insertTextAfterRange( |
| 191 | + [quoteAndRange.range[1], quoteAndRange.range[1]], |
| 192 | + QUOTE_CHARS[expectedQuote], |
| 193 | + ) |
| 194 | + } |
| 195 | + }, |
| 196 | + }) |
| 197 | + } |
| 198 | + |
| 199 | + /** Verify for standard attribute */ |
| 200 | + function verifyForValues( |
| 201 | + attr: AST.SvelteAttribute, |
| 202 | + valueNodes: AST.SvelteAttribute["value"], |
| 203 | + ) { |
| 204 | + const quoteAndRange = getQuoteAndRange(attr, valueNodes) |
| 205 | + verifyQuote(preferQuote, quoteAndRange) |
| 206 | + } |
| 207 | + |
| 208 | + /** Verify for dynamic attribute */ |
| 209 | + function verifyForDynamicMustacheTag( |
| 210 | + attr: AST.SvelteAttribute, |
| 211 | + valueNode: AST.SvelteMustacheTag & { |
| 212 | + kind: "text" |
| 213 | + }, |
| 214 | + ) { |
| 215 | + const quoteAndRange = getQuoteAndRange(attr, [valueNode]) |
| 216 | + const text = sourceCode.text.slice(...valueNode.range) |
| 217 | + verifyQuote( |
| 218 | + avoidInvalidUnquotedInHTML && !canBeUnquotedInHTML(text) |
| 219 | + ? preferQuote |
| 220 | + : dynamicQuote, |
| 221 | + quoteAndRange, |
| 222 | + ) |
| 223 | + } |
| 224 | + |
| 225 | + /** Verify for directive value */ |
| 226 | + function verifyForDirective( |
| 227 | + attr: AST.SvelteDirective | AST.SvelteSpecialDirective, |
| 228 | + valueNode: NonNullable<AST.SvelteDirective["expression"]>, |
| 229 | + ) { |
| 230 | + const beforeToken = sourceCode.getTokenBefore(valueNode) |
| 231 | + const afterToken = sourceCode.getTokenAfter(valueNode) |
| 232 | + if ( |
| 233 | + !beforeToken || |
| 234 | + !afterToken || |
| 235 | + isNotOpeningBraceToken(beforeToken) || |
| 236 | + isNotClosingBraceToken(afterToken) |
| 237 | + ) { |
| 238 | + return |
| 239 | + } |
| 240 | + const quoteAndRange = getQuoteAndRange(attr, [beforeToken, afterToken]) |
| 241 | + const text = sourceCode.text.slice( |
| 242 | + beforeToken.range[0], |
| 243 | + afterToken.range[1], |
| 244 | + ) |
| 245 | + verifyQuote( |
| 246 | + avoidInvalidUnquotedInHTML && !canBeUnquotedInHTML(text) |
| 247 | + ? preferQuote |
| 248 | + : dynamicQuote, |
| 249 | + quoteAndRange, |
| 250 | + ) |
| 251 | + } |
| 252 | + |
| 253 | + return { |
| 254 | + SvelteAttribute(node) { |
| 255 | + if ( |
| 256 | + node.value.length === 1 && |
| 257 | + node.value[0].type === "SvelteMustacheTag" |
| 258 | + ) { |
| 259 | + verifyForDynamicMustacheTag(node, node.value[0]) |
| 260 | + } else if (node.value.length >= 1) { |
| 261 | + verifyForValues(node, node.value) |
| 262 | + } |
| 263 | + }, |
| 264 | + "SvelteDirective, SvelteSpecialDirective"( |
| 265 | + node: AST.SvelteDirective | AST.SvelteSpecialDirective, |
| 266 | + ) { |
| 267 | + if (node.expression == null) { |
| 268 | + return |
| 269 | + } |
| 270 | + if ( |
| 271 | + node.key.range[0] <= node.expression.range![0] && |
| 272 | + node.expression.range![1] <= node.key.range[1] |
| 273 | + ) { |
| 274 | + // shorthand |
| 275 | + return |
| 276 | + } |
| 277 | + verifyForDirective(node, node.expression) |
| 278 | + }, |
| 279 | + } |
| 280 | + }, |
| 281 | +}) |
0 commit comments