feat: add support for $inspect and $effect.root (#446)

sveltejs · Dec 2, 2023 · 168f920 · 168f920
1 parent 50dd335
commit 168f920
Show file tree

Hide file tree

Showing 81 changed files with 14,785 additions and 3 deletions.
diff --git a/.changeset/twenty-cats-shave.md b/.changeset/twenty-cats-shave.md
@@ -0,0 +1,5 @@
+---
+"svelte-eslint-parser": minor
+---
+
+feat: add support for `$inspect` and `$effect.root`
diff --git a/explorer-v2/package.json b/explorer-v2/package.json
@@ -18,7 +18,7 @@
 		"eslint-scope": "^7.2.2",
 		"esquery": "^1.5.0",
 		"pako": "^2.1.0",
-		"svelte": "^5.0.0-next.10",
+		"svelte": "^5.0.0-next.17",
 		"svelte-eslint-parser": "link:..",
 		"tslib": "^2.6.2"
 	},

diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
     "version:ci": "env-cmd -e version-ci pnpm run build:meta && changeset version"
   },
   "peerDependencies": {
-    "svelte": "^3.37.0 || ^4.0.0 || ^5.0.0-next.10"
+    "svelte": "^3.37.0 || ^4.0.0 || ^5.0.0-next.17"
   },
   "peerDependenciesMeta": {
     "svelte": {
@@ -104,7 +104,7 @@
     "prettier-plugin-svelte": "^3.0.0",
     "rimraf": "^5.0.1",
     "semver": "^7.5.1",
-    "svelte": "^5.0.0-next.10",
+    "svelte": "^5.0.0-next.17",
     "svelte2tsx": "^0.6.25",
     "typescript": "~5.1.3",
     "typescript-eslint-parser-for-extra-files": "^0.5.0"

diff --git a/src/parser/globals.ts b/src/parser/globals.ts
@@ -6,6 +6,7 @@ export const globalsForRunes = [
   "$derived",
   "$effect",
   "$props",
+  "$inspect",
 ] as const;
 const globalsForSvelte5 = [...globalsForSvelte4, ...globalsForRunes];
 export const globals = svelteVersion.gte(5)

diff --git a/src/parser/typescript/analyze/index.ts b/src/parser/typescript/analyze/index.ts
@@ -256,6 +256,7 @@ function analyzeDollarDollarVariables(
       case "$derived":
       case "$effect":
       case "$props":
+      case "$inspect":
         // Processed by `analyzeRuneVariables`.
         break;
       default: {
@@ -332,13 +333,20 @@ function analyzeRuneVariables(
         appendDeclareNamespaceVirtualScripts(globalName, [
           "export function pre(fn: () => void | (() => void)): void;",
           "export function active(): boolean;",
+          "export function root(fn: () => void | (() => void)): () => void;",
         ]);
         break;
       }
       case "$props": {
         appendDeclareFunctionVirtualScripts(globalName, ["<T>(): T"]);
         break;
       }
+      case "$inspect": {
+        appendDeclareFunctionVirtualScripts(globalName, [
+          `<T>(value: T, callback?: (value: T, type: 'init' | 'update') => void): void`,
+        ]);
+        break;
+      }
       default: {
         const _: never = globalName;
         throw Error(`Unknown global: ${_}`);

diff --git a/tests/fixtures/parser/ast/$$slots-scope-output-svelte5.json b/tests/fixtures/parser/ast/$$slots-scope-output-svelte5.json
@@ -65,6 +65,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ]
 }
diff --git a/...ures/parser/ast/docs/template-syntax/02-attributes-and-props/10-scope-output-svelte5.json b/...ures/parser/ast/docs/template-syntax/02-attributes-and-props/10-scope-output-svelte5.json
@@ -65,6 +65,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ]
 }
diff --git a/...ures/parser/ast/docs/template-syntax/02-attributes-and-props/11-scope-output-svelte5.json b/...ures/parser/ast/docs/template-syntax/02-attributes-and-props/11-scope-output-svelte5.json
@@ -65,6 +65,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ]
 }
