refactor: move install to its own function

diff --git a/src/install.ts b/src/install.ts
new file mode 100644 (file)
index 0000000..204af6e
--- /dev/null
+++ b/src/install.ts
@@ -0,0 +1,99 @@
+import { App, ComputedRef, reactive } from 'vue'
+import { Router } from './router'
+import { Link } from './components/Link'
+import { View } from './components/View'
+import { isBrowser } from './utils'
+import {
+  START_LOCATION_NORMALIZED,
+  RouteLocationNormalizedLoaded,
+  NavigationGuardWithThis,
+  NavigationGuard,
+} from './types'
+import { routerKey, routeLocationKey } from './utils/injectionSymbols'
+
+declare module '@vue/runtime-core' {
+  interface ComponentCustomOptions {
+    /**
+     * Guard called when the router is navigating to the route that is rendering
+     * this component from a different route. Differently from `beforeRouteUpdate`
+     * and `beforeRouteLeave`, `beforeRouteEnter` does not have access to the
+     * component instance through `this` because it triggers before the component
+     * is even mounted.
+     *
+     * @param to - RouteLocationRaw we are navigating to
+     * @param from - RouteLocationRaw we are navigating from
+     * @param next - function to validate, cancel or modify (by redirecting) the
+     * navigation
+     */
+    beforeRouteEnter?: NavigationGuardWithThis<undefined>
+
+    /**
+     * Guard called whenever the route that renders this component has changed but
+     * it is reused for the new route. This allows you to guard for changes in
+     * params, the query or the hash.
+     *
+     * @param to - RouteLocationRaw we are navigating to
+     * @param from - RouteLocationRaw we are navigating from
+     * @param next - function to validate, cancel or modify (by redirecting) the
+     * navigation
+     */
+    beforeRouteUpdate?: NavigationGuard
+
+    /**
+     * Guard called when the router is navigating away from the current route that
+     * is rendering this component.
+     *
+     * @param to - RouteLocationRaw we are navigating to
+     * @param from - RouteLocationRaw we are navigating from
+     * @param next - function to validate, cancel or modify (by redirecting) the
+     * navigation
+     */
+    beforeRouteLeave?: NavigationGuard
+  }
+
+  interface ComponentCustomProperties {
+    /**
+     * Normalized current location. See {@link RouteLocationNormalizedLoaded}.
+     */
+    $route: RouteLocationNormalizedLoaded
+    /**
+     * {@link Router} instance used by the application.
+     */
+    $router: Router
+  }
+}
+
+export function applyRouterPlugin(app: App, router: Router) {
+  app.component('RouterLink', Link)
+  app.component('RouterView', View)
+
+  // TODO: add tests
+  app.config.globalProperties.$router = router
+  Object.defineProperty(app.config.globalProperties, '$route', {
+    get: () => router.currentRoute.value,
+  })
+
+  // this initial navigation is only necessary on client, on server it doesn't
+  // make sense because it will create an extra unnecessary navigation and could
+  // lead to problems
+  if (isBrowser && router.currentRoute.value === START_LOCATION_NORMALIZED) {
+    router.push(router.history.location.fullPath).catch(err => {
+      if (__DEV__)
+        console.error('Unhandled error when starting the router', err)
+    })
+  }
+
+  const reactiveRoute = {} as {
+    [k in keyof RouteLocationNormalizedLoaded]: ComputedRef<
+      RouteLocationNormalizedLoaded[k]
+    >
+  }
+  for (let key in START_LOCATION_NORMALIZED) {
+    // @ts-ignore: the key matches
+    reactiveRoute[key] = computed(() => router.currentRoute.value[key])
+  }
+
+  app.provide(routerKey, router)
+  app.provide(routeLocationKey, reactive(reactiveRoute))
+  // TODO: merge strats for beforeRoute hooks
+}

