feat: include `script` and `svelte:options` attributes in ast (#11241)

* include attributes of script tags in ast

* include attributes of svelte:options tag in ast

* add changeset

* improve types

* improve test

.changeset/serious-crabs-punch.md

@@ -0,0 +1,5 @@
+---
+"svelte": patch
+---
+
+feat: include `script` and `svelte:options` attributes in ast

packages/svelte/src/compiler/legacy.js

@@ -86,11 +86,15 @@ export function convert(source, ast) {
 				if (instance) {
 					// @ts-ignore
 					delete instance.parent;
+					// @ts-ignore
+					delete instance.attributes;
 				}
 
 				if (module) {
 					// @ts-ignore
 					delete module.parent;
+					// @ts-ignore
+					delete module.attributes;
 				}
 
 				return {

packages/svelte/src/compiler/phases/1-parse/read/options.js

@@ -11,7 +11,9 @@ export default function read_options(node) {
 	/** @type {import('#compiler').SvelteOptions} */
 	const component_options = {
 		start: node.start,
-		end: node.end
+		end: node.end,
+		// @ts-ignore
+		attributes: node.attributes
 	};
 
 	if (!node) {

packages/svelte/src/compiler/phases/1-parse/read/script.js

@@ -63,6 +63,8 @@ export function read_script(parser, start, attributes) {
 		end: parser.index,
 		context: get_context(attributes),
 		content: ast,
-		parent: null
+		parent: null,
+		// @ts-ignore
+		attributes: attributes
 	};
 }

packages/svelte/src/compiler/types/template.d.ts

@@ -93,6 +93,7 @@ export interface SvelteOptions {
 		 */
 		extend?: ArrowFunctionExpression | Identifier;
 	};
+	attributes: Attribute[];
 }
 
 /** Static text */
@@ -467,6 +468,7 @@ export interface Script extends BaseNode {
 	type: 'Script';
 	context: string;
 	content: Program;
+	attributes: Attribute[];
 }
 
 declare module 'estree' {

packages/svelte/tests/parser-modern/samples/comment-before-script/output.json

@@ -133,6 +133,23 @@
 					"value": "should not error out"
 				}
 			]
-		}
+		},
+		"attributes": [
+			{
+				"type": "Attribute",
+				"start": 36,
+				"end": 45,
+				"name": "lang",
+				"value": [
+					{
+						"start": 42,
+						"end": 44,
+						"type": "Text",
+						"raw": "ts",
+						"data": "ts"
+					}
+				]
+			}
+		]
 	}
 }

packages/svelte/tests/parser-modern/samples/options/input.svelte

@@ -0,0 +1,7 @@
+<svelte:options customElement="my-custom-element" runes={true} />
+
+<script context="module" lang="ts">
+</script>
+
+<script lang="ts" generics="T extends { foo: number }">
+</script>

packages/svelte/tests/parser-modern/samples/options/output.json

