Mark types as deprecated

Author: afontcu

src/__tests__/deprecated-options.js

@@ -0,0 +1,39 @@
+import {render} from '..'
+
+beforeEach(() => {
+  jest.spyOn(console, 'warn').mockImplementation(() => {})
+})
+
+afterEach(() => {
+  console.warn.mockRestore()
+})
+
+test('warns on deprecated store option', () => {
+  const Component = {template: `<div></div>`}
+
+  render(Component, {
+    store: 'anything',
+  })
+
+  expect(console.warn).toHaveBeenCalledTimes(1)
+  expect(console.warn).toHaveBeenCalledWith(
+    expect.stringContaining(
+      `Providing 'store' or 'routes' options is now deprecated`,
+    ),
+  )
+})
+
+test('warns on deprecated routes option', () => {
+  const Component = {template: `<div></div>`}
+
+  render(Component, {
+    routes: 'anything',
+  })
+
+  expect(console.warn).toHaveBeenCalledTimes(1)
+  expect(console.warn).toHaveBeenCalledWith(
+    expect.stringContaining(
+      `Providing 'store' or 'routes' options is now deprecated`,
+    ),
+  )
+})

src/__tests__/vue-router.js

@@ -13,7 +13,7 @@ import About from './components/Router/About.vue'
 test('full app rendering/navigating from base URL', async () => {
   // Create a Router instance
   // https://next.router.vuejs.org/api/#createrouter
-  // using the a HTML5 history.
+  // using a HTML5 history.
   // https://next.router.vuejs.org/api/#createwebhistory
   const router = createRouter({
     history: createWebHistory(),

src/render.js

@@ -22,7 +22,7 @@ function render(
   if (store || routes) {
     console.warn(`Providing 'store' or 'routes' options is now deprecated.
 You need to create a router/vuex plugin and provide it through 'global.plugins'.
-See here for more information:`)
+Check out the test examples on GitHub for further details.`)
   }
 
   const wrapper = mount(Component, {

types/index.d.ts

@@ -3,8 +3,6 @@
 
 import {EmitsOptions} from 'vue'
 import {MountingOptions} from '@vue/test-utils'
-import {StoreOptions} from 'vuex'
-import {RouteRecordRaw} from 'vue-router'
 import {queries, EventType, BoundFunctions} from '@testing-library/dom'
 // eslint-disable-next-line import/no-extraneous-dependencies
 import {OptionsReceived as PrettyFormatOptions} from 'pretty-format'
@@ -33,8 +31,14 @@ type VueTestUtilsRenderOptions = Omit<
   'attachTo' | 'shallow' | 'propsData'
 >
 type VueTestingLibraryRenderOptions = {
-  store?: StoreOptions<{}>
-  routes?: RouteRecordRaw[]
+  /**
+   * @deprecated Use `global.plugins` array instead.
+   */
+  store: any
+  /**
+   * @deprecated Use `global.plugins` array instead.
+   */
+  routes?: any
   container?: Element
   baseElement?: Element
 }

types/test.ts

@@ -77,12 +77,8 @@ export function testOptions() {
     },
     global: {
       config: {isCustomElement: _ => true},
+      plugins: [],
     },
-    store: {
-      state: {count: 3},
-      strict: true,
-    },
-    routes: [{path: '/', component: () => SomeComponent, name: 'route name'}],
     baseElement: document.createElement('div'),
     container: document.createElement('div'),
   })