From acf4ae8f96b793ef16111e36896304ab28ebf167 Mon Sep 17 00:00:00 2001 From: Joshua Chen Date: Fri, 11 Feb 2022 19:16:13 +0800 Subject: [PATCH] refactor: reduce exported members of docusaurus router (#6651) --- packages/docusaurus-module-type-aliases/src/index.d.ts | 8 ++------ .../docusaurus-theme-common/src/utils/historyUtils.ts | 2 +- .../src/utils/useLocationChange.ts | 2 +- packages/docusaurus/src/client/PendingNavigation.tsx | 2 +- packages/docusaurus/src/client/exports/router.ts | 3 +-- packages/docusaurus/src/client/normalizeLocation.ts | 2 +- 6 files changed, 7 insertions(+), 12 deletions(-) diff --git a/packages/docusaurus-module-type-aliases/src/index.d.ts b/packages/docusaurus-module-type-aliases/src/index.d.ts index 8bbd6d1030..fa197c282f 100644 --- a/packages/docusaurus-module-type-aliases/src/index.d.ts +++ b/packages/docusaurus-module-type-aliases/src/index.d.ts @@ -240,12 +240,8 @@ declare module '@docusaurus/Translate' { } declare module '@docusaurus/router' { - // eslint-disable-next-line import/no-extraneous-dependencies, no-restricted-syntax - export * from 'react-router-dom'; -} -declare module '@docusaurus/history' { - // eslint-disable-next-line import/no-extraneous-dependencies, no-restricted-syntax - export * from 'history'; + // eslint-disable-next-line import/no-extraneous-dependencies + export {useHistory, useLocation, Redirect, matchPath} from 'react-router-dom'; } declare module '@docusaurus/useDocusaurusContext' { diff --git a/packages/docusaurus-theme-common/src/utils/historyUtils.ts b/packages/docusaurus-theme-common/src/utils/historyUtils.ts index 6af29066ac..c0a289dcc1 100644 --- a/packages/docusaurus-theme-common/src/utils/historyUtils.ts +++ b/packages/docusaurus-theme-common/src/utils/historyUtils.ts @@ -7,7 +7,7 @@ import {useEffect, useRef} from 'react'; import {useHistory} from '@docusaurus/router'; -import type {Location, Action} from '@docusaurus/history'; +import type {Location, Action} from 'history'; type HistoryBlockHandler = (location: Location, action: Action) => void | false; diff --git a/packages/docusaurus-theme-common/src/utils/useLocationChange.ts b/packages/docusaurus-theme-common/src/utils/useLocationChange.ts index a584f2757e..89cc27be45 100644 --- a/packages/docusaurus-theme-common/src/utils/useLocationChange.ts +++ b/packages/docusaurus-theme-common/src/utils/useLocationChange.ts @@ -7,7 +7,7 @@ import {useEffect} from 'react'; import {useLocation} from '@docusaurus/router'; -import type {Location} from '@docusaurus/history'; +import type {Location} from 'history'; import {usePrevious} from './usePrevious'; import {useDynamicCallback} from './reactUtils'; diff --git a/packages/docusaurus/src/client/PendingNavigation.tsx b/packages/docusaurus/src/client/PendingNavigation.tsx index aab379992d..7e89df324c 100644 --- a/packages/docusaurus/src/client/PendingNavigation.tsx +++ b/packages/docusaurus/src/client/PendingNavigation.tsx @@ -13,7 +13,7 @@ import nprogress from 'nprogress'; import clientLifecyclesDispatcher from './client-lifecycles-dispatcher'; import preload from './preload'; import normalizeLocation from './normalizeLocation'; -import type {Location} from '@docusaurus/history'; +import type {Location} from 'history'; import './nprogress.css'; diff --git a/packages/docusaurus/src/client/exports/router.ts b/packages/docusaurus/src/client/exports/router.ts index d1ba52fb3b..453530b353 100644 --- a/packages/docusaurus/src/client/exports/router.ts +++ b/packages/docusaurus/src/client/exports/router.ts @@ -5,5 +5,4 @@ * LICENSE file in the root directory of this source tree. */ -// eslint-disable-next-line no-restricted-syntax -export * from 'react-router-dom'; +export {useHistory, useLocation, Redirect, matchPath} from 'react-router-dom'; diff --git a/packages/docusaurus/src/client/normalizeLocation.ts b/packages/docusaurus/src/client/normalizeLocation.ts index 19aa8a3895..45a479ca62 100644 --- a/packages/docusaurus/src/client/normalizeLocation.ts +++ b/packages/docusaurus/src/client/normalizeLocation.ts @@ -5,7 +5,7 @@ * LICENSE file in the root directory of this source tree. */ -import type {Location} from '@docusaurus/history'; +import type {Location} from 'history'; // Memoize previously normalized pathnames. const pathnames: Record = {};