fix(types): support required options

unjs · Aug 15, 2022 · 53954df · 53954df
1 parent 9f5c8a6
commit 53954df
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 10 deletions.
diff --git a/src/define.ts b/src/define.ts
@@ -4,7 +4,7 @@ import { UnpluginInstance, UnpluginFactory } from './types'
 import { getVitePlugin } from './vite'
 import { getWebpackPlugin } from './webpack'
 
-export function createUnplugin<UserOptions = {}> (
+export function createUnplugin<UserOptions> (
   factory: UnpluginFactory<UserOptions>
 ): UnpluginInstance<UserOptions> {
   return {

diff --git a/src/esbuild/index.ts b/src/esbuild/index.ts
@@ -18,7 +18,7 @@ export function getEsbuildPlugin <UserOptions = {}> (
     const meta: UnpluginContextMeta = {
       framework: 'esbuild'
     }
-    const plugin = factory(userOptions, meta)
+    const plugin = factory(userOptions!, meta)
 
     return {
       name: plugin.name,

diff --git a/src/rollup/index.ts b/src/rollup/index.ts
@@ -7,7 +7,7 @@ export function getRollupPlugin <UserOptions = {}> (
     const meta: UnpluginContextMeta = {
       framework: 'rollup'
     }
-    const rawPlugin = factory(userOptions, meta)
+    const rawPlugin = factory(userOptions!, meta)
     return toRollupPlugin(rawPlugin)
   }
 }

diff --git a/src/types.ts b/src/types.ts
@@ -54,13 +54,16 @@ export interface ResolvedUnpluginOptions extends UnpluginOptions {
   __virtualModulePrefix: string
 }
 
-export type UnpluginFactory<UserOptions> = (options: UserOptions | undefined, meta: UnpluginContextMeta) => UnpluginOptions
+export type UnpluginFactory<UserOptions> = (options: UserOptions, meta: UnpluginContextMeta) => UnpluginOptions
+export type UnpluginFactoryOutput<UserOptions, Return> = undefined extends UserOptions
+  ? (options?: UserOptions) => Return
+  : (options: UserOptions) => Return
 
 export interface UnpluginInstance<UserOptions> {
-  rollup: (options?: UserOptions) => RollupPlugin;
-  webpack: (options?: UserOptions) => WebpackPluginInstance;
-  vite: (options?: UserOptions) => VitePlugin;
-  esbuild: (options?: UserOptions) => EsbuildPlugin;
+  rollup: UnpluginFactoryOutput<UserOptions, RollupPlugin>
+  webpack: UnpluginFactoryOutput<UserOptions, WebpackPluginInstance>
+  vite: UnpluginFactoryOutput<UserOptions, VitePlugin>
+  esbuild: UnpluginFactoryOutput<UserOptions, EsbuildPlugin>
   raw: UnpluginFactory<UserOptions>
 }
 

diff --git a/src/vite/index.ts b/src/vite/index.ts
@@ -8,7 +8,7 @@ export function getVitePlugin <UserOptions = {}> (
     const meta: UnpluginContextMeta = {
       framework: 'vite'
     }
-    const rawPlugin = factory(userOptions, meta)
+    const rawPlugin = factory(userOptions!, meta)
 
     const plugin = toRollupPlugin(rawPlugin, false) as VitePlugin
 

diff --git a/src/webpack/index.ts b/src/webpack/index.ts
@@ -36,7 +36,7 @@ export function getWebpackPlugin<UserOptions = {}> (
           }
         }
 
-        const rawPlugin = factory(userOptions, meta)
+        const rawPlugin = factory(userOptions!, meta)
         const plugin = Object.assign(
           rawPlugin,
           {