feat: replace declaration property of SvelteConstTag with `declarat…

…ions` property
sveltejs · Jan 14, 2025 · 6280a13 · 6280a13
1 parent d1ac7f0
commit 6280a13
Show file tree

Hide file tree

Showing 10 changed files with 537 additions and 507 deletions.
diff --git a/package.json b/package.json
@@ -84,7 +84,7 @@
     "chai": "^5.0.0",
     "env-cmd": "^10.1.0",
     "esbuild": "^0.24.0",
-    "eslint": "~9.16.0",
+    "eslint": "~9.18.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-jsdoc": "^50.6.0",

diff --git a/src/ast/html.ts b/src/ast/html.ts
@@ -262,7 +262,11 @@ export interface SvelteDebugTag extends BaseNode {
 /** Node of const tag. e.g. `{@const}` */
 export interface SvelteConstTag extends BaseNode {
   type: "SvelteConstTag";
-  declaration: ESTree.VariableDeclarator;
+  /**
+   * @deprecated Use `declarations` instead.
+   */
+  declaration: ESTree.VariableDeclarator; // TODO Remove in v2 and later.
+  declarations: [ESTree.VariableDeclarator];
   parent:
     | SvelteProgram
     | SvelteElement

diff --git a/src/parser/converts/const.ts b/src/parser/converts/const.ts
@@ -13,14 +13,28 @@ export function convertConstTag(
   const mustache: SvelteConstTag = {
     type: "SvelteConstTag",
     declaration: null as any,
+    declarations: [] as any,
     parent,
     ...ctx.getConvertLocation(node),
   };
+
+  // Link declaration and declarations for backward compatibility.
+  // TODO Remove in v2 and later.
+  Object.defineProperty(mustache, "declaration", {
+    get() {
+      return mustache.declarations[0];
+    },
+    set(value) {
+      mustache.declarations = [value];
+    },
+    enumerable: false,
+  });
+
   ctx.scriptLet.addVariableDeclarator(
     getDeclaratorFromConstTag(node),
     mustache,
     (declaration) => {
-      mustache.declaration = declaration;
+      mustache.declarations = [declaration];
     },
   );
   const atConstStart = ctx.code.indexOf("@const", mustache.range[0]);

diff --git a/src/visitor-keys.ts b/src/visitor-keys.ts
@@ -21,7 +21,7 @@ const svelteKeys: SvelteKeysType = {
   SvelteLiteral: [],
   SvelteMustacheTag: ["expression"],
   SvelteDebugTag: ["identifiers"],
-  SvelteConstTag: ["declaration"],
+  SvelteConstTag: ["declarations"],
   SvelteRenderTag: ["expression"],
   SvelteIfBlock: ["expression", "children", "else"],
   SvelteElseBlock: ["children"],

diff --git a/tests/fixtures/parser/ast/at-const01-within-component-output.json b/tests/fixtures/parser/ast/at-const01-within-component-output.json
@@ -300,59 +300,75 @@
         },
         {
           "type": "SvelteConstTag",
-          "declaration": {
-            "type": "VariableDeclarator",
-            "id": {
-              "type": "Identifier",
-              "name": "a",
-              "range": [
-                101,
-                102
-              ],
-              "loc": {
-                "start": {
-                  "line": 6,
-                  "column": 10
-                },
-                "end": {
-                  "line": 6,
-                  "column": 11
-                }
-              }
-            },
-            "init": {
-              "type": "BinaryExpression",
-              "left": {
+          "declarations": [
+            {
+              "type": "VariableDeclarator",
+              "id": {
                 "type": "Identifier",
-                "name": "b",
+                "name": "a",
                 "range": [
-                  105,
-                  106
+                  101,
+                  102
                 ],
                 "loc": {
                   "start": {
                     "line": 6,
-                    "column": 14
+                    "column": 10
                   },
                   "end": {
                     "line": 6,
-                    "column": 15
+                    "column": 11
                   }
                 }
               },
-              "operator": "*",
-              "right": {
-                "type": "Literal",
-                "raw": "2",
-                "value": 2,
+              "init": {
+                "type": "BinaryExpression",
+                "left": {
+                  "type": "Identifier",
+                  "name": "b",
+                  "range": [
+                    105,
+                    106
+                  ],
+                  "loc": {
+                    "start": {
+                      "line": 6,
+                      "column": 14
+                    },
+                    "end": {
+                      "line": 6,
+                      "column": 15
+                    }
+                  }
+                },
+                "operator": "*",
+                "right": {
+                  "type": "Literal",
+                  "raw": "2",
+                  "value": 2,
+                  "range": [
+                    109,
+                    110
+                  ],
+                  "loc": {
+                    "start": {
+                      "line": 6,
+                      "column": 18
+                    },
+                    "end": {
+                      "line": 6,
+                      "column": 19
+                    }
+                  }
+                },
                 "range": [
-                  109,
+                  105,
                   110
                 ],
                 "loc": {
                   "start": {
                     "line": 6,
-                    "column": 18
+                    "column": 14
                   },
                   "end": {
                     "line": 6,
@@ -361,35 +377,21 @@
                 }
               },
               "range": [
-                105,
+                101,
                 110
               ],
               "loc": {
                 "start": {
                   "line": 6,
-                  "column": 14
+                  "column": 10
                 },
                 "end": {
                   "line": 6,
                   "column": 19
                 }
               }
-            },
-            "range": [
-              101,
-              110
-            ],
-            "loc": {
-              "start": {
-                "line": 6,
-                "column": 10
-              },
-              "end": {
-                "line": 6,
-                "column": 19
-              }
             }
-          },
+          ],
           "range": [
             93,
             111