diff --git a/src/router.ts b/src/router.ts
index 97ce880bbde4555865e4042a02d7cf6b7a475c1c..8d1373401cb8e3a47047cbdd2bfb329aacf2619a 100644 (file)
--- a/src/router.ts
+++ b/src/router.ts
@@ -2,7 +2,6 @@ import {
   RouteLocationNormalized,
   RouteRecordRaw,
   RouteLocationRaw,
-  NavigationGuard,
   PostNavigationGuard,
   START_LOCATION_NORMALIZED,
   Lazy,
@@ -40,23 +39,11 @@ import {
   parseQuery as originalParseQuery,
   stringifyQuery as originalStringifyQuery,
 } from './utils/query'
-import {
-  ref,
-  Ref,
-  markRaw,
-  nextTick,
-  App,
-  warn,
-  computed,
-  reactive,
-  ComputedRef,
-} from 'vue'
+import { ref, Ref, markRaw, nextTick, App, warn } from 'vue'
 import { RouteRecord, RouteRecordNormalized } from './matcher/types'
-import { Link } from './components/Link'
-import { View } from './components/View'
-import { routerKey, routeLocationKey } from './utils/injectionSymbols'
 import { parseURL, stringifyURL, isSameRouteLocation } from './utils/location'
 import { extractComponentsGuards, guardToPromiseFn } from './navigationGuards'
+import { applyRouterPlugin } from './install'
 
 /**
  * Internal type to define an ErrorHandler
@@ -713,93 +700,6 @@ export function createRouter({
   return router
 }
 
-declare module '@vue/runtime-core' {
-  interface ComponentCustomOptions {
-    /**
-     * Guard called when the router is navigating to the route that is rendering
-     * this component from a different route. Differently from `beforeRouteUpdate`
-     * and `beforeRouteLeave`, `beforeRouteEnter` does not have access to the
-     * component instance through `this` because it triggers before the component
-     * is even mounted.
-     *
-     * @param to - RouteLocationRaw we are navigating to
-     * @param from - RouteLocationRaw we are navigating from
-     * @param next - function to validate, cancel or modify (by redirecting) the
-     * navigation
-     */
-    beforeRouteEnter?: NavigationGuardWithThis<undefined>
-
-    /**
-     * Guard called whenever the route that renders this component has changed but
-     * it is reused for the new route. This allows you to guard for changes in
-     * params, the query or the hash.
-     *
-     * @param to - RouteLocationRaw we are navigating to
-     * @param from - RouteLocationRaw we are navigating from
-     * @param next - function to validate, cancel or modify (by redirecting) the
-     * navigation
-     */
-    beforeRouteUpdate?: NavigationGuard
-
-    /**
-     * Guard called when the router is navigating away from the current route that
-     * is rendering this component.
-     *
-     * @param to - RouteLocationRaw we are navigating to
-     * @param from - RouteLocationRaw we are navigating from
-     * @param next - function to validate, cancel or modify (by redirecting) the
-     * navigation
-     */
-    beforeRouteLeave?: NavigationGuard
-  }
-
-  interface ComponentCustomProperties {
-    /**
-     * Normalized current location. See {@link RouteLocationNormalizedLoaded}.
-     */
-    $route: RouteLocationNormalizedLoaded
-    /**
-     * {@link Router} instance used by the application.
-     */
-    $router: Router
-  }
-}
-
-function applyRouterPlugin(app: App, router: Router) {
-  app.component('RouterLink', Link)
-  app.component('RouterView', View)
-
-  // TODO: add tests
-  app.config.globalProperties.$router = router
-  Object.defineProperty(app.config.globalProperties, '$route', {
-    get: () => router.currentRoute.value,
-  })
-
-  // this initial navigation is only necessary on client, on server it doesn't
-  // make sense because it will create an extra unnecessary navigation and could
-  // lead to problems
-  if (isBrowser && router.currentRoute.value === START_LOCATION_NORMALIZED) {
-    router.push(router.history.location.fullPath).catch(err => {
-      if (__DEV__)
-        console.error('Unhandled error when starting the router', err)
-    })
-  }
-
-  const reactiveRoute = {} as {
-    [k in keyof RouteLocationNormalizedLoaded]: ComputedRef<
-      RouteLocationNormalizedLoaded[k]
-    >
-  }
-  for (let key in START_LOCATION_NORMALIZED) {
-    // @ts-ignore: the key matches
-    reactiveRoute[key] = computed(() => router.currentRoute.value[key])
-  }
-
-  app.provide(routerKey, router)
-  app.provide(routeLocationKey, reactive(reactiveRoute))
-  // TODO: merge strats for beforeRoute hooks
-}
-
 async function runGuardQueue(guards: Lazy<any>[]): Promise<void> {
   for (const guard of guards) {
     await guard()

diff --git a/src/scrollBehavior.ts b/src/scrollBehavior.ts
index 280e8283c735ddfc94bfe52d8efe31d9a7dda108..c0fe79f4644db4e1b9a5e81464a601121d0abfac 100644 (file)
--- a/src/scrollBehavior.ts
+++ b/src/scrollBehavior.ts
@@ -22,7 +22,7 @@ export interface ScrollPositionElement {
    * - `.content:first-child`
    * - `#marker`
    * - `#marker~with~symbols`
-   * - `#marker.with.dot` -> selects `id="marker.with.dot"`, not `class="with dot" id="marker"`
+   * - `#marker.with.dot`: selects `id="marker.with.dot"`, not `class="with dot" id="marker"`
    *
    */
   selector: string