fix: avoid Plugin type mismatches when there are multiple Vite versio…

…ns installed
hemengke1997 · Oct 30, 2023 · 7c870e3 · 7c870e3
1 parent 7a8bcd7
commit 7c870e3
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 18 deletions.
diff --git a/package.json b/package.json
@@ -60,7 +60,7 @@
     "bump": "bumpp package.json -c -p -t --all -x \"pnpm run changelog\""
   },
   "peerDependencies": {
-    "vite": ">=4"
+    "vite": ">=4.0.0"
   },
   "dependencies": {
     "debug": "^4.3.4",

diff --git a/playground/ssr/package.json b/playground/ssr/package.json
@@ -24,6 +24,7 @@
     "@vitejs/plugin-react": "^4.1.0",
     "compression": "^1.7.4",
     "express": "^4.18.2",
-    "serve-static": "^1.15.0"
+    "serve-static": "^1.15.0",
+    "vite": "^4.5.0"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/node/helper/utils.ts b/src/node/helper/utils.ts
@@ -14,9 +14,9 @@ import { disableManifestHmr } from './server'
 
 const debug = createDebug('vite-plugin-public-typescript:util ===> ')
 
-type PartialExclude<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
+type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>
 
-export type OptionsTypeWithDefault = PartialExclude<Required<VPPTPluginOptions>, 'base' | 'sideEffects'>
+export type OptionsTypeWithDefault = PartialBy<Required<VPPTPluginOptions>, 'base' | 'sideEffects'>
 
 export { pkgName }
 

diff --git a/src/node/index.ts b/src/node/index.ts
@@ -100,8 +100,6 @@ export const DEFAULT_OPTIONS: OptionsTypeWithDefault = {
   cacheDir: 'node_modules/.vite-plugin-public-typescript',
 }
 
-// let previousOpts: VPPTPluginOptions
-
 export default function publicTypescript(options: VPPTPluginOptions = {}) {
   const opts = {
     ...DEFAULT_OPTIONS,
@@ -114,7 +112,7 @@ export default function publicTypescript(options: VPPTPluginOptions = {}) {
 
   let viteConfig: ResolvedConfig
 
-  const plugins: PluginOption = [
+  const plugins: PluginOption[] = [
     {
       name: 'vite:public-typescript',
       enforce: 'post',
@@ -131,13 +129,6 @@ export default function publicTypescript(options: VPPTPluginOptions = {}) {
         initWatcher((file) => reloadPage(ws, file))
       },
       async buildStart() {
-        // skip server restart when options not changed
-        // if (eq(previousOpts, opts)) {
-        //   return
-        // }
-
-        // previousOpts = opts
-
         const manifestPath = manifestCache.manifestPath
 
         fs.ensureFileSync(manifestPath)
@@ -204,7 +195,8 @@ export default function publicTypescript(options: VPPTPluginOptions = {}) {
     pluginVirtual(),
   ]
 
-  return plugins
+  // Return as `any` to avoid Plugin type mismatches when there are multiple Vite versions installed
+  return plugins as any
 }
 
 export { injectTagsToHtml } from './helper/html'

diff --git a/src/node/plugins/inject-script.ts b/src/node/plugins/inject-script.ts
@@ -37,5 +37,6 @@ export function injectScripts(scripts: Scripts) {
     },
   }
 
-  return plugin
+  // Return as `any` to avoid Plugin type mismatches when there are multiple Vite versions installed
+  return plugin as any
 }
diff --git a/src/node/plugins/server.ts b/src/node/plugins/server.ts
@@ -5,7 +5,7 @@ import { getScriptInfo, nodeIsElement, traverseHtml } from '../helper/html'
 import { addCodeHeader } from '../helper/server'
 import { manifestCache } from '../manifest-cache'
 
-export function pluginServer() {
+export function pluginServer(): PluginOption {
   const plugin: PluginOption = {
     name: 'vite:public-typescript:server',
     apply: 'serve',

diff --git a/src/node/plugins/virtual.ts b/src/node/plugins/virtual.ts
@@ -2,7 +2,7 @@ import { type PluginOption } from 'vite'
 import { resolvedVirtualModuleId, virtualModuleId } from '../helper/virtual'
 import { manifestCache } from '../manifest-cache'
 
-export function pluginVirtual() {
+export function pluginVirtual(): PluginOption {
   const plugin: PluginOption = {
     name: 'vite:public-typescript:virtual',
     enforce: 'post',