chore: unbundled esm by dummdidumm · Pull Request #8613 · sveltejs/svelte

dummdidumm · 2023-05-22T13:24:59Z

BREAKING CHANGE cjs support removed

Svelte no longer supports CJS as a compiler output and its runtime version of CJS and the register hook is removed, too. Use a bundler like Vite or our full-stack framework SvelteKit instead.

Changes

remove esm bundle step
introduce generated version.js because we can no longer use replace because we don't bundle esm
remove register hook, cjs compiler output and cjs runtime
keep umd compiler version for prettier/eslint/browser but without sourcemaps
move devdependencies to dependencies where necessary
various cleanup

Before submitting the PR, please make sure you do the following

It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. For large changes, please create an RFC: https://github.com/sveltejs/rfcs
Prefix your PR title with feat:, fix:, chore:, or docs:.
This message body should clearly illustrate what problems it solves.
Ideally, include a test that fails without this PR but passes with it.

Tests

Run the tests with npm test and lint the project with npm run lint

- removes esm bundle step - introduces generated version.js because we can no longer use replace because we don't bundle esm

vercel · 2023-05-22T13:25:09Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
svelte-dev-2	❌ Failed (Inspect)			May 24, 2023 1:17pm

svelte-ecoystem-ci · 2023-05-22T13:28:36Z

📝 Ran ecosystem CI: Open

suite	result
eslint-plugin-svelte	⏹️ cancelled
language-tools	❌ failure
prettier-plugin-svelte	⏹️ cancelled
rollup-plugin-svelte	⏹️ cancelled
svelte-loader	⏹️ cancelled
svelte-preprocess	⏹️ cancelled
sveltekit	⏹️ cancelled
vite-plugin-svelte	⏹️ cancelled

gtm-nayan · 2023-05-22T13:34:15Z

+fs.writeFileSync(
+	'./src/shared/version.js',
+	`/** @type {string} */\nexport const VERSION = '${pkg.version}';`
+);
+


This would mean one has to run build before doing anything else, eg. running tests. How about keeping it tracked in git and regenerating it in the release action instead?

Since the build is run as part of the prepare script, this will be missing only those who already have the repository checked out - doing pnpm build once is fine for me in that case. It's the same for the internal_exports.js btw which exists for a long time already. I wouldn't want those things to be checked in personally.

we discussed about the difficulties of adding a version file with changeset workflow here sveltejs/kit#9969 as long as it is part of the revision that gets tagged as that version and we are 300% sure the two versions in package.json and version.js can never get out of sync i'd be fine with it, but not without.
A unit test could do this.

preblishOnly triggers the build which contains the version.js generation as part of it, at which point the pkg.version has already been updated, so it's safe to do it that way.

personally I don't think the stuff the version is used for is that important and I'd be fine to just drop it as it doesn't really seem necessary and people can read or import the package.json to get the version themselves if they really care about it

benmccann · 2023-05-22T13:48:34Z

 /test/**/expected*
 /test/**/_output
 /types
+!rollup.config.js


can we add a comment explaining why this needs to be ignored

The ! means it's not ignored, which it was previously 😄

ah, duh. the format of this file is rather peculiar where it ignores everything in the root directory by default and then only opts files in. I wonder if we could swap that once the CJS version is removed

gtm-nayan · 2023-05-22T14:01:44Z

+			file: 'compiler.cjs',
+			format: is_publish ? 'umd' : 'cjs',
+			name: 'svelte',
+			sourcemap: false


Shouldn't we still have sourcemaps for this?

We decided to remove it because rarely any tool depends on it, and those who do can still backtrack manually

dummdidumm · 2023-05-22T14:52:26Z

Talked to Rich about this - decision:

we will keep the compiler umd build, but without source maps
we get rid of the CJS compiler option and runtime output. We'll see if anyone cries out loud about it and then reasses

dummdidumm · 2023-05-22T14:54:11Z

/ecosystem-ci run

svelte-ecoystem-ci · 2023-05-22T14:54:33Z

📝 Ran ecosystem CI: Open

suite	result
eslint-plugin-svelte	❌ failure
language-tools	❌ failure
prettier-plugin-svelte	❌ failure
rollup-plugin-svelte	❌ failure
svelte-loader	❌ failure
svelte-preprocess	❌ failure
sveltekit	❌ failure
vite-plugin-svelte	❌ failure

