Types now working with SvelteKit 2 #176

ryanylee · 2023-12-14T18:25:59Z

Fixes #173

AdrianGonz97

It is also recommended for Svelte libraries to modify their moduleResolution and set it to NodeNext in their tsconfig.json, which adds stricter rules for import paths that enables wider compatibility for consumers.

AdrianGonz97 · 2023-12-16T20:20:35Z

package.json

 	},
 	"peerDependencies": {
-		"svelte": "^3 || ^4"
+		"svelte": "^4.2.8"


This is a breaking change and shouldn't be modified.

Suggested change

"svelte": "^4.2.8"

"svelte": "^3 || ^4"

Yes, we still want to support Svelte 3 as their APIs are similar.

AdrianGonz97 · 2023-12-16T20:22:33Z

package.json

 	},
-	"type": "module",
-	"svelte": "./index.js",


The svelte field should stay for backwards compatibility for older tooling. This would also be considered a breaking change. Updating it to point to the index.js in dist should suffice.

according to the vite docs, older tooling has always had support for this , and the use of
"svelte": "./index.js",
was just being supported since vite 3 , and support for that dropped in vite 5. so older tooling will work seamlessly with the use of exports

AdrianGonz97 · 2023-12-16T20:25:21Z

package.json

+	"exports": {
+		".": {
+			"types": "./dist/lib/index.d.ts",
+			"svelte": "./dist/index.js",
+			"import": "./dist/index.js"
+		},
+		"./plugins": {
+			"types": "./dist/lib/plugins/index.d.ts",
+			"svelte": "./dist/plugins/index.js",
+			"import": "./dist/plugins/index.js"
+		}
+	},


Suggested change

"exports": {

".": {

"types": "./dist/lib/index.d.ts",

"svelte": "./dist/index.js",

"import": "./dist/index.js"

},

"./plugins": {

"types": "./dist/lib/plugins/index.d.ts",

"svelte": "./dist/plugins/index.js",

"import": "./dist/plugins/index.js"

}

},

"exports": {

".": {

"types": "./dist/lib/index.d.ts",

"svelte": "./dist/index.js",

"default": "./dist/index.js"

},

"./plugins": {

"types": "./dist/lib/plugins/index.d.ts",

"svelte": "./dist/plugins/index.js",

"default": "./dist/plugins/index.js"

}

},

AdrianGonz97 · 2023-12-16T20:30:42Z

package.json

+		"@babel/core": "7.23.6",
+		"@babel/preset-env": "^7.23.6",
+		"@sveltejs/adapter-auto": "^3.0.0",
+		"@sveltejs/kit": "^2.0.0",
+		"@sveltejs/package": "^2.2.3",
+		"@testing-library/jest-dom": "^6.1.5",
+		"@testing-library/svelte": "^4.0.5",
 		"@types/faker": "5",
-		"@types/jest": "^27.4.1",
-		"@typescript-eslint/eslint-plugin": "^5.21.0",
-		"@typescript-eslint/parser": "^5.21.0",
-		"eslint": "^7.32.0",
-		"eslint-config-prettier": "^8.5.0",
-		"eslint-plugin-svelte3": "^3.4.1",
+		"@types/jest": "^29.5.11",
+		"@typescript-eslint/eslint-plugin": "^6.14.0",
+		"@typescript-eslint/parser": "^6.14.0",
+		"eslint": "^8.55.0",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-svelte": "^2.35.1",
 		"faker": "5",
-		"jest": "^27.5.1",
-		"prettier": "^2.6.2",
-		"prettier-plugin-svelte": "^2.7.0",
-		"svelte-check": "^2.7.0",
-		"svelte-jester": "^2.3.2",
-		"svelte-preprocess": "^4.10.6",
-		"svelte2tsx": "^0.5.9",
-		"ts-jest": "^27.1.4",
-		"tslib": "^2.4.0",
-		"typescript": "^4.7.4",
-		"vite": "^4.0.3"
+		"jest": "^29.7.0",
+		"prettier": "^3.1.1",
+		"prettier-plugin-svelte": "^3.1.2",
+		"svelte-check": "^3.6.2",
+		"svelte-jester": "^3.0.0",
+		"svelte-preprocess": "^5.1.2",
+		"svelte2tsx": "^0.6.27",
+		"ts-jest": "^29.1.1",
+		"tslib": "^2.6.2",
+		"typescript": "^5.3.3",
+		"vite": "^5.0.9"
 	},
 	"dependencies": {
-		"svelte-keyed": "^1.1.6",
+		"svelte-keyed": "^1.1.7",
 		"svelte-render": "^1.6.1",
-		"svelte-subscribe": "^1.0.5"
+		"svelte-subscribe": "^1.0.6"
 	},


Updating all of these dependencies seems out of the scope of this PR. Just pointing this out so that the maintainer is aware.

Yes, we don't want to update all these dependencies in this PR.

However, I'm not sure what the implications are for updating the development dependency to SvelteKit 2.0. Will doing so break compatibility with SvelteKit 1.0?

@bryanmylee Fortunately, upgrading to v2 shouldn't break compatibility at all. Likewise, staying on v1 would also be a viable option.

The only necessary changes that are needed to support SvelteKit v2 would be to:

update the exports map in package.json (already done)

add moduleResolution: "NodeNext" to tsconfig.config

update all of the import paths to include file extensions (e.g. import { foo } from "./foo.js") to satisfy the new moduleResolution strategy

Edit: Oh, and updating @sveltejs/package to v2 is a good change as well.

bryanmylee · 2023-12-17T18:50:32Z

