support null

Author: baseballyama

packages/eslint-plugin-svelte/src/rules/block-lang.ts

@@ -2,6 +2,7 @@ import { createRule } from '../utils/index.js';
 import { findAttribute, getLangValue } from '../utils/ast-utils.js';
 import type { SvelteScriptElement, SvelteStyleElement } from 'svelte-eslint-parser/lib/ast';
 import { getSourceCode } from '../utils/compat.js';
+import type { SuggestionReportDescriptor } from '../types.js';
 
 export default createRule('block-lang', {
 	meta: {
@@ -108,34 +109,12 @@ export default createRule('block-lang', {
 				}
 				for (const scriptNode of scriptNodes) {
 					if (!allowedScriptLangs.includes(getLangValue(scriptNode)?.toLowerCase() ?? null)) {
-						const langAttribute = findAttribute(scriptNode, 'lang');
 						context.report({
 							node: scriptNode,
 							message: `The lang attribute of the <script> block should be ${prettyPrintLangs(
 								allowedScriptLangs
 							)}.`,
-							suggest: allowedScriptLangs
-								.filter((lang) => lang != null && lang !== '')
-								.map((lang) => {
-									const langAttributeText = getLangAttributeText(lang ?? '', true);
-									if (langAttribute) {
-										return {
-											desc: `Add a <script> block with the lang attribute set to "${lang}".`,
-											fix: (fixer) => {
-												return fixer.replaceText(langAttribute, langAttributeText.trim());
-											}
-										};
-									}
-									return {
-										desc: `Add a <script> block with the lang attribute set to "${lang}".`,
-										fix: (fixer) => {
-											return fixer.insertTextBeforeRange(
-												[scriptNode.startTag.range[0] + 7, 0],
-												langAttributeText
-											);
-										}
-									};
-								})
+							suggest: buildSuggestions(allowedScriptLangs, scriptNode)
 						});
 					}
 				}
@@ -164,34 +143,12 @@ export default createRule('block-lang', {
 				}
 				for (const styleNode of styleNodes) {
 					if (!allowedStyleLangs.includes(getLangValue(styleNode)?.toLowerCase() ?? null)) {
-						const langAttribute = findAttribute(styleNode, 'lang');
 						context.report({
 							node: styleNode,
 							message: `The lang attribute of the <style> block should be ${prettyPrintLangs(
 								allowedStyleLangs
 							)}.`,
-							suggest: allowedStyleLangs
-								.filter((lang) => lang != null && lang !== '')
-								.map((lang) => {
-									const langAttributeText = getLangAttributeText(lang ?? '', true);
-									if (langAttribute) {
-										return {
-											desc: `Add a <style> block with the lang attribute set to "${lang}".`,
-											fix: (fixer) => {
-												return fixer.replaceText(langAttribute, langAttributeText.trim());
-											}
-										};
-									}
-									return {
-										desc: `Add a <style> block with the lang attribute set to "${lang}".`,
-										fix: (fixer) => {
-											return fixer.insertTextBeforeRange(
-												[styleNode.startTag.range[0] + 6, 0],
-												langAttributeText
-											);
-										}
-									};
-								})
+							suggest: buildSuggestions(allowedStyleLangs, styleNode)
 						});
 					}
 				}
@@ -200,6 +157,49 @@ export default createRule('block-lang', {
 	}
 });
 
+function buildSuggestions(
+	langs: (string | null)[],
+	node: SvelteScriptElement | SvelteStyleElement
+): SuggestionReportDescriptor[] {
+	const tagName = node.name.name;
+	const langAttribute = findAttribute(node, 'lang');
+	const filteredLangs = langs.filter((lang) => lang != null && lang !== '');
+
+	if (filteredLangs.length === 0 && langs.includes(null) && langAttribute !== null) {
+		return [
+			{
+				desc: `Replace a <${tagName}> block with the lang attribute omitted.`,
+				fix: (fixer) => {
+					return fixer.remove({
+						type: langAttribute.type,
+						range: [langAttribute.range[0] - 1, langAttribute.range[1]]
+					});
+				}
+			}
+		];
+	}
+	return filteredLangs.map((lang) => {
+		const langAttributeText = getLangAttributeText(lang ?? '', true);
+		if (langAttribute) {
+			return {
+				desc: `Replace a <${tagName}> block with the lang attribute set to "${lang}".`,
+				fix: (fixer) => {
+					return fixer.replaceText(langAttribute, langAttributeText.trim());
+				}
+			};
+		}
+		return {
+			desc: `Add a <${tagName}> block with the lang attribute set to "${lang}".`,
+			fix: (fixer) => {
+				return fixer.insertTextBeforeRange(
+					[node.startTag.range[0] + tagName.length + 1, 0],
+					langAttributeText
+				);
+			}
+		};
+	});
+}
+
 /**
  * Prints the list of allowed languages, with special handling of the `null` option.
  */

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/javascript/js01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "javascript".
+    - desc: Replace a <script> block with the lang attribute set to "javascript".
       output: |
         <script lang="javascript"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/javascript/ts01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "javascript".
+    - desc: Replace a <script> block with the lang attribute set to "javascript".
       output: |
         <script lang="javascript"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/javascript/typescript01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "javascript".
+    - desc: Replace a <script> block with the lang attribute set to "javascript".
       output: |
         <script lang="javascript"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/js/javascript01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "js".
+    - desc: Replace a <script> block with the lang attribute set to "js".
       output: |
         <script lang="js"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/js/ts01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "js".
+    - desc: Replace a <script> block with the lang attribute set to "js".
       output: |
         <script lang="js"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/js/typescript01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "js".
+    - desc: Replace a <script> block with the lang attribute set to "js".
       output: |
         <script lang="js"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/module-context/javascript01-errors.yaml

@@ -2,7 +2,7 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script context="module" lang="ts"></script>
 

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/module-context/js01-errors.yaml

@@ -2,7 +2,7 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script context="module" lang="ts"></script>
 

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/module-context/typescript01-errors.yaml

@@ -2,7 +2,7 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script context="module" lang="ts"></script>
 

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/multiple/javascript01-errors.yaml

@@ -3,9 +3,9 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>
-    - desc: Add a <script> block with the lang attribute set to "typescript".
+    - desc: Replace a <script> block with the lang attribute set to "typescript".
       output: |
         <script lang="typescript"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/multiple/js01-errors.yaml

@@ -3,9 +3,9 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>
-    - desc: Add a <script> block with the lang attribute set to "typescript".
+    - desc: Replace a <script> block with the lang attribute set to "typescript".
       output: |
         <script lang="typescript"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/multiple/null-as-style-lang01-errors.yaml

@@ -3,12 +3,12 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>
 
         <style></style>
-    - desc: Add a <script> block with the lang attribute set to "typescript".
+    - desc: Replace a <script> block with the lang attribute set to "typescript".
       output: |
         <script lang="typescript"></script>
 

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/multiple/ts-as-style-lang01-errors.yaml

@@ -3,12 +3,12 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>
 
         <style lang="ts"></style>
-    - desc: Add a <script> block with the lang attribute set to "typescript".
+    - desc: Replace a <script> block with the lang attribute set to "typescript".
       output: |
         <script lang="typescript"></script>
 

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/multiple/typescript-as-style-lang01-errors.yaml

@@ -3,12 +3,12 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>
 
         <style lang="typescript"></style>
-    - desc: Add a <script> block with the lang attribute set to "typescript".
+    - desc: Replace a <script> block with the lang attribute set to "typescript".
       output: |
         <script lang="typescript"></script>
 

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/null/javascript01-errors.yaml

@@ -1,4 +1,7 @@
 - message: The lang attribute of the <script> block should be omitted.
   line: 1
   column: 1
-  suggestions: null
+  suggestions:
+    - desc: Replace a <script> block with the lang attribute omitted.
+      output: |
+        <script></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/null/js01-errors.yaml

@@ -1,4 +1,7 @@
 - message: The lang attribute of the <script> block should be omitted.
   line: 1
   column: 1
-  suggestions: null
+  suggestions:
+    - desc: Replace a <script> block with the lang attribute omitted.
+      output: |
+        <script></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/null/null-as-style-lang01-errors.yaml

@@ -1,4 +1,9 @@
 - message: The lang attribute of the <script> block should be omitted.
   line: 1
   column: 1
-  suggestions: null
+  suggestions:
+    - desc: Replace a <script> block with the lang attribute omitted.
+      output: |
+        <script></script>
+
+        <style></style>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/null/ts01-errors.yaml

@@ -1,4 +1,7 @@
 - message: The lang attribute of the <script> block should be omitted.
   line: 1
   column: 1
-  suggestions: null
+  suggestions:
+    - desc: Replace a <script> block with the lang attribute omitted.
+      output: |
+        <script></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/null/typescript01-errors.yaml

@@ -1,4 +1,7 @@
 - message: The lang attribute of the <script> block should be omitted.
   line: 1
   column: 1
-  suggestions: null
+  suggestions:
+    - desc: Replace a <script> block with the lang attribute omitted.
+      output: |
+        <script></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/shorthand/javascript01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/shorthand/js01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/shorthand/typescript01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/ts/javascript01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/ts/js01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/ts/typescript01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "ts".
+    - desc: Replace a <script> block with the lang attribute set to "ts".
       output: |
         <script lang="ts"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/typescript/javascript01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "typescript".
+    - desc: Replace a <script> block with the lang attribute set to "typescript".
       output: |
         <script lang="typescript"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/typescript/js01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "typescript".
+    - desc: Replace a <script> block with the lang attribute set to "typescript".
       output: |
         <script lang="typescript"></script>

packages/eslint-plugin-svelte/tests/fixtures/rules/block-lang/invalid/script/typescript/ts01-errors.yaml

@@ -2,6 +2,6 @@
   line: 1
   column: 1
   suggestions:
-    - desc: Add a <script> block with the lang attribute set to "typescript".
+    - desc: Replace a <script> block with the lang attribute set to "typescript".
       output: |
         <script lang="typescript"></script>