3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 00:39:45 +02:00
Code Issues Projects Releases Packages Wiki Activity

refactor(core): move browserContext and docusaurusContext out of client exports (#6955)

Browse source
This commit is contained in:
Joshua Chen 2022-03-22 14:30:14 +08:00 • committed by GitHub
parent 6b3d94a155
commit 0a5354dc32
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 17 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

4
jest.config.mjs
View file

@ -40,8 +40,10 @@ export default {
'^.+\\.(css|jpe?g|png|svg|webp)$': '<rootDir>/jest/emptyModule.ts',
// Using src instead of lib, so we always get fresh source
'@docusaurus/(browserContext|BrowserOnly|ComponentCreator|constants|docusaurusContext|ExecutionEnvironment|Head|Interpolate|isInternalUrl|Link|Noop|renderRoutes|router|Translate|use.*)':
'@docusaurus/(BrowserOnly|ComponentCreator|constants|ExecutionEnvironment|Head|Interpolate|isInternalUrl|Link|Noop|renderRoutes|router|Translate|use.*)':
'@docusaurus/core/src/client/exports/$1',
// TODO create dedicated testing utility for mocking contexts
// Maybe point to a fixture?
'@generated/.*': '<rootDir>/jest/emptyModule.ts',
// TODO use "projects" + multiple configs if we work on another theme?

2
packages/docusaurus-theme-common/src/utils/__tests__/docsUtils.test.tsx
View file

@ -20,7 +20,7 @@ import {
useSidebarBreadcrumbs,
} from '../docsUtils';
import {StaticRouter} from 'react-router-dom';
import {Context} from '@docusaurus/docusaurusContext';
import {Context} from '@docusaurus/core/src/client/docusaurusContext';
import type {
PropSidebar,
PropSidebarItem,

2
packages/docusaurus-theme-common/src/utils/__tests__/generalUtils.test.tsx
View file

@ -8,7 +8,7 @@
import React from 'react';
import {useTitleFormatter} from '../generalUtils';
import {renderHook} from '@testing-library/react-hooks';
import {Context} from '@docusaurus/docusaurusContext';
import {Context} from '@docusaurus/core/src/client/docusaurusContext';
import type {DocusaurusContext} from '@docusaurus/types';
describe('useTitleFormatter', () => {

2
packages/docusaurus-theme-common/src/utils/__tests__/useAlternatePageUtils.test.tsx
View file

@ -9,7 +9,7 @@ import React from 'react';
import {useAlternatePageUtils} from '../useAlternatePageUtils';
import {renderHook} from '@testing-library/react-hooks';
import {StaticRouter} from 'react-router-dom';
import {Context} from '@docusaurus/docusaurusContext';
import {Context} from '@docusaurus/core/src/client/docusaurusContext';
import type {DocusaurusContext} from '@docusaurus/types';
describe('useAlternatePageUtils', () => {

2
packages/docusaurus-theme-common/src/utils/__tests__/useLocalPathname.test.tsx
View file

@ -9,7 +9,7 @@ import React from 'react';
import {useLocalPathname} from '../useLocalPathname';
import {renderHook} from '@testing-library/react-hooks';
import {StaticRouter} from 'react-router-dom';
import {Context} from '@docusaurus/docusaurusContext';
import {Context} from '@docusaurus/core/src/client/docusaurusContext';
import type {DocusaurusContext} from '@docusaurus/types';
describe('useLocalPathname', () => {

2
packages/docusaurus-theme-common/src/utils/__tests__/usePluralForm.test.tsx
View file

@ -9,7 +9,7 @@ import {jest} from '@jest/globals';
import React from 'react';
import {usePluralForm} from '../usePluralForm';
import {renderHook} from '@testing-library/react-hooks';
import {Context} from '@docusaurus/docusaurusContext';
import {Context} from '@docusaurus/core/src/client/docusaurusContext';
import type {DocusaurusContext} from '@docusaurus/types';
describe('usePluralForm', () => {

4
packages/docusaurus/src/client/App.tsx
View file

@ -9,8 +9,8 @@ import React from 'react';
import routes from '@generated/routes';
import renderRoutes from './exports/renderRoutes';
import {BrowserContextProvider} from './exports/browserContext';
import {DocusaurusContextProvider} from './exports/docusaurusContext';
import {BrowserContextProvider} from './browserContext';
import {DocusaurusContextProvider} from './docusaurusContext';
import PendingNavigation from './PendingNavigation';
import BaseUrlIssueBanner from './baseUrlIssueBanner/BaseUrlIssueBanner';
import SiteMetadataDefaults from './SiteMetadataDefaults';

2
packages/docusaurus/src/client/exports/__tests__/browserContext.test.tsx → packages/docusaurus/src/client/__tests__/browserContext.test.tsx
View file

@ -12,7 +12,7 @@
import React from 'react';
import {renderHook} from '@testing-library/react-hooks/server';
import {BrowserContextProvider} from '../browserContext';
import useIsBrowser from '../useIsBrowser';
import useIsBrowser from '../exports/useIsBrowser';
describe('BrowserContextProvider', () => {
const {result, hydrate} = renderHook(() => useIsBrowser(), {

2
packages/docusaurus/src/client/exports/__tests__/docusaurusContext.test.tsx → packages/docusaurus/src/client/__tests__/docusaurusContext.test.tsx
View file

@ -12,7 +12,7 @@
import React from 'react';
import {renderHook} from '@testing-library/react-hooks/server';
import {DocusaurusContextProvider} from '../docusaurusContext';
import useDocusaurusContext from '../useDocusaurusContext';
import useDocusaurusContext from '../exports/useDocusaurusContext';
// This test currently isn't quite useful because the @generated aliases point
// to the empty modules. Maybe we can point that to fixtures in the future.

0
packages/docusaurus/src/client/exports/browserContext.tsx → packages/docusaurus/src/client/browserContext.tsx
View file

0
packages/docusaurus/src/client/exports/docusaurusContext.tsx → packages/docusaurus/src/client/docusaurusContext.tsx
View file

2
packages/docusaurus/src/client/exports/__tests__/BrowserOnly.test.tsx
View file

@ -12,7 +12,7 @@
import React from 'react';
import renderer from 'react-test-renderer';
import BrowserOnly from '../BrowserOnly';
import {Context} from '../browserContext';
import {Context} from '../../browserContext';
describe('<BrowserOnly>', () => {
const originalEnv = process.env;

2
packages/docusaurus/src/client/exports/__tests__/useBaseUrl.test.tsx
View file

@ -8,7 +8,7 @@
import React from 'react';
import {renderHook} from '@testing-library/react-hooks';
import useBaseUrl, {useBaseUrlUtils} from '../useBaseUrl';
import {Context} from '../docusaurusContext';
import {Context} from '../../docusaurusContext';
import type {DocusaurusContext} from '@docusaurus/types';
import type {BaseUrlOptions} from '@docusaurus/useBaseUrl';

2
packages/docusaurus/src/client/exports/__tests__/useGlobalData.test.tsx
View file

@ -11,7 +11,7 @@ import useGlobalData, {
useAllPluginInstancesData,
usePluginData,
} from '../useGlobalData';
import {Context} from '../docusaurusContext';
import {Context} from '../../docusaurusContext';
describe('useGlobalData', () => {
it('returns global data from context', () => {

2
packages/docusaurus/src/client/exports/useDocusaurusContext.ts
View file

@ -6,7 +6,7 @@
*/
import {useContext} from 'react';
import {Context} from './docusaurusContext';
import {Context} from '../docusaurusContext';
import type {DocusaurusContext} from '@docusaurus/types';
export default function useDocusaurusContext(): DocusaurusContext {

2
packages/docusaurus/src/client/exports/useIsBrowser.ts
View file

@ -6,7 +6,7 @@
*/
import {useContext} from 'react';
import {Context} from './browserContext';
import {Context} from '../browserContext';
export default function useIsBrowser(): boolean {
return useContext(Context);

4
packages/docusaurus/src/webpack/__tests__/__snapshots__/base.test.ts.snap
View file

@ -11,9 +11,7 @@ exports[`base webpack config creates webpack aliases 1`] = `
"@docusaurus/Link": "../../../../client/exports/Link.tsx",
"@docusaurus/Noop": "../../../../client/exports/Noop.ts",
"@docusaurus/Translate": "../../../../client/exports/Translate.tsx",
"@docusaurus/browserContext": "../../../../client/exports/browserContext.tsx",
"@docusaurus/constants": "../../../../client/exports/constants.ts",
"@docusaurus/docusaurusContext": "../../../../client/exports/docusaurusContext.tsx",
"@docusaurus/isInternalUrl": "../../../../client/exports/isInternalUrl.ts",
"@docusaurus/renderRoutes": "../../../../client/exports/renderRoutes.ts",
"@docusaurus/router": "../../../../client/exports/router.ts",
@ -61,9 +59,7 @@ exports[`getDocusaurusAliases() returns appropriate webpack aliases 1`] = `
"@docusaurus/Link": "../../client/exports/Link.tsx",
"@docusaurus/Noop": "../../client/exports/Noop.ts",
"@docusaurus/Translate": "../../client/exports/Translate.tsx",
"@docusaurus/browserContext": "../../client/exports/browserContext.tsx",
"@docusaurus/constants": "../../client/exports/constants.ts",
"@docusaurus/docusaurusContext": "../../client/exports/docusaurusContext.tsx",
"@docusaurus/isInternalUrl": "../../client/exports/isInternalUrl.ts",
"@docusaurus/renderRoutes": "../../client/exports/renderRoutes.ts",
"@docusaurus/router": "../../client/exports/router.ts",