chore: better "cannot use bind:" error message (#2429)

sveltejs · Jul 2, 2024 · 027ab23 · 027ab23
1 parent 8d3a335
commit 027ab23
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 11 deletions.
diff --git a/packages/language-server/src/plugins/typescript/features/DiagnosticsProvider.ts b/packages/language-server/src/plugins/typescript/features/DiagnosticsProvider.ts
@@ -21,14 +21,7 @@ import {
     isStoreVariableIn$storeDeclaration,
     get$storeOffsetOf$storeDeclaration
 } from './utils';
-import {
-    not,
-    flatten,
-    passMap,
-    swapRangeStartEndIfNecessary,
-    memoize,
-    traverseTypeString
-} from '../../../utils';
+import { not, flatten, passMap, swapRangeStartEndIfNecessary, memoize } from '../../../utils';
 import { LSConfigManager } from '../../../ls-config';
 import { isAttributeName, isEventHandler } from '../svelte-ast-utils';
 
@@ -206,7 +199,25 @@ function moveBindingErrorMessage(
                 (attr: any) => attr.type === 'Binding' && attr.name === name
             );
             if (binding) {
-                diagnostic.message = 'Cannot bind: to this property\n\n' + diagnostic.message;
+                // try to make the error more readable for english users
+                if (
+                    diagnostic.message.startsWith("Type '") &&
+                    diagnostic.message.includes("is not assignable to type '")
+                ) {
+                    const idx = diagnostic.message.indexOf(`Type '"`) + `Type '"`.length;
+                    const propName = diagnostic.message.substring(
+                        idx,
+                        diagnostic.message.indexOf('"', idx)
+                    );
+                    diagnostic.message =
+                        "Cannot use 'bind:' with this property. It is declared as non-bindable inside the component.\n" +
+                        `To mark a property as bindable: 'let { ${propName} = $bindable() = $props()'`;
+                } else {
+                    diagnostic.message =
+                        "Cannot use 'bind:' with this property. It is declared as non-bindable inside the component.\n" +
+                        `To mark a property as bindable: 'let { prop = $bindable() = $props()'\n\n` +
+                        diagnostic.message;
+                }
                 diagnostic.range = {
                     start: document.positionAt(binding.start),
                     end: document.positionAt(binding.end)

diff --git a/...ver/test/plugins/typescript/features/diagnostics/fixtures/bindings/expected_svelte_5.json b/...ver/test/plugins/typescript/features/diagnostics/fixtures/bindings/expected_svelte_5.json
@@ -1,7 +1,7 @@
 [
     {
         "code": 2322,
-        "message": "Cannot bind: to this property\n\nType '\"readonly\"' is not assignable to type '\"can_bind\"'.",
+        "message": "Cannot use 'bind:' with this property. It is declared as non-bindable inside the component.\nTo mark a property as bindable: 'let { readonly = $bindable() = $props()'",
         "range": {
             "end": {
                 "character": 20,
@@ -35,7 +35,7 @@
     },
     {
         "code": 2322,
-        "message": "Cannot bind: to this property\n\nType '\"only_bind\"' is not assignable to type '\"can_bind\"'.",
+        "message": "Cannot use 'bind:' with this property. It is declared as non-bindable inside the component.\nTo mark a property as bindable: 'let { only_bind = $bindable() = $props()'",
         "range": {
             "end": {
                 "character": 21,