@@ -0,0 +1,208 @@
+{
+	"css": null,
+	"js": [],
+	"start": 0,
+	"end": 112,
+	"type": "Root",
+	"fragment": {
+		"type": "Fragment",
+		"nodes": [
+			{
+				"type": "Text",
+				"start": 65,
+				"end": 67,
+				"raw": "\n\n",
+				"data": "\n\n"
+			},
+			{
+				"type": "Text",
+				"start": 112,
+				"end": 114,
+				"raw": "\n\n",
+				"data": "\n\n"
+			}
+		],
+		"transparent": false
+	},
+	"options": {
+		"start": 0,
+		"end": 65,
+		"attributes": [
+			{
+				"type": "Attribute",
+				"start": 16,
+				"end": 49,
+				"name": "customElement",
+				"value": [
+					{
+						"start": 31,
+						"end": 48,
+						"type": "Text",
+						"raw": "my-custom-element",
+						"data": "my-custom-element",
+						"parent": null
+					}
+				],
+				"parent": null,
+				"metadata": {
+					"dynamic": false,
+					"delegated": null
+				}
+			},
+			{
+				"type": "Attribute",
+				"start": 50,
+				"end": 62,
+				"name": "runes",
+				"value": [
+					{
+						"type": "ExpressionTag",
+						"start": 56,
+						"end": 62,
+						"expression": {
+							"type": "Literal",
+							"start": 57,
+							"end": 61,
+							"loc": {
+								"start": {
+									"line": 1,
+									"column": 57
+								},
+								"end": {
+									"line": 1,
+									"column": 61
+								}
+							},
+							"value": true,
+							"raw": "true"
+						},
+						"parent": null,
+						"metadata": {
+							"contains_call_expression": false,
+							"dynamic": false
+						}
+					}
+				],
+				"parent": null,
+				"metadata": {
+					"dynamic": false,
+					"delegated": null
+				}
+			}
+		],
+		"customElement": {
+			"tag": "my-custom-element"
+		},
+		"runes": true
+	},
+	"module": {
+		"type": "Script",
+		"start": 67,
+		"end": 112,
+		"context": "module",
+		"content": {
+			"type": "Program",
+			"start": 102,
+			"end": 103,
+			"loc": {
+				"start": {
+					"line": 1,
+					"column": 0
+				},
+				"end": {
+					"line": 4,
+					"column": 0
+				}
+			},
+			"body": [],
+			"sourceType": "module"
+		},
+		"attributes": [
+			{
+				"type": "Attribute",
+				"start": 75,
+				"end": 91,
+				"name": "context",
+				"value": [
+					{
+						"start": 84,
+						"end": 90,
+						"type": "Text",
+						"raw": "module",
+						"data": "module"
+					}
+				]
+			},
+			{
+				"type": "Attribute",
+				"start": 92,
+				"end": 101,
+				"name": "lang",
+				"value": [
+					{
+						"start": 98,
+						"end": 100,
+						"type": "Text",
+						"raw": "ts",
+						"data": "ts"
+					}
+				]
+			}
+		]
+	},
+	"instance": {
+		"type": "Script",
+		"start": 114,
+		"end": 179,
+		"context": "default",
+		"content": {
+			"type": "Program",
+			"start": 169,
+			"end": 170,
+			"loc": {
+				"start": {
+					"line": 1,
+					"column": 0
+				},
+				"end": {
+					"line": 7,
+					"column": 0
+				}
+			},
+			"body": [],
+			"sourceType": "module"
+		},
+		"attributes": [
+			{
+				"type": "Attribute",
+				"start": 122,
+				"end": 131,
+				"name": "lang",
+				"value": [
+					{
+						"start": 128,
+						"end": 130,
+						"type": "Text",
+						"raw": "ts",
+						"data": "ts"
+					}
+				]
+			},
+			{
+				"type": "Attribute",
+				"start": 132,
+				"end": 168,
+				"name": "generics",
+				"value": [
+					{
+						"start": 142,
+						"end": 167,
+						"type": "Text",
+						"raw": "T extends { foo: number }",
+						"data": "T extends { foo: number }"
+					}
+				]
+			}
+		]
+	}
+}

packages/svelte/tests/parser-modern/samples/snippets/output.json

@@ -206,6 +206,23 @@
 			},
 			"body": [],
 			"sourceType": "module"
-		}
+		},
+		"attributes": [
+			{
+				"type": "Attribute",
+				"start": 8,
+				"end": 17,
+				"name": "lang",
+				"value": [
+					{
+						"start": 14,
+						"end": 16,
+						"type": "Text",
+						"raw": "ts",
+						"data": "ts"
+					}
+				]
+			}
+		]
 	}
 }

packages/svelte/tests/parser-modern/samples/typescript-in-event-handler/output.json

@@ -477,6 +477,23 @@
 				}
 			],
 			"sourceType": "module"
-		}
+		},
+		"attributes": [
+			{
+				"type": "Attribute",
+				"start": 8,
+				"end": 17,
+				"name": "lang",
+				"value": [
+					{
+						"start": 14,
+						"end": 16,
+						"type": "Text",
+						"raw": "ts",
+						"data": "ts"
+					}
+				]
+			}
+		]
 	}
 }

packages/svelte/types/index.d.ts

@@ -1316,6 +1316,7 @@ declare module 'svelte/compiler' {
 			 */
 			extend?: ArrowFunctionExpression | Identifier;
 		};
+		attributes: Attribute[];
 	}
 
 	/** Static text */
@@ -1690,6 +1691,7 @@ declare module 'svelte/compiler' {
 		type: 'Script';
 		context: string;
 		content: Program;
+		attributes: Attribute[];
 	}
 	/**
 	 * The result of a preprocessor run. If the preprocessor does not return a result, it is assumed that the code is unchanged.