https://github.com/ryanatkn/svelte-library-transitive-types-bug-reproduction
https://github.com/ryanatkn/svelte-library-transitive-types-bug-reproduction
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ryanatkn/svelte-library-transitive-types-bug-reproduction
- Owner: ryanatkn
- Created: 2024-09-28T21:19:21.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-01-23T18:49:43.000Z (4 months ago)
- Last Synced: 2025-02-07T01:24:48.581Z (4 months ago)
- Language: TypeScript
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# svelte-library-transitive-types-bug-reproduction
This is a reproduction of types generating incorrectly
with `svelte-package` for dependencies that get re-exported.
It appears that mismatches between file names/paths
and package.json `exports` aliases causes this.
(this is a fresh install of a `npm create svelte@latest` library project
with TypeScript and Svelte 5 - the same problem happens with Svelte 4,
and using `tsc` manually outputs the types as expected -
I last verified that the problem persists with all deps upgraded at
`@sveltejs/[email protected]`, `@sveltejs/[email protected]`, and `[email protected]`)
1. Run this command: (does not work on Windows, the script is simple to do manually)
```bash
npm install
npm run repro # copies `./fakepackage` to `node_modules` and runs `npm run package`
```
2. Inspect [dist/index.d.ts](/dist/index.d.ts)
which is generated from [src/lib/index.ts](/src/lib/index.ts):
```ts
// dist/index.d.ts
export declare const works_when_same_name_exported: "works_when_same_name";
export declare const broken_when_different_name_exported: any;
export declare const broken_when_different_path_exported: any;
```
Expected:
```diff
- export declare const broken_when_different_name_exported: any;
- export declare const broken_when_different_path_exported: any;
+ export declare const broken_when_different_name_exported: "broken_when_different_name";
+ export declare const broken_when_different_path_exported: "broken_when_different_path";
```
The same `any` type appears for other identifiers like classes, functions, instances, etc.
## Correctly generating the types
To see the first of the `any`s generate correctly, remove the `2`
in [src/lib/index.ts](/src/lib/index.ts) (the imported path)
and [fakepackage/package.json](/fakepackage/package.json) (the `"exports"` key),
then run `npm run repro` again and see the `any` changed in [dist/index.d.ts](/dist/index.d.ts).
```diff
// fakepackage/package.json
- "./broken_when_different_name2": {
+ "./broken_when_different_name": {
```
```diff
// src/lib/index.ts
- from 'fakepackage/broken_when_different_name2'
+ from 'fakepackage/broken_when_different_name'
```
To see the second generate correctly, add `dist/`
in [src/lib/index.ts](/src/lib/index.ts) (the imported path)
and [fakepackage/package.json](/fakepackage/package.json) (the `"exports"` key),
then run `npm run repro` again and see the `any` changed in [dist/index.d.ts](/dist/index.d.ts).
```diff
// fakepackage/package.json
- "./broken_when_different_path": {
+ "./dist/broken_when_different_path": {
```
```diff
// src/lib/index.ts
- from 'fakepackage/broken_when_different_path'
+ from 'fakepackage/dist/broken_when_different_path'
```
Instructions to see these published types work are also in [src/lib/index.ts](/src/lib/index.ts).
## Next steps
This may be a problem with [`dts-buddy`](https://github.com/Rich-Harris/dts-buddy)
or how SvelteKit is using it,
one next step is trying to reproduce directly with `dts-buddy`.