Skip to content

Commit 999b92d

Browse files
ottomatedRich-Harris
ottomated
and
Rich-Harris
authored
fix: intellisense DX for $props, $inspect, $bindable, and $host (#14777)
* remove default function types for $props, $inspect, $bindable, and $host * changeset * regenerate types * add helper message for type regeneration * append a newline to generated types * prettier --------- Co-authored-by: Rich Harris <[email protected]>
1 parent 5bc4033 commit 999b92d

File tree

6 files changed

+190
-3
lines changed

6 files changed

+190
-3
lines changed

‎.changeset/three-suits-pay.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'svelte': patch
3+
---
4+
5+
fix: Improve typescript DX for $inspect, $props, $bindable, and $host

‎.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ jobs:
5959
run: pnpm lint
6060
- name: build and check generated types
6161
if: (${{ success() }} || ${{ failure() }}) # ensures this step runs even if previous steps fail
62-
run: pnpm build && { [ "`git status --porcelain=v1`" == "" ] || (echo "Generated types have changed — please regenerate types locally and commit the changes after you have reviewed them"; git diff; exit 1); }
62+
run: pnpm build && { [ "`git status --porcelain=v1`" == "" ] || (echo "Generated types have changed — please regenerate types locally with `cd packages/svelte && pnpm generate:types` and commit the changes after you have reviewed them"; git diff; exit 1); }
6363
Benchmarks:
6464
runs-on: ubuntu-latest
6565
timeout-minutes: 15

‎.github/workflows/release.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
run: pnpm install --frozen-lockfile
3434

3535
- name: Build
36-
run: pnpm build && { [ "`git status --porcelain=v1`" == "" ] || (echo "Generated types have changed — please regenerate types locally and commit the changes after you have reviewed them"; git diff; exit 1); }
36+
run: pnpm build && { [ "`git status --porcelain=v1`" == "" ] || (echo "Generated types have changed — please regenerate types locally with `cd packages/svelte && pnpm generate:types` and commit the changes after you have reviewed them"; git diff; exit 1); }
3737

3838
- name: Create Release Pull Request or Publish to npm
3939
id: changesets

‎packages/svelte/scripts/generate-types.js

+2
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ await createBundle({
4646
}
4747
});
4848

49+
fs.appendFileSync(`${dir}/types/index.d.ts`, '\n');
50+
4951
const types = fs.readFileSync(`${dir}/types/index.d.ts`, 'utf-8');
5052

5153
const bad_links = [...types.matchAll(/\]\((\/[^)]+)\)/g)];

‎packages/svelte/src/ambient.d.ts

+90
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,29 @@ declare namespace $effect {
338338
*/
339339
declare function $props(): any;
340340

341+
declare namespace $props {
342+
// prevent intellisense from being unhelpful
343+
/** @deprecated */
344+
export const apply: never;
345+
/** @deprecated */
346+
// @ts-ignore
347+
export const arguments: never;
348+
/** @deprecated */
349+
export const bind: never;
350+
/** @deprecated */
351+
export const call: never;
352+
/** @deprecated */
353+
export const caller: never;
354+
/** @deprecated */
355+
export const length: never;
356+
/** @deprecated */
357+
export const name: never;
358+
/** @deprecated */
359+
export const prototype: never;
360+
/** @deprecated */
361+
export const toString: never;
362+
}
363+
341364
/**
342365
* Declares a prop as bindable, meaning the parent component can use `bind:propName={value}` to bind to it.
343366
*
@@ -349,6 +372,29 @@ declare function $props(): any;
349372
*/
350373
declare function $bindable<T>(fallback?: T): T;
351374

375+
declare namespace $bindable {
376+
// prevent intellisense from being unhelpful
377+
/** @deprecated */
378+
export const apply: never;
379+
/** @deprecated */
380+
// @ts-ignore
381+
export const arguments: never;
382+
/** @deprecated */
383+
export const bind: never;
384+
/** @deprecated */
385+
export const call: never;
386+
/** @deprecated */
387+
export const caller: never;
388+
/** @deprecated */
389+
export const length: never;
390+
/** @deprecated */
391+
export const name: never;
392+
/** @deprecated */
393+
export const prototype: never;
394+
/** @deprecated */
395+
export const toString: never;
396+
}
397+
352398
/**
353399
* Inspects one or more values whenever they, or the properties they contain, change. Example:
354400
*
@@ -388,6 +434,27 @@ declare namespace $inspect {
388434
* </script>
389435
*/
390436
export function trace(name: string): void;
437+
438+
// prevent intellisense from being unhelpful
439+
/** @deprecated */
440+
export const apply: never;
441+
/** @deprecated */
442+
// @ts-ignore
443+
export const arguments: never;
444+
/** @deprecated */
445+
export const bind: never;
446+
/** @deprecated */
447+
export const call: never;
448+
/** @deprecated */
449+
export const caller: never;
450+
/** @deprecated */
451+
export const length: never;
452+
/** @deprecated */
453+
export const name: never;
454+
/** @deprecated */
455+
export const prototype: never;
456+
/** @deprecated */
457+
export const toString: never;
391458
}
392459

