feat: Support runes

.changeset/blue-pets-play.md

@@ -0,0 +1,5 @@
+---
+"svelte-eslint-parser": minor
+---
+
+feat: Support runes

explorer-v2/package.json

@@ -18,7 +18,7 @@
 		"eslint-scope": "^7.0.0",
 		"esquery": "^1.5.0",
 		"pako": "^2.0.3",
-		"svelte": "^4.0.0",
+		"svelte": "^5.0.0-next.2",
 		"svelte-eslint-parser": "link:..",
 		"tslib": "^2.5.0"
 	},

src/parser/globals.ts

@@ -0,0 +1,17 @@
+import { VERSION as SVELTE_VERSION } from "svelte/compiler";
+
+const globalsForSvelte4: Readonly<string[]> = [
+  "$$slots",
+  "$$props",
+  "$$restProps",
+] as const;
+export const globalsForSvelte5 = [
+  "$state",
+  "$derived",
+  "$effect",
+  "$effect.pre",
+  "$props",
+] as const;
+export const globals = SVELTE_VERSION.startsWith("5")
+  ? [...globalsForSvelte4, ...globalsForSvelte5]
+  : globalsForSvelte4;

src/parser/index.ts

@@ -32,6 +32,7 @@ import {
   styleNodeLoc,
   styleNodeRange,
 } from "./style-context";
