Merge pull request vuejs#282 from vuejs/feat/plugin-option-inferring

feat(types): infer options in plugins

Author: lmiller1990

src/config.ts

@@ -12,23 +12,23 @@ interface GlobalConfigOptions {
   renderStubDefaultSlot: boolean
 }
 
-interface Plugin<Instance> {
-  handler: (
-    instance: Instance,
-    options: Record<string, any>
-  ) => Record<string, any>
-  options: Record<string, any>
+interface Plugin<Instance, O> {
+  handler(instance: Instance): Record<string, any>
+  handler(instance: Instance, options: O): Record<string, any>
+  options: O
 }
 
 class Pluggable<Instance = DOMWrapper<Element>> {
-  installedPlugins: Plugin<Instance>[] = []
+  installedPlugins: Plugin<Instance, any>[] = []
 
-  install(
-    handler: (
-      instance: Instance,
-      options?: Record<string, any>
-    ) => Record<string, any>,
-    options: Record<string, any> = {}
+  install<O>(handler: (instance: Instance) => Record<string, any>)
+  install<O>(
+    handler: (instance: Instance, options: O) => Record<string, any>,
+    options: O
+  )
+  install<O>(
+    handler: (instance: Instance, options?: O) => Record<string, any>,
+    options?: O
   ) {
     if (typeof handler !== 'function') {
       console.error('plugin.install must receive a function')
@@ -38,7 +38,7 @@ class Pluggable<Instance = DOMWrapper<Element>> {
   }
 
   extend(instance: Instance) {
-    const invokeSetup = ({ handler, options }: Plugin<Instance>) => {
+    const invokeSetup = ({ handler, options }: Plugin<Instance, any>) => {
       return handler(instance, options) // invoke the setup method passed to install
     }
     const bindProperty = ([property, value]: [string, any]) => {

test-dts/plugins.d-test.ts

@@ -0,0 +1,46 @@
+import { expectError, expectType } from 'tsd'
+import { ComponentPublicInstance } from 'vue'
+import { config, VueWrapper } from '../src'
+
+interface OptionsI {
+  msg: string
+}
+
+function PluginWithOptions(
+  wrapper: VueWrapper<ComponentPublicInstance>,
+  options: OptionsI
+) {
+  return {}
+}
+
+function PluginWithoutOptions(wrapper: VueWrapper<ComponentPublicInstance>) {
+  return {}
+}
+
+function PluginWithOptionalOptions(
+  wrapper: VueWrapper<ComponentPublicInstance>,
+  options: OptionsI = { msg: 'hi' }
+) {
+  return {}
+}
+
+function PluginWithOptionalOptions2(
+  wrapper: VueWrapper<ComponentPublicInstance>,
+  options?: OptionsI
+) {
+  return {}
+}
+
+config.plugins.VueWrapper.install(PluginWithOptions, { msg: 'Hello' })
+config.plugins.VueWrapper.install(PluginWithoutOptions)
+config.plugins.VueWrapper.install(PluginWithOptionalOptions)
+config.plugins.VueWrapper.install(PluginWithOptionalOptions2)
+config.plugins.VueWrapper.install(PluginWithOptionalOptions, { msg: 'hello' })
+config.plugins.VueWrapper.install(PluginWithOptionalOptions2, { msg: 'hello' })
+
+// uncertain if it is possible to forbid this usage
+// expectError(config.plugins.VueWrapper.install(PluginWithoutOptions, {}))
+expectError(config.plugins.VueWrapper.install(PluginWithOptions, { msg: true }))
+expectError(config.plugins.VueWrapper.install(PluginWithOptions, {}))
+expectError(config.plugins.VueWrapper.install(PluginWithOptionalOptions, {}))
+expectError(config.plugins.VueWrapper.install(PluginWithOptionalOptions2, {}))