393460
/**
@@ -410,3 +477,26 @@ declare namespace $inspect {
410477
* https://svelte.dev/docs/svelte/$host
411478
*/
412479
declare function $host<El extends HTMLElement = HTMLElement>(): El;
480+
481+
declare namespace $host {
482+
// prevent intellisense from being unhelpful
483+
/** @deprecated */
484+
export const apply: never;
485+
/** @deprecated */
486+
// @ts-ignore
487+
export const arguments: never;
488+
/** @deprecated */
489+
export const bind: never;
490+
/** @deprecated */
491+
export const call: never;
492+
/** @deprecated */
493+
export const caller: never;
494+
/** @deprecated */
495+
export const length: never;
496+
/** @deprecated */
497+
export const name: never;
498+
/** @deprecated */
499+
export const prototype: never;
500+
/** @deprecated */
501+
export const toString: never;
502+
}

‎packages/svelte/types/index.d.ts

+91-1
Original file line numberDiff line numberDiff line change
@@ -2996,6 +2996,29 @@ declare namespace $effect {
29962996
*/
29972997
declare function $props(): any;
29982998

2999+
declare namespace $props {
3000+
// prevent intellisense from being unhelpful
3001+
/** @deprecated */
3002+
export const apply: never;
3003+
/** @deprecated */
3004+
// @ts-ignore
3005+
export const arguments: never;
3006+
/** @deprecated */
3007+
export const bind: never;
3008+
/** @deprecated */
3009+
export const call: never;
3010+
/** @deprecated */
3011+
export const caller: never;
3012+
/** @deprecated */
3013+
export const length: never;
3014+
/** @deprecated */
3015+
export const name: never;
3016+
/** @deprecated */
3017+
export const prototype: never;
3018+
/** @deprecated */
3019+
export const toString: never;
3020+
}
3021+
29993022
/**
30003023
* Declares a prop as bindable, meaning the parent component can use `bind:propName={value}` to bind to it.
30013024
*
@@ -3007,6 +3030,29 @@ declare function $props(): any;
30073030
*/
30083031
declare function $bindable<T>(fallback?: T): T;
30093032

3033+
declare namespace $bindable {
3034+
// prevent intellisense from being unhelpful
3035+
/** @deprecated */
3036+
export const apply: never;
3037+
/** @deprecated */
3038+
// @ts-ignore
3039+
export const arguments: never;
3040+
/** @deprecated */
3041+
export const bind: never;
3042+
/** @deprecated */
3043+
export const call: never;
3044+
/** @deprecated */
3045+
export const caller: never;
3046+
/** @deprecated */
3047+
export const length: never;
3048+
/** @deprecated */
3049+
export const name: never;
3050+
/** @deprecated */
3051+
export const prototype: never;
3052+
/** @deprecated */
3053+
export const toString: never;
3054+
}
3055+
30103056
/**
30113057
* Inspects one or more values whenever they, or the properties they contain, change. Example:
30123058
*
@@ -3046,6 +3092,27 @@ declare namespace $inspect {
30463092
* </script>
30473093
*/
30483094
export function trace(name: string): void;
3095+
3096+
// prevent intellisense from being unhelpful
3097+
/** @deprecated */
3098+
export const apply: never;
3099+
/** @deprecated */
3100+
// @ts-ignore
3101+
export const arguments: never;
3102+
/** @deprecated */
3103+
export const bind: never;
3104+
/** @deprecated */
3105+
export const call: never;
3106+
/** @deprecated */
3107+
export const caller: never;
3108+
/** @deprecated */
3109+
export const length: never;
3110+
/** @deprecated */
3111+
export const name: never;
3112+
/** @deprecated */
3113+
export const prototype: never;
3114+
/** @deprecated */
3115+
export const toString: never;
30493116
}
30503117

30513118
/**
@@ -3069,4 +3136,27 @@ declare namespace $inspect {
30693136
*/
30703137
declare function $host<El extends HTMLElement = HTMLElement>(): El;
30713138

3072-
//# sourceMappingURL=index.d.ts.map
3139+
declare namespace $host {
3140+
// prevent intellisense from being unhelpful
3141+
/** @deprecated */
3142+
export const apply: never;
3143+
/** @deprecated */
3144+
// @ts-ignore
3145+
export const arguments: never;
3146+
/** @deprecated */
3147+
export const bind: never;
3148+
/** @deprecated */
3149+
export const call: never;
3150+
/** @deprecated */
3151+
export const caller: never;
3152+
/** @deprecated */
3153+
export const length: never;
3154+
/** @deprecated */
3155+
export const name: never;
3156+
/** @deprecated */
3157+
export const prototype: never;
3158+
/** @deprecated */
3159+
export const toString: never;
3160+
}
3161+
3162+
//# sourceMappingURL=index.d.ts.map

0 commit comments

Comments
 (0)