Thanks @ryanylee and @AdrianGonz97! The PR helps a lot especially when I haven't had much time to work on this. Just a few issues to resolve, then I'll merge and make a major release update.

ryanylee · 2023-12-18T00:45:28Z

One thing to note is svelte-render needs to also be updated at some point, but the easy workaround for now in this PR is importing from the /createRender file rather than the root index.js

Thank you @AdrianGonz97 for the feedback!

AdrianGonz97

Looks good! Just noticed a few things, but the rest is great 🙂

svelte-render should probably be updated before merging this PR as it's contents are being reexported in src/lib/index.ts, so anything coming from that, like createRender, will have their types all bunged up.

I can open a separate PR for svelte-render to address this issue.

AdrianGonz97 · 2023-12-18T05:07:00Z

package.json

+			"types": "./dist/lib/index.d.ts",
+			"svelte": "./dist/index.js",
+			"default": "./dist/index.js"
+		},
+		"./plugins": {
+			"types": "./dist/lib/plugins/index.d.ts",


Suggested change

"types": "./dist/lib/index.d.ts",

"svelte": "./dist/index.js",

"default": "./dist/index.js"

},

"./plugins": {

"types": "./dist/lib/plugins/index.d.ts",

"types": "./dist/index.d.ts",

"svelte": "./dist/index.js",

"default": "./dist/index.js"

},

"./plugins": {

"types": "./dist/plugins/index.d.ts",

AdrianGonz97 · 2023-12-18T05:08:05Z

.npmignore

@@ -1,7 +1,7 @@
 node_modules
 /build
 /.svelte-kit
-/package
+/dist


this doesn't need to be ignored

Suggested change

/dist

bryanmylee · 2023-12-19T15:46:14Z

Updating SvelteKit to 2.x causes conflicts with our peer dependencies for Svelte 3.

Trying to update all my Svelte packages to keep up with SvelteKit has been an absolute shitshow of broken dependencies.

I'm going to spend a day just recreating the entire library along with all the dependent stuff, but this is ridiculous.

pheuter · 2023-12-20T12:49:00Z

It does appear that SvelteKit 2 intentionally drops support for Svelte 3:

We also recommend updating to Svelte 4 first: Later versions of SvelteKit 1.x support it, and SvelteKit 2.0 requires it.

ryanylee added 2 commits December 14, 2023 13:23

working with sveltekit-2

a10ff41

remove pnpm

7b0dc3a

vercel bot deployed to Preview December 14, 2023 18:27 View deployment

ignore test

f4a6495

vercel bot deployed to Preview December 14, 2023 18:46 View deployment

AdrianGonz97 reviewed Dec 16, 2023

View reviewed changes

vercel bot deployed to Preview December 17, 2023 23:56 View deployment

ryanylee force-pushed the main branch from 98e01a4 to f4a6495 Compare December 18, 2023 00:07

revert unneeded package updates

77d187f

vercel bot deployed to Preview December 18, 2023 00:19 View deployment

ryanylee added 2 commits December 17, 2023 19:20

remove pnpm file oops

4752c1a

fix gitignore

eb95efc

vercel bot deployed to Preview December 18, 2023 00:22 View deployment

update file extensions for imports

3be2508

vercel bot deployed to Preview December 18, 2023 00:43 View deployment

ryanylee requested a review from bryanmylee December 18, 2023 01:37

AdrianGonz97 reviewed Dec 18, 2023

View reviewed changes

AdrianGonz97 mentioned this pull request Dec 18, 2023

fix: Added missing exports map and use NodeNext for TypeScript bryanmylee/svelte-render#4

Merged

fix mistakes

bb96fcf

vercel bot deployed to Preview December 18, 2023 18:05 View deployment

bryanmylee merged commit 626cccc into bryanmylee:main Jan 2, 2024
1 of 2 checks passed

This was referenced Jan 2, 2024

Add missing exports condition #178

Closed

Could not find a declaration file for module 'sveltekit-headless-table' #157

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Types now working with SvelteKit 2 #176

Types now working with SvelteKit 2 #176

ryanylee commented Dec 14, 2023 •

edited

Loading

AdrianGonz97 left a comment •

edited

Loading

AdrianGonz97 Dec 16, 2023

bryanmylee Dec 17, 2023

AdrianGonz97 Dec 16, 2023

shiftlabs1 Jan 1, 2024

AdrianGonz97 Dec 16, 2023

AdrianGonz97 Dec 16, 2023

bryanmylee Dec 17, 2023

AdrianGonz97 Dec 17, 2023 •

edited

Loading

bryanmylee commented Dec 17, 2023

ryanylee commented Dec 18, 2023

AdrianGonz97 left a comment

AdrianGonz97 Dec 18, 2023

AdrianGonz97 Dec 18, 2023

bryanmylee commented Dec 19, 2023 •

edited

Loading

pheuter commented Dec 20, 2023 •

edited

Loading

Types now working with SvelteKit 2 #176

Types now working with SvelteKit 2 #176

Conversation

ryanylee commented Dec 14, 2023 • edited Loading

AdrianGonz97 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdrianGonz97 Dec 17, 2023 • edited Loading

Choose a reason for hiding this comment

bryanmylee commented Dec 17, 2023

ryanylee commented Dec 18, 2023

AdrianGonz97 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bryanmylee commented Dec 19, 2023 • edited Loading

pheuter commented Dec 20, 2023 • edited Loading

ryanylee commented Dec 14, 2023 •

edited

Loading

AdrianGonz97 left a comment •

edited

Loading

AdrianGonz97 Dec 17, 2023 •

edited

Loading

bryanmylee commented Dec 19, 2023 •

edited

Loading

pheuter commented Dec 20, 2023 •

edited

Loading