feat: stub router link

__tests__/components.spec.ts

@@ -10,13 +10,26 @@ describe('components', () => {
   it('stubs router link', async () => {
     const wrapper = mount(
       {
-        template: `<router-link>Hello</router-link>`,
+        template: `<router-link to="/">Hello</router-link>`,
       }
       // { global: { stubs: { RouterLink: true } } }
     )
 
     expect(wrapper.html()).toMatchInlineSnapshot(
-      `"<router-link>Hello</router-link>"`
+      `"<router-link-stub></router-link-stub>"`
+    )
+  })
+
+  it('can use real router-link', async () => {
+    const wrapper = mount(
+      {
+        template: `<router-link to="/about">About</router-link>`,
+      },
+      { global: { stubs: { RouterLink: false } } }
+    )
+
+    expect(wrapper.html()).toMatchInlineSnapshot(
+      `"<a href=\\"/about\\" class=\\"\\">About</a>"`
     )
   })
 })

src/index.ts

@@ -1,11 +1,13 @@
 import {
+  createMemoryHistory,
   createRouter,
-  createWebHashHistory,
   routeLocationKey,
   RouteLocationNormalizedLoaded,
   RouteLocationRaw,
   Router,
   routerKey,
+  RouterLink,
+  RouterView,
 } from 'vue-router'
 import { config, VueWrapper } from '@vue/test-utils'
 import { computed, ComputedRef, reactive, Ref } from 'vue'
@@ -28,15 +30,36 @@ export function addGlobalInjections(router: Router) {
   config.global.mocks.$router = router
   config.global.mocks.$route = route
 
+  config.global.components.RouterView = RouterView
+  config.global.components.RouterLink = RouterLink
+
   config.global.stubs.RouterLink = true
   config.global.stubs.RouterView = true
 
   return { router, route }
 }
 
-export function createMockedRouter() {
+export interface RouterMock extends Router {
+  /**
+   * Set a value to be returned on a navigation guard for the next navigation.
+   *
+   * @param returnValue value that will be returned on a simulated navigation
+   * guard
+   */
+  setNextGuardReturn(
+    returnValue: Error | boolean | RouteLocationRaw | undefined
+  ): void
+
+  /**
+   * Returns a Promise of the pending navigation. Resolves right away if there
+   * isn't any.
+   */
+  getPendingNavigation(): ReturnType<Router['push']>
+}
+
+export function createMockedRouter(): RouterMock {
   const router = createRouter({
-    history: createWebHashHistory(),
+    history: createMemoryHistory(),
     routes: [
       {
         path: '/:pathMatch(.*)*',