Skip to content

types(runtime-core): enable plugin option types #3969

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 14, 2022
Merged

types(runtime-core): enable plugin option types #3969

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
47dbc22
types(runtime-core): enable plugin option types
tony19 Jun 17, 2021
e2dc246
types(runtime-core): add d.ts tests for app.use()
tony19 Jun 17, 2021
c9c7e0a
remove unnecessary rest parameter
tony19 Oct 9, 2022
6139f60
add test for passing multiple plugin options
tony19 Oct 9, 2022
863031c
refactor: stricter plugin types
posva Oct 10, 2022
5557c64
Merge pull request #1 from vuejs/feat/types/plugin-options
tony19 Oct 10, 2022
bda19de
remove unnecessary typing from plugin install fn type
tony19 Oct 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/runtime-core/src/apiCreateApp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import { ObjectEmitsOptions } from './componentEmits'
export interface App<HostElement = any> {
version: string
config: AppConfig
use(plugin: Plugin, ...options: any[]): this
use<Option>(plugin: Plugin<Option>, ...options: Option[]): this
mixin(mixin: ComponentOptions): this
component(name: string): Component | undefined
component(name: string, component: Component): this
Expand Down Expand Up @@ -137,12 +137,12 @@ export interface AppContext {
filters?: Record<string, Function>
}

type PluginInstallFunction = (app: App, ...options: any[]) => any
type PluginInstallFunction<Option> = (app: App, ...options: Option[]) => any

export type Plugin =
| (PluginInstallFunction & { install?: PluginInstallFunction })
export type Plugin<Option = any> =
| PluginInstallFunction<Option> & { install?: PluginInstallFunction<Option> }
| {
install: PluginInstallFunction
install: PluginInstallFunction<Option>
}

export function createAppContext(): AppContext {
Expand Down
71 changes: 71 additions & 0 deletions test-dts/appUse.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import { createApp } from './index'

type App = ReturnType<typeof createApp>

type PluginAOptionType = {
option1?: string
option2: number
option3: boolean
}

const PluginA = {
install(app: App, ...options: PluginAOptionType[]) {
options[0].option1
options[0].option2
options[0].option3
}
}

const PluginB = {
install(app: App) {}
}

const PluginC = (app: App, ...options: string[]) => {}

createApp({})
.use(PluginA)
// @ts-expect-error option2 and option3 (required) missing
.use(PluginA, {})
// @ts-expect-error type mismatch
.use(PluginA, true)
// @ts-expect-error type mismatch
.use(PluginA, undefined)
// @ts-expect-error type mismatch
.use(PluginA, null)
// @ts-expect-error type mismatch
.use(PluginA, 'foo')
// @ts-expect-error type mismatch
.use(PluginA, 1)
.use(PluginA, { option2: 1, option3: true })
.use(PluginA, { option1: 'foo', option2: 1, option3: true })
.use(PluginA, { option1: 'foo', option2: 1, option3: true }, { option2: 1, option3: true })

// @ts-expect-error option2 (required) missing
.use(PluginA, { option3: true })

.use(PluginB)
// @ts-expect-error unexpected plugin option
.use(PluginB, {})
// @ts-expect-error unexpected plugin option
.use(PluginB, true)
// @ts-expect-error unexpected plugin option
.use(PluginB, undefined)
// @ts-expect-error unexpected plugin option
.use(PluginB, null)
// @ts-expect-error type mismatch
.use(PluginB, 'foo')
// @ts-expect-error type mismatch
.use(PluginB, 1)

.use(PluginC)
// @ts-expect-error unexpected plugin option
.use(PluginC, {})
// @ts-expect-error unexpected plugin option
.use(PluginC, true)
// @ts-expect-error unexpected plugin option
.use(PluginC, undefined)
// @ts-expect-error unexpected plugin option
.use(PluginC, null)
.use(PluginC, 'foo')
// @ts-expect-error type mismatch
.use(PluginC, 1)