feat: add support for $bindable rune & update deps (#498)

sveltejs · Apr 7, 2024 · 3b2c62b · 3b2c62b
1 parent 85c75b1
commit 3b2c62b
Show file tree

Hide file tree

Showing 97 changed files with 4,938 additions and 18 deletions.
diff --git a/.changeset/great-meals-travel.md b/.changeset/great-meals-travel.md
@@ -0,0 +1,5 @@
+---
+"svelte-eslint-parser": minor
+---
+
+feat: add support for `$bindable` rune
diff --git a/package.json b/package.json
@@ -47,7 +47,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.69"
+    "svelte": "^3.37.0 || ^4.0.0 || ^5.0.0-next.94"
   },
   "peerDependenciesMeta": {
     "svelte": {
@@ -58,56 +58,56 @@
     "eslint-scope": "^7.2.2",
     "eslint-visitor-keys": "^3.4.3",
     "espree": "^9.6.1",
-    "postcss": "^8.4.35",
+    "postcss": "^8.4.38",
     "postcss-scss": "^4.0.9"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.1",
     "@changesets/get-release-plan": "^4.0.0",
-    "@ota-meshi/eslint-plugin": "^0.15.2",
+    "@ota-meshi/eslint-plugin": "^0.15.3",
     "@types/benchmark": "^2.1.5",
-    "@types/chai": "^4.3.12",
-    "@types/eslint": "^8.56.5",
+    "@types/chai": "^4.3.14",
+    "@types/eslint": "^8.56.7",
     "@types/eslint-scope": "^3.7.7",
-    "@types/eslint-visitor-keys": "^3.0.0",
+    "@types/eslint-visitor-keys": "^3.3.0",
     "@types/estree": "^1.0.5",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.22",
+    "@types/node": "^20.12.5",
     "@types/semver": "^7.5.8",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
+    "@typescript-eslint/eslint-plugin": "^7.5.0",
     "@typescript-eslint/parser": "~7.5.0",
     "@typescript-eslint/types": "~7.5.0",
     "benchmark": "^2.1.4",
     "chai": "^4.4.1",
     "env-cmd": "^10.1.0",
-    "esbuild": "^0.20.1",
+    "esbuild": "^0.20.2",
     "esbuild-register": "^3.5.0",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-json-schema-validator": "^5.0.0",
-    "eslint-plugin-jsonc": "^2.13.0",
+    "eslint-plugin-json-schema-validator": "^5.1.0",
+    "eslint-plugin-jsonc": "^2.15.0",
     "eslint-plugin-n": "^16.6.2",
     "eslint-plugin-node-dependencies": "^0.11.2",
     "eslint-plugin-prettier": "^5.1.3",
-    "eslint-plugin-regexp": "^2.2.0",
+    "eslint-plugin-regexp": "^2.4.0",
     "eslint-plugin-svelte": "^2.35.1",
-    "eslint-plugin-yml": "^1.12.2",
+    "eslint-plugin-yml": "^1.14.0",
     "estree-walker": "^3.0.3",
     "locate-character": "^3.0.0",
-    "magic-string": "^0.30.7",
-    "mocha": "^10.3.0",
+    "magic-string": "^0.30.9",
+    "mocha": "^10.4.0",
     "mocha-chai-jest-snapshot": "^1.1.4",
     "nyc": "^15.1.0",
     "prettier": "~3.2.5",
     "prettier-plugin-pkg": "^0.18.1",
     "prettier-plugin-svelte": "^3.2.2",
     "rimraf": "^5.0.5",
     "semver": "^7.6.0",
-    "svelte": "^5.0.0-next.69",
-    "svelte2tsx": "^0.7.3",
-    "typescript": "~5.4.0",
+    "svelte": "^5.0.0-next.94",
+    "svelte2tsx": "^0.7.6",
+    "typescript": "~5.4.4",
     "typescript-eslint-parser-for-extra-files": "^0.6.0"
   },
   "publishConfig": {

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

diff --git a/src/parser/typescript/analyze/index.ts b/src/parser/typescript/analyze/index.ts
@@ -260,6 +260,7 @@ function analyzeDollarDollarVariables(
       case "$derived":
       case "$effect":
       case "$props":
+      case "$bindable":
       case "$inspect":
         // Processed by `analyzeRuneVariables`.
         break;
@@ -317,6 +318,7 @@ function analyzeRuneVariables(
       continue;
     }
     switch (globalName) {
+      // See https://github.com/sveltejs/svelte/blob/dfc55c18f010f620b966e13eb0ad1f9791b5798f/packages/svelte/types/index.d.ts#L2492
       case "$state": {
         appendDeclareFunctionVirtualScripts(globalName, [
           "<T>(initial: T): T",
@@ -328,6 +330,7 @@ function analyzeRuneVariables(
         ]);
         break;
       }
+      // See https://github.com/sveltejs/svelte/blob/dfc55c18f010f620b966e13eb0ad1f9791b5798f/packages/svelte/types/index.d.ts#L2535
       case "$derived": {
         appendDeclareFunctionVirtualScripts(globalName, [
           "<T>(expression: T): T",
@@ -337,6 +340,7 @@ function analyzeRuneVariables(
         ]);
         break;
       }
+      // See https://github.com/sveltejs/svelte/blob/dfc55c18f010f620b966e13eb0ad1f9791b5798f/packages/svelte/types/index.d.ts#L2574
       case "$effect": {
         appendDeclareFunctionVirtualScripts(globalName, [
           "(fn: () => void | (() => void)): void",
@@ -348,10 +352,17 @@ function analyzeRuneVariables(
         ]);
         break;
       }
+      // See https://github.com/sveltejs/svelte/blob/dfc55c18f010f620b966e13eb0ad1f9791b5798f/packages/svelte/types/index.d.ts#L2655
       case "$props": {
         appendDeclareFunctionVirtualScripts(globalName, ["<T>(): T"]);
         break;
       }
+      // See https://github.com/sveltejs/svelte/blob/dfc55c18f010f620b966e13eb0ad1f9791b5798f/packages/svelte/types/index.d.ts#L2666
+      case "$bindable": {
+        appendDeclareFunctionVirtualScripts(globalName, ["<T>(t?: T): T"]);
+        break;
+      }
+      // See https://github.com/sveltejs/svelte/blob/dfc55c18f010f620b966e13eb0ad1f9791b5798f/packages/svelte/types/index.d.ts#L2686
       case "$inspect": {
         appendDeclareFunctionVirtualScripts(globalName, [
           `<T extends any[]>(...values: T): { with: (fn: (type: 'init' | 'update', ...values: T) => void) => void }`,

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

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
@@ -66,6 +66,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -66,6 +66,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -66,6 +66,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -113,6 +113,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -91,6 +91,12 @@
         }
       ]
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -115,6 +115,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -114,6 +114,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -114,6 +114,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -67,6 +67,12 @@
         }
       ]
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -67,6 +67,12 @@
         }
       ]
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -114,6 +114,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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

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
@@ -67,6 +67,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -91,6 +91,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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

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
@@ -115,6 +115,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -67,6 +67,12 @@
       "defs": [],
       "references": []
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],

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
@@ -67,6 +67,12 @@
         }
       ]
     },
+    {
+      "name": "$bindable",
+      "identifiers": [],
+      "defs": [],
+      "references": []
+    },
     {
       "name": "$inspect",
       "identifiers": [],