diff --git a/.../fixtures/parser/ast/docs/template-syntax/13-slot/02-$$slots/01-scope-output-svelte5.json b/.../fixtures/parser/ast/docs/template-syntax/13-slot/02-$$slots/01-scope-output-svelte5.json
@@ -65,6 +65,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ]
 }
diff --git a/tests/fixtures/parser/ast/svelte5/docs/fine-grained-reactivity/example01-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/fine-grained-reactivity/example01-scope-output.json
@@ -112,6 +112,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/functions/01-untrack-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/functions/01-untrack-scope-output.json
@@ -90,6 +90,12 @@
           "resolved": null
         }
       ]
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/old-vs-new/01-counter-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/old-vs-new/01-counter-scope-output.json
@@ -114,6 +114,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/old-vs-new/02-tracking-dependencies-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/old-vs-new/02-tracking-dependencies-scope-output.json
@@ -113,6 +113,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/.../fixtures/parser/ast/svelte5/docs/old-vs-new/03-untracking-dependencies-scope-output.json b/.../fixtures/parser/ast/svelte5/docs/old-vs-new/03-untracking-dependencies-scope-output.json
@@ -113,6 +113,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/...s/fixtures/parser/ast/svelte5/docs/old-vs-new/04-simple-component-props-scope-output.json b/...s/fixtures/parser/ast/svelte5/docs/old-vs-new/04-simple-component-props-scope-output.json
@@ -66,6 +66,12 @@
           "resolved": null
         }
       ]
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/...fixtures/parser/ast/svelte5/docs/old-vs-new/05-advanced-component-props-scope-output.json b/...fixtures/parser/ast/svelte5/docs/old-vs-new/05-advanced-component-props-scope-output.json
@@ -66,6 +66,12 @@
           "resolved": null
         }
       ]
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/old-vs-new/06-autoscroll-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/old-vs-new/06-autoscroll-scope-output.json
@@ -113,6 +113,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/01-$state-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/01-$state-scope-output.json
@@ -66,6 +66,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/02-$derived-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/02-$derived-scope-output.json
@@ -90,6 +90,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/03-$effect-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/03-$effect-scope-output.json
@@ -114,6 +114,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/04-$effect-pre-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/04-$effect-pre-scope-output.json
@@ -66,6 +66,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/05-$props-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/05-$props-scope-output.json
@@ -66,6 +66,12 @@
           "resolved": null
         }
       ]
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/06-$props-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/06-$props-scope-output.json
@@ -66,6 +66,12 @@
           "resolved": null
         }
       ]
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/07-$props-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/07-$props-scope-output.json
@@ -66,6 +66,12 @@
           "resolved": null
         }
       ]
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/08-$props-ts-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/08-$props-ts-scope-output.json
@@ -66,6 +66,12 @@
           "resolved": null
         }
       ]
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/09-how-to-opt-in-scope-output.json b/tests/fixtures/parser/ast/svelte5/docs/runes/09-how-to-opt-in-scope-output.json
@@ -42,6 +42,12 @@
       "identifiers": [],
       "defs": [],
       "references": []
+    },
+    {
+      "name": "$inspect",
+      "identifiers": [],
+      "defs": [],
+      "references": []
     }
   ],
   "references": [],

diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/10-$effect-root-input.svelte b/tests/fixtures/parser/ast/svelte5/docs/runes/10-$effect-root-input.svelte
@@ -0,0 +1,13 @@
+<script>
+	let count = $state(0);
+
+	const cleanup = $effect.root(() => {
+		$effect(() => {
+			console.log(count);
+		});
+
+		return () => {
+			console.log('effect root cleanup');
+		};
+	});
+</script>
diff --git a/tests/fixtures/parser/ast/svelte5/docs/runes/10-$effect-root-no-unused-vars-result.json b/tests/fixtures/parser/ast/svelte5/docs/runes/10-$effect-root-no-unused-vars-result.json
@@ -0,0 +1,8 @@
+[
+  {
+    "ruleId": "no-unused-vars",
+    "code": "cleanup",
+    "line": 4,
+    "column": 8
+  }
+]