+import { globals } from "./globals";
 
 export {
   StyleContext,
@@ -122,7 +123,7 @@ export function parseForESLint(
   analyzeStoreScope(resultScript.scopeManager!); // for reactive vars
 
   // Add $$xxx variable
-  for (const $$name of ["$$slots", "$$props", "$$restProps"]) {
+  for (const $$name of globals) {
     const globalScope = resultScript.scopeManager!.globalScope;
     const variable = new Variable();
     variable.name = $$name;

src/parser/typescript/analyze/index.ts

@@ -16,12 +16,12 @@
 import type { TSESParseForESLintResult } from "../types";
 import type ESTree from "estree";
 import type { SvelteAttribute, SvelteHTMLElement } from "../../../ast";
+import { globalsForSvelte5, globals } from "../../../parser/globals";
 
 export type AnalyzeTypeScriptContext = {
   slots: Set<SvelteHTMLElement>;
 };
 
-const RESERVED_NAMES = new Set<string>(["$$props", "$$restProps", "$$slots"]);
 /**
  * Analyze TypeScript source code.
  * Generate virtual code to provide correct type information for Svelte store reference namess and scopes.
@@ -75,8 +75,8 @@
     if (
       // Begin with `$`.
       reference.identifier.name.startsWith("$") &&
-      // Ignore it is a reserved variable.
-      !RESERVED_NAMES.has(reference.identifier.name) &&
+      // Ignore globals
+      !globals.includes(reference.identifier.name) &&
       // Ignore if it is already defined.
       !programScope.set.has(reference.identifier.name)
     ) {
@@ -150,7 +150,7 @@
  * Analyze `$$slots`, `$$props`, and `$$restProps` .
  * Insert type definitions code to provide correct type information for `$$slots`, `$$props`, and `$$restProps`.
  */
 function analyzeDollarDollarVariables(
   result: TSESParseForESLintResult,
   ctx: VirtualTypeScriptContext,
   slots: Set<SvelteHTMLElement>,
@@ -215,9 +215,84 @@
     );
   }
 
+  for (const svelte5Global of globalsForSvelte5) {
+    switch (svelte5Global) {
+      case "$state": {
+        if (
+          scopeManager.globalScope!.through.some(
+            (reference) => reference.identifier.name === svelte5Global,
+          )
+        ) {
+          appendDeclareVirtualScript(
+            svelte5Global,
+            "<T>(initial: T): T",
+            "function",
+          );
+          appendDeclareVirtualScript(
+            svelte5Global,
+            "<T>(): T | undefined",
+            "function",
+          );
+        }
+        break;
+      }
+      case "$derived": {
+        if (
+          scopeManager.globalScope!.through.some(
+            (reference) => reference.identifier.name === svelte5Global,
+          )
+        ) {
+          appendDeclareVirtualScript(
+            svelte5Global,
+            "<T>(expression: T): T",
+            "function",
+          );
+        }
+        break;
+      }
+      case "$effect":
+      case "$effect.pre": {
+        if (
+          scopeManager.globalScope!.through.some(
+            (reference) => reference.identifier.name === svelte5Global,
+          )
+        ) {
+          appendDeclareVirtualScript(
+            svelte5Global,
+            "(fn: () => void | (() => void)): void",
+            "function",
+          );
+        }
+        break;
+      }
+      case "$props": {
+        if (
+          scopeManager.globalScope!.through.some(
+            (reference) => reference.identifier.name === svelte5Global,
+          )
+        ) {
+          appendDeclareVirtualScript(svelte5Global, "<T>(): T", "function");
+        }
+        break;
+      }
+      default: {
+        const _: never = svelte5Global;
+        throw Error(`Unknown global: ${_}`);
+      }
+    }
+  }
+
   /** Append declare virtual script */
-  function appendDeclareVirtualScript(name: string, type: string) {
-    ctx.appendVirtualScript(`declare let ${name}: ${type};`);
+  function appendDeclareVirtualScript(
+    name: string,
+    type: string,
+    letOrFunction: "let" | "function" = "let",
+  ) {
+    if (letOrFunction === "let") {
+      ctx.appendVirtualScript(`declare let ${name}: ${type};`);
+    } else {
+      ctx.appendVirtualScript(`declare function ${name}${type};`);
+    }
     ctx.restoreContext.addRestoreStatementProcess((node, result) => {
       if (
         node.type !== "VariableDeclaration" ||

tests/fixtures/parser/ast/$$slots-scope-output-svelte5.json

@@ -0,0 +1,144 @@
+{
+  "type": "global",
+  "variables": [
+    {
+      "name": "$$slots",
+      "identifiers": [],
+      "defs": [],
+      "references": [
+        {
+          "identifier": {
+            "type": "Identifier",
+            "name": "$$slots",
+            "range": [
+              5,
+              12
+            ],
+            "loc": {
+              "start": {
+                "line": 1,
+                "column": 5
+              },
+              "end": {
+                "line": 1,
+                "column": 12
+              }
+            }
+          },
+          "from": "module",
+          "init": null,
+          "resolved": null
+        }
+      ]
+    },
+    {
+      "name": "$$props",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
+    {
+      "name": "$$restProps",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
+    {
+      "name": "$state",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
+    {
+      "name": "$derived",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
+    {
+      "name": "$effect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
+    {
+      "name": "$effect.pre",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
+    {
+      "name": "$props",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    }
+  ],
+  "references": [],
+  "childScopes": [
+    {
+      "type": "module",
+      "variables": [],
+      "references": [
+        {
+          "identifier": {
+            "type": "Identifier",
+            "name": "$$slots",
+            "range": [
+              5,
+              12
+            ],
+            "loc": {
+              "start": {
+                "line": 1,
+                "column": 5
+              },
+              "end": {
+                "line": 1,
+                "column": 12
+              }
+            }
+          },
+          "from": "module",
+          "init": null,
+          "resolved": null
+        }
+      ],
+      "childScopes": [
+        {
+          "type": "block",
+          "variables": [],
+          "references": [],
+          "childScopes": [],
+          "through": []
+        }
+      ],
+      "through": [
+        {
+          "identifier": {
+            "type": "Identifier",
+            "name": "$$slots",
+            "range": [
+              5,
+              12
+            ],
+            "loc": {
+              "start": {
+                "line": 1,
+                "column": 5
+              },
+              "end": {
+                "line": 1,
+                "column": 12
+              }
+            }
+          },
+          "from": "module",
+          "init": null,
+          "resolved": null
+        }
+      ]
+    }
+  ],
+  "through": []
+}