dummdidumm · 2023-05-22T15:48:35Z

/ecosystem-ci run

svelte-ecoystem-ci · 2023-05-22T15:49:00Z

📝 Ran ecosystem CI: Open

suite	result
eslint-plugin-svelte	✅ success
language-tools	❌ failure
prettier-plugin-svelte	✅ success
rollup-plugin-svelte	✅ success
svelte-loader	❌ failure
svelte-preprocess	❌ failure
sveltekit	❌ failure
vite-plugin-svelte	❌ failure

…s to top

dummdidumm · 2023-05-22T16:29:33Z

/ecosystem-ci run

svelte-ecoystem-ci · 2023-05-22T16:29:58Z

📝 Ran ecosystem CI: Open

suite	result
eslint-plugin-svelte	✅ success
language-tools	❌ failure
prettier-plugin-svelte	✅ success
rollup-plugin-svelte	✅ success
svelte-loader	✅ success
svelte-preprocess	✅ success
sveltekit	❌ failure
vite-plugin-svelte	❌ failure

dummdidumm · 2023-05-22T16:45:26Z

@dominikg do you know what's up with the vite ecosystem test failing? Sounds like ESlint has problems resolving the symlinks or sth?

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>

benmccann · 2023-05-23T18:02:25Z

  "module": "index.mjs",
  "main": "index",
  "files": [
+    "src",


we should separate the dependencies and devDependencies in this file as was being done in #8523. i'm not sure if you want to try to merge that PR first or copy those changes into this PR

If copying over the changes, source-map needs to be kept and so does the util polyfill for the UMD bundle.

Thanks for catching that. I updated #8523 to address that

gtm-nayan · 2023-05-24T02:18:02Z

Publint:

Warnings:
1. pkg.exports["./register"].require is ./register.js and is written in CJS, but is interpreted as ESM. Consider using the .cjs extension, e.g. ./register.cjs
Errors:
1. pkg.main is index but the file does not exist.
2. pkg.module is index.mjs but the file does not exist.
 ERROR  Command failed with exit code 1: publint

dominikg · 2023-05-24T06:59:27Z

Sorry wasn't clear, I meant the failing test run of v-p-s, something about svelte/compiler not being found.

that should go away after v-p-s jsdoc conversion has merged sveltejs/vite-plugin-svelte#655 sveltejs/vite-plugin-svelte#657 , part of that is switching from eslint-plugin-node to its successor eslint-plugin-n.

gtm-nayan · 2023-05-24T12:28:04Z

+    "index.d.ts",
+    "internal.d.ts",
+    "store.d.ts",
+    "animate.d.ts",
+    "transition.d.ts",
+    "easing.d.ts",
+    "motion.d.ts",
+    "action.d.ts",
+    "elements.d.ts",


Are these needed in addition to the exports map because of the moduleResolution thing?

dummdidumm · 2023-05-24T13:02:07Z

/ecosystem-ci run

svelte-ecoystem-ci · 2023-05-24T13:02:30Z

📝 Ran ecosystem CI: Open

suite	result
eslint-plugin-svelte	✅ success
language-tools	❌ failure
prettier-plugin-svelte	✅ success
rollup-plugin-svelte	✅ success
svelte-loader	✅ success
svelte-preprocess	✅ success
sveltekit	❌ failure
vite-plugin-svelte	❌ failure

…to unbundled-esm

benmccann and others added 2 commits May 8, 2023 14:51

chore: don't bundle dependencies

ec3ebaa

chore: use unbundled code for esm version

391795f

- removes esm bundle step - introduces generated version.js because we can no longer use replace because we don't bundle esm

dummdidumm added this to the 4.x milestone May 22, 2023

dummdidumm changed the title ~~Unbundled esm~~ chore: unbundled esm May 22, 2023

dummdidumm changed the base branch from master to version-4 May 22, 2023 13:25

gtm-nayan reviewed May 22, 2023

View reviewed changes

Merge branch 'version-4' into unbundled-esm

c1492dd

benmccann reviewed May 22, 2023

View reviewed changes

Comment thread rollup.config.js Outdated

vercel Bot had a problem deploying to Preview May 22, 2023 13:47 Failure

benmccann reviewed May 22, 2023

View reviewed changes

Comment thread rollup.config.js Outdated

gtm-nayan reviewed May 22, 2023

View reviewed changes

remove cjs runtime output, fix bundling, remove publish distinction

bec6ee1

vercel Bot had a problem deploying to Preview May 22, 2023 15:45 Failure

create index.d.ts, fix files field in package.json, move elements.d.t…

c1b5aca

…s to top

vercel Bot had a problem deploying to Preview May 22, 2023 16:27 Failure

benmccann reviewed May 22, 2023

View reviewed changes

Comment thread rollup.config.js Outdated

Update rollup.config.js

e1b67bd

Co-authored-by: Ben McCann <322311+benmccann@users.noreply.github.com>

vercel Bot had a problem deploying to Preview May 23, 2023 08:22 Failure

benmccann reviewed May 23, 2023

View reviewed changes

benmccann added 5 commits May 23, 2023 13:19

merge

474a4b2

fix merge and address comment

c8f98b5

fix merge

dbf29eb

fix

e1f6676

fix

2c738b0

benmccann mentioned this pull request May 24, 2023

chore: don't bundle dependencies #8523

Closed

Merge branch 'version-4' into external-deps

55bb947

Merge branch 'version-4' into unbundled-esm

2473946

vercel Bot had a problem deploying to Preview May 24, 2023 11:06 Failure

Merge branch 'external-deps' into unbundled-esm

f35e998

vercel Bot had a problem deploying to Preview May 24, 2023 11:09 Failure

gtm-nayan reviewed May 24, 2023

View reviewed changes

remove cjs and register hook

35ea95b

vercel Bot had a problem deploying to Preview May 24, 2023 12:51 Failure

chore: prune some more dependencies (#8627)

6aa3e46

vercel Bot had a problem deploying to Preview May 24, 2023 12:53 Failure

dummdidumm added 2 commits May 24, 2023 15:16

cleanup

eaef8f1

Merge branch 'unbundled-esm' of https://github.com/sveltejs/svelte in…

4dbee70

…to unbundled-esm

vercel Bot had a problem deploying to Preview May 24, 2023 13:17 Failure

dummdidumm mentioned this pull request May 24, 2023

chore: rename .mjs files to .js #8620

Closed

dummdidumm added the breaking change label May 24, 2023

dummdidumm merged commit a40af4d into version-4 May 24, 2023

dummdidumm deleted the unbundled-esm branch May 24, 2023 13:31

benmccann mentioned this pull request Jun 6, 2023

v3 docs availability and migration guide #8703

Closed

gtm-nayan mentioned this pull request Jun 17, 2023

chore: cleanup generated files #8749

Merged

5 tasks

thisjt mentioned this pull request May 4, 2024

Tabulator ESM with Sveltekit and Vite tabulator-tables/tabulator#4378

Closed

Uh oh!

Conversation

dummdidumm commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

BREAKING CHANGE cjs support removed

Changes

Before submitting the PR, please make sure you do the following

Tests

Uh oh!

vercel Bot commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

svelte-ecoystem-ci Bot commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dummdidumm May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dummdidumm commented May 22, 2023

Uh oh!

dummdidumm commented May 22, 2023

Uh oh!

svelte-ecoystem-ci Bot commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dummdidumm commented May 22, 2023

Uh oh!

svelte-ecoystem-ci Bot commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dummdidumm commented May 22, 2023

Uh oh!

svelte-ecoystem-ci Bot commented May 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dummdidumm commented May 22, 2023

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtm-nayan May 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtm-nayan commented May 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dominikg commented May 24, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dummdidumm commented May 24, 2023

Uh oh!

svelte-ecoystem-ci Bot commented May 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

dummdidumm commented May 22, 2023 •

edited

Loading

vercel Bot commented May 22, 2023 •

edited

Loading

svelte-ecoystem-ci Bot commented May 22, 2023 •

edited

Loading

dummdidumm May 22, 2023 •

edited

Loading

svelte-ecoystem-ci Bot commented May 22, 2023 •

edited

Loading

svelte-ecoystem-ci Bot commented May 22, 2023 •

edited

Loading

svelte-ecoystem-ci Bot commented May 22, 2023 •

edited

Loading

gtm-nayan May 23, 2023 •

edited

Loading

gtm-nayan commented May 24, 2023 •

edited

Loading

svelte-ecoystem-ci Bot commented May 24, 2023 •

edited

Loading