BREAKING CHANGE: drop createComponent (#398)

Author: antfu

src/component/component.ts

@@ -119,43 +119,3 @@ export function defineComponent<
 export function defineComponent(options: any) {
   return options as any
 }
-
-// overload 1: object format with no props
-export function createComponent<RawBindings>(
-  options: ComponentOptionsWithoutProps<unknown, RawBindings>
-): VueProxy<unknown, RawBindings>
-// overload 2: object format with array props declaration
-// props inferred as { [key in PropNames]?: any }
-// return type is for Vetur and TSX support
-export function createComponent<
-  PropNames extends string,
-  RawBindings = Data,
-  PropsOptions extends ComponentPropsOptions = ComponentPropsOptions
->(
-  // prettier-ignore
-  options: (
-    ComponentOptionsWithArrayProps<PropNames, RawBindings>) &
-    Omit<Vue2ComponentOptions<Vue>, keyof ComponentOptionsWithProps<never, never>>
-): VueProxy<Readonly<{ [key in PropNames]?: any }>, RawBindings>
-// overload 3: object format with object props declaration
-// see `ExtractPropTypes` in ./componentProps.ts
-export function createComponent<
-  Props,
-  RawBindings = Data,
-  PropsOptions extends ComponentPropsOptions = ComponentPropsOptions
->(
-  // prettier-ignore
-  options: (
-    // prefer the provided Props, otherwise infer it from PropsOptions
-    HasDefined<Props> extends true
-      ? ComponentOptionsWithProps<PropsOptions, RawBindings, Props>
-      : ComponentOptionsWithProps<PropsOptions, RawBindings>) &
-    Omit<Vue2ComponentOptions<Vue>, keyof ComponentOptionsWithProps<never, never>>
-): VueProxy<PropsOptions, RawBindings>
-// implementation, deferring to defineComponent, but logging a warning in dev mode
-export function createComponent(options: any) {
-  if (__DEV__) {
-    Vue.util.warn('`createComponent` has been renamed to `defineComponent`.')
-  }
-  return defineComponent(options)
-}

src/component/index.ts

@@ -1,6 +1,5 @@
 export {
   Data,
-  createComponent,
   defineComponent,
   SetupFunction,
   SetupContext,

src/index.ts

@@ -24,7 +24,6 @@ export default plugin
 export { default as createElement } from './createElement'
 export { SetupContext }
 export {
-  createComponent,
   defineComponent,
   ComponentRenderProxy,
   PropType,

test/types/defineComponent.spec.ts

@@ -1,5 +1,4 @@
 import {
-  createComponent,
   defineComponent,
   createElement as h,
   ref,
@@ -217,38 +216,4 @@ describe('defineComponent', () => {
       })
     })
   })
-
-  describe('retro-compatible with createComponent', () => {
-    it('should still work and warn', () => {
-      const warn = jest
-        .spyOn(global.console, 'error')
-        .mockImplementation(() => null)
-      const Child = createComponent({
-        props: { msg: String },
-        setup(props) {
-          return () => h('span', props.msg)
-        },
-      })
-
-      const App = createComponent({
-        setup() {
-          const msg = ref('hello')
-          return () =>
-            h('div', [
-              h(Child, {
-                props: {
-                  msg: msg.value,
-                },
-              }),
-            ])
-        },
-      })
-      const vm = new Vue(App).$mount()
-      expect(vm.$el.querySelector('span').textContent).toBe('hello')
-      expect(warn.mock.calls[0][0]).toMatch(
-        '[Vue warn]: `createComponent` has been renamed to `defineComponent`.'
-      )
-      warn.mockRestore()
-    })
-  })
 })