feat!: remove commonjs build (#522)

dominikg · web-flow · commit 956e381f1c7d · 2022-12-07T09:44:58.000+01:00
* breaking: remove commonjs build

* fix: tell eslint to shove it for missing import of v-p-s

* fix: remove module and use import condition

* fix: bump vite to 4.0.0-beta.1 to consume fix for cjs config bundling
diff --git a/.changeset/slow-paws-grow.md b/.changeset/slow-paws-grow.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/vite-plugin-svelte': major
+---
+
+remove cjs build
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -27,7 +27,7 @@ module.exports = {
 		'node/no-missing-import': [
 			'error',
 			{
-				allowModules: ['types', 'estree', 'testUtils'],
+				allowModules: ['types', 'estree', 'testUtils', '@sveltejs/vite-plugin-svelte'],
 				tryExtensions: ['.ts', '.js', '.jsx', '.tsx']
 			}
 		],
diff --git a/docs/faq.md b/docs/faq.md
@@ -177,3 +177,34 @@ There is no golden rule, but you can follow these recommendations:
 
 This warning only occurs if you use non-default settings in your vite config that can cause problems in combination with prebundleSvelteLibraries.
 You should not use prebundleSvelteLibraries during build or for ssr, disable one of the incompatible options to make that warning (and subsequent errors) go away.
+
+### how can I use vite-plugin-svelte from commonjs
+
+You really shouldn't. Svelte and Vite are esm first and the ecosystem is moving away from commonjs and so should you. Consider migrating to esm.
+
+In case you have to, use dynamic import to load vite-plugin-svelte's esm code from cjs like this:
+
+```diff
+// vite.config.cjs
+const { defineConfig } = require('vite');
+- const { svelte } = require('@sveltejs/vite-plugin-svelte');
+module.exports = defineConfig(async ({ command, mode }) => {
++ const { svelte } = await import('@sveltejs/vite-plugin-svelte');
+  return {plugins:[svelte()]}
+}
+```
+
+And for `vitePreprocess` you have to set up a lazy promise as top-level-await doesn't work for esm imports in cjs:
+
+```diff
+- const {vitePreprocess} = require('@sveltejs/vite-plugin-svelte')
++ const vitePreprocess = import('@sveltejs/vite-plugin-svelte').then(m => m.vitePreprocess())
+
+module.exports = {
+-    preprocess: vitePreprocess()
++    preprocess: {
++        script:async (options) => (await vitePreprocess).script(options),
++        style:async (options) => (await vitePreprocess).style(options),
++    }
+}
+```
diff --git a/package.json b/package.json
@@ -46,7 +46,7 @@
     "rimraf": "^3.0.2",
     "svelte": "^3.53.1",
     "typescript": "^4.9.3",
-    "vite": "^4.0.0-beta.0",
+    "vite": "^4.0.0-beta.1",
     "vitest": "^0.25.4"
   },
   "lint-staged": {
@@ -65,13 +65,13 @@
   "pnpm": {
     "overrides": {
       "@sveltejs/vite-plugin-svelte": "workspace:*",
-      "vite": "^4.0.0-beta.0"
+      "vite": "^4.0.0-beta.1"
     },
     "peerDependencyRules": {
       "allowedVersions": {
         "stylus": "^0.58.0",
         "postcss-load-config": "^4.0.0",
-        "vite": "^4.0.0-beta.0"
+        "vite": "^4.0.0-beta.1"
       }
     }
   }
diff --git a/packages/e2e-tests/autoprefixer-browerslist/package.json b/packages/e2e-tests/autoprefixer-browerslist/package.json
@@ -17,7 +17,7 @@
     "postcss-load-config": "^4.0.1",
     "svelte": "^3.53.1",
     "svelte-preprocess": "^4.10.7",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/configfile-custom/package.json b/packages/e2e-tests/configfile-custom/package.json
@@ -13,7 +13,7 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/configfile-esm/package.json b/packages/e2e-tests/configfile-esm/package.json
@@ -14,7 +14,7 @@
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
     "svelte-preprocess": "^4.10.7",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/css-none/package.json b/packages/e2e-tests/css-none/package.json
@@ -11,6 +11,6 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/e2e-tests/custom-extensions/package.json b/packages/e2e-tests/custom-extensions/package.json
@@ -10,7 +10,7 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/env/package.json b/packages/e2e-tests/env/package.json
@@ -10,7 +10,7 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/hmr/package.json b/packages/e2e-tests/hmr/package.json
@@ -15,7 +15,7 @@
     "e2e-test-dep-vite-plugins": "file:../_test_dependencies/vite-plugins",
     "node-fetch": "^3.3.0",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/import-queries/package.json b/packages/e2e-tests/import-queries/package.json
@@ -12,6 +12,6 @@
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "sass": "^1.56.1",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/e2e-tests/inspector-kit/package.json b/packages/e2e-tests/inspector-kit/package.json
@@ -11,7 +11,7 @@
   "devDependencies": {
     "@sveltejs/kit": "^1.0.0-next.572",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/inspector-vite/package.json b/packages/e2e-tests/inspector-vite/package.json
@@ -11,6 +11,6 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/e2e-tests/kit-node/package.json b/packages/e2e-tests/kit-node/package.json
@@ -20,7 +20,7 @@
     "svelte-i18n": "^3.6.0",
     "tiny-glob": "^0.2.9",
     "typescript": "^4.9.3",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/package-json-svelte-field/package.json b/packages/e2e-tests/package-json-svelte-field/package.json
@@ -14,7 +14,7 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/prebundle-svelte-deps/package.json b/packages/e2e-tests/prebundle-svelte-deps/package.json
@@ -20,6 +20,6 @@
     "sass": "^1.56.1",
     "svelte": "^3.53.1",
     "svelte-preprocess": "^4.10.7",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/e2e-tests/preprocess-with-vite/package.json b/packages/e2e-tests/preprocess-with-vite/package.json
@@ -12,7 +12,7 @@
     "sass": "^1.56.1",
     "stylus": "^0.59.0",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/resolve-exports-svelte/package.json b/packages/e2e-tests/resolve-exports-svelte/package.json
@@ -14,6 +14,6 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/e2e-tests/svelte-preprocess/package.json b/packages/e2e-tests/svelte-preprocess/package.json
@@ -13,7 +13,7 @@
     "svelte": "^3.53.1",
     "svelte-preprocess": "^4.10.7",
     "typescript": "^4.9.3",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/ts-type-import/package.json b/packages/e2e-tests/ts-type-import/package.json
@@ -13,7 +13,7 @@
     "@types/node": "^18.11.11",
     "svelte": "^3.53.1",
     "svelte-preprocess": "^4.10.7",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "type": "module"
 }
diff --git a/packages/e2e-tests/vite-ssr-esm/package.json b/packages/e2e-tests/vite-ssr-esm/package.json
@@ -21,6 +21,6 @@
     "npm-run-all": "^4.1.5",
     "serve-static": "^1.15.0",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/e2e-tests/vite-ssr/package.json b/packages/e2e-tests/vite-ssr/package.json
@@ -18,6 +18,6 @@
     "express": "^4.18.2",
     "serve-static": "^1.15.0",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/e2e-tests/vite-ssr/vite.config.js b/packages/e2e-tests/vite-ssr/vite.config.js
@@ -1,7 +1,8 @@
 const { defineConfig } = require('vite');
-const { svelte } = require('@sveltejs/vite-plugin-svelte');
 
-module.exports = defineConfig(({ command, mode }) => {
+module.exports = defineConfig(async ({ command, mode }) => {
+	//eslint-disable-next-line node/no-missing-import
+	const { svelte } = await import('@sveltejs/vite-plugin-svelte');
 	return {
 		plugins: [
 			svelte({
diff --git a/packages/playground/big-component-library-kit/package.json b/packages/playground/big-component-library-kit/package.json
@@ -20,7 +20,7 @@
 		"svelte-check": "^2.10.1",
 		"svelte-preprocess": "^4.10.7",
 		"typescript": "^4.9.3",
-		"vite": "^4.0.0-beta.0"
+		"vite": "^4.0.0-beta.1"
 	},
 	"type": "module"
 }
diff --git a/packages/playground/big-component-library-vite-ssr/package.json b/packages/playground/big-component-library-vite-ssr/package.json
@@ -24,6 +24,6 @@
     "lodash-es": "^4.17.21",
     "svelte": "^3.53.1",
     "svelte-preprocess": "^4.10.7",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/playground/big-component-library/package.json b/packages/playground/big-component-library/package.json
@@ -15,7 +15,7 @@
     "carbon-preprocess-svelte": "^0.9.1",
     "svelte": "^3.53.1",
     "svelte-preprocess": "^4.10.7",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "dependencies": {
     "lodash-es": "^4.17.21"
diff --git a/packages/playground/big/package.json b/packages/playground/big/package.json
@@ -10,6 +10,6 @@
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/playground/kit-demo-app/package.json b/packages/playground/kit-demo-app/package.json
@@ -18,7 +18,7 @@
 		"svelte": "^3.53.1",
 		"svelte-check": "^2.10.1",
 		"typescript": "^4.9.3",
-		"vite": "^4.0.0-beta.0"
+		"vite": "^4.0.0-beta.1"
 	},
 	"type": "module"
 }
diff --git a/packages/playground/optimizedeps-include/package.json b/packages/playground/optimizedeps-include/package.json
@@ -12,6 +12,6 @@
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "svelte": "^3.53.1",
     "tinro": "^0.6.12",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/packages/playground/windicss/package.json b/packages/playground/windicss/package.json
@@ -14,7 +14,7 @@
     "@sveltejs/vite-plugin-svelte": "workspace:*",
     "diff-match-patch": "^1.0.5",
     "svelte": "^3.53.1",
-    "vite": "^4.0.0-beta.0",
+    "vite": "^4.0.0-beta.1",
     "vite-plugin-windicss": "^1.8.8"
   }
 }
diff --git a/packages/vite-plugin-svelte/package.json b/packages/vite-plugin-svelte/package.json
@@ -9,21 +9,18 @@
     "*.d.ts"
   ],
   "type": "module",
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "import": "./dist/index.js"
     },
     "./package.json": "./package.json",
     "./src/ui/*": "./src/ui/*"
   },
   "scripts": {
     "dev": "pnpm build:ci --sourcemap --watch src",
-    "build:ci": "rimraf dist && tsup-node src/index.ts src/preprocess.ts --format esm,cjs --no-splitting --shims",
+    "build:ci": "rimraf dist && tsup-node src/index.ts --format esm",
     "build": "pnpm build:ci --dts --sourcemap"
   },
   "engines": {
@@ -54,14 +51,14 @@
   },
   "peerDependencies": {
     "svelte": "^3.44.0",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   },
   "devDependencies": {
     "@types/debug": "^4.1.7",
     "esbuild": "^0.15.18",
     "rollup": "^2.79.1",
     "svelte": "^3.53.1",
     "tsup": "^6.5.0",
-    "vite": "^4.0.0-beta.0"
+    "vite": "^4.0.0-beta.1"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@sveltejs/vite-plugin-svelte': major
 +---
++
 +remove cjs build
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ module.exports = {`
`27`	`27`	`'node/no-missing-import': [`
`28`	`28`	`'error',`
`29`	`29`	`{`
`30`		`- allowModules: ['types', 'estree', 'testUtils'],`
	`30`	`+ allowModules: ['types', 'estree', 'testUtils', '@sveltejs/vite-plugin-svelte'],`
`31`	`31`	`tryExtensions: ['.ts', '.js', '.jsx', '.tsx']`
`32`	`32`	`}`
`33`	`33`	`],`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`"postcss-load-config": "^4.0.1",`
`18`	`18`	`"svelte": "^3.53.1",`
`19`	`19`	`"svelte-preprocess": "^4.10.7",`
`20`		`- "vite": "^4.0.0-beta.0"`
	`20`	`+ "vite": "^4.0.0-beta.1"`
`21`	`21`	`},`
`22`	`22`	`"type": "module"`
`23`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`"devDependencies": {`
`14`	`14`	`"@sveltejs/vite-plugin-svelte": "workspace:*",`
`15`	`15`	`"svelte": "^3.53.1",`
`16`		`- "vite": "^4.0.0-beta.0"`
	`16`	`+ "vite": "^4.0.0-beta.1"`
`17`	`17`	`},`
`18`	`18`	`"type": "module"`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`"@sveltejs/vite-plugin-svelte": "workspace:*",`
`15`	`15`	`"svelte": "^3.53.1",`
`16`	`16`	`"svelte-preprocess": "^4.10.7",`
`17`		`- "vite": "^4.0.0-beta.0"`
	`17`	`+ "vite": "^4.0.0-beta.1"`
`18`	`18`	`},`
`19`	`19`	`"type": "module"`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,6 @@`
`11`	`11`	`"devDependencies": {`
`12`	`12`	`"@sveltejs/vite-plugin-svelte": "workspace:*",`
`13`	`13`	`"svelte": "^3.53.1",`
`14`		`- "vite": "^4.0.0-beta.0"`
	`14`	`+ "vite": "^4.0.0-beta.1"`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`"devDependencies": {`
`11`	`11`	`"@sveltejs/vite-plugin-svelte": "workspace:*",`
`12`	`12`	`"svelte": "^3.53.1",`
`13`		`- "vite": "^4.0.0-beta.0"`
	`13`	`+ "vite": "^4.0.0-beta.1"`
`14`	`14`	`},`
`15`	`15`	`"type": "module"`
`16`	`16`	`}`