refactor(types): use dts-buddy to generate types with map (#751)

* refactor(types): use dts-buddy to generate types with map, cleanup type definitions and tsconfig

* chore: update generated types

* fix: use .d.ts for type imports

* fix: ignore .changesets/pre.json to prevent format check fails on main after release merge

* fix: move types inside import condition to avoid masquerading as cjs warning

* fix: types

* bump dts-buddy

* fix: regenerate types

* fix: use correct type Options for plugin function arg

* fix(types): reexport index.js from public.d.ts to ensure types and functions are properly exported through module declaration generated by dts-buddy; move dynamicCompileOptions to PluginOptions, rename SvelteOptions to SvelteConfig

* fix: update lockfile

* Update .changeset/metal-olives-wait.md

Co-authored-by: Bjorn Lu <[email protected]>

* fix: update types

---------

Co-authored-by: Rich Harris <[email protected]>
Co-authored-by: Bjorn Lu <[email protected]>

Author: 3 people

.changeset/gorgeous-hats-bathe.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/vite-plugin-svelte': patch
+---
+
+fix(types): use correct type Options for svelte function arg

.changeset/many-cows-rescue.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/vite-plugin-svelte': major
+---
+
+breaking: remove package.json export

.changeset/metal-olives-wait.md

@@ -0,0 +1,6 @@
+---
+'@sveltejs/vite-plugin-svelte-inspector': major
+'@sveltejs/vite-plugin-svelte': major
+---
+
+breaking(types): emit types with dts-buddy to include type map

.changeset/small-pears-accept.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/vite-plugin-svelte': major
+---
+
+breaking(types): rename SvelteOptions to SvelteConfig

.github/workflows/ci.yml

@@ -66,6 +66,9 @@ jobs:
       - name: publint
         if: (${{ success() }} || ${{ failure() }})
         run: pnpm check:publint
+      - name: generated types are up to date
+        if: (${{ success() }} || ${{ failure() }})
+        run: pnpm generate:types && [ "`git status --porcelain=v1`" == "" ]
 
   test:
     timeout-minutes: 10

.github/workflows/release.yml

@@ -43,7 +43,10 @@ jobs:
           cache-dependency-path: '**/pnpm-lock.yaml'
       - name: install
         run: pnpm install --frozen-lockfile --prefer-offline --ignore-scripts
-
+      - name: generated types are up to date
+        run: pnpm generate:types && [ "`git status --porcelain=v1`" == "" ]
+      - name: publint
+        run: pnpm check:publint
       - name: Creating .npmrc
         run: |
           cat << EOF > "$HOME/.npmrc"

.prettierrc.js

@@ -16,9 +16,13 @@ export default {
 		},
 		{
 			files: [
-				'**/vite.config.js.timestamp-*.mjs',
 				'**/CHANGELOG.md',
 				'.github/renovate.json5',
+				'**/types/index.d.ts',
+				'**/types/index.d.ts.map',
+				'**/pnpm-lock.yaml',
+				'.changeset/pre.json',
+				'**/vite.config.js.timestamp-*.mjs',
 				'packages/e2e-tests/dynamic-compile-options/src/components/A.svelte'
 			],
 			options: {

package.json

@@ -18,7 +18,8 @@
     "fixup": "run-s lint format",
     "release": "pnpm changeset publish",
     "prepare": "husky install",
-    "playwright": "playwright-core"
+    "playwright": "playwright-core",
+    "generate:types": "pnpm --filter \"./packages/*\" --parallel generate:types"
   },
   "devDependencies": {
     "@changesets/cli": "^2.26.2",
@@ -28,6 +29,7 @@
     "@typescript-eslint/eslint-plugin": "^6.8.0",
     "@typescript-eslint/parser": "^6.8.0",
     "cross-env": "^7.0.3",
+    "dts-buddy": "^0.3.0",
     "eslint": "^8.51.0",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-html": "^7.1.0",

packages/vite-plugin-svelte-inspector/package.json

@@ -4,19 +4,23 @@
   "license": "MIT",
   "author": "dominikg",
   "files": [
-    "src"
+    "src",
+    "types"
   ],
   "type": "module",
-  "types": "src/index.d.ts",
+  "types": "types/index.d.ts",
   "exports": {
     ".": {
-      "types": "./src/index.d.ts",
-      "import": "./src/index.js"
+      "import": {
+        "types": "./types/index.d.ts",
+        "default": "./src/index.js"
+      }
     }
   },
   "scripts": {
     "check:publint": "publint --strict",
-    "check:types": "tsc --noEmit"
+    "check:types": "tsc --noEmit",
+    "generate:types": "dts-buddy -m \"@sveltejs/vite-plugin-svelte-inspector:src/public.d.ts\""
   },
   "engines": {
     "node": "^18.0.0 || >=20"

packages/vite-plugin-svelte-inspector/src/index.js

@@ -14,14 +14,17 @@ function getInspectorPath() {
 	);
 }
 
-/** @type {import('.').svelteInspector} */
+/**
+ * @param {Partial<import('./public.d.ts').Options>} [options]
+ * @returns {import('vite').Plugin}
+ */
 export function svelteInspector(options) {
 	const inspectorPath = getInspectorPath();
 	debug(`svelte inspector path: ${inspectorPath}`);
 
 	/** @type {import('vite').ResolvedConfig} */
 	let viteConfig;
-	/** @type {import('.').Options} */
+	/** @type {import('./public.d.ts').Options} */
 	let inspectorOptions;
 	let disabled = false;