Skip to content

Commit

Permalink
refactor(module-type-aliases): remove fallback aliases (#5726)
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh-Cena authored Oct 20, 2021
1 parent 6763496 commit 90098ca
Show file tree
Hide file tree
Showing 10 changed files with 97 additions and 61 deletions.
36 changes: 33 additions & 3 deletions packages/docusaurus-module-type-aliases/src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,41 @@ declare module '@generated/codeTranslations' {
export default codeTranslations;
}

declare module '@theme/*';

declare module '@theme-original/*';

declare module '@docusaurus/*';
declare module '@theme/Layout' {
import type {ReactNode} from 'react';

export interface Props {
readonly children: ReactNode;
readonly title?: string;
readonly description?: string;
}
export default function Layout(props: Props): JSX.Element;
}

declare module '@theme/Loading' {
import type {LoadingComponentProps} from 'react-loadable';

export default function Loading(props: LoadingComponentProps): JSX.Element;
}

declare module '@theme/NotFound' {
export default function NotFound(props: any): JSX.Element;
}

declare module '@theme/Root' {
import type {ReactNode} from 'react';

export interface Props {
readonly children: ReactNode;
}
export default function Root({children}: Props): JSX.Element;
}

declare module '@docusaurus/constants' {
export const DEFAULT_PLUGIN_ID: 'default';
}

declare module '@docusaurus/Head' {
import type {HelmetProps} from 'react-helmet';
Expand Down
3 changes: 1 addition & 2 deletions packages/docusaurus-plugin-ideal-image/.npmignore
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
src
copyUntypedFiles.js
copyUntypedFiles.js
1 change: 1 addition & 0 deletions packages/docusaurus-plugin-ideal-image/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "2.0.0-beta.7",
"description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).",
"main": "lib/index.js",
"types": "src/plugin-ideal-image.d.ts",
"scripts": {
"build": "tsc && node copyUntypedFiles.js",
"watch": "node copyUntypedFiles.js && tsc --watch"
Expand Down
2 changes: 1 addition & 1 deletion packages/docusaurus-plugin-ideal-image/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* LICENSE file in the root directory of this source tree.
*/
import {LoadContext, Plugin} from '@docusaurus/types';
import {PluginOptions} from './types';
import type {PluginOptions} from '@docusaurus/plugin-ideal-image';
import {Configuration} from 'webpack';

import path from 'path';
Expand Down
50 changes: 50 additions & 0 deletions packages/docusaurus-plugin-ideal-image/src/plugin-ideal-image.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

declare module '@docusaurus/plugin-ideal-image' {
export type PluginOptions = {
/**
* Filename template for output files.
*/
name?: string;
/**
* Specify all widths you want to use; if a specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up). You may also declare a default sizes array in the loader options in your webpack.config.js.
*/
sizes?: number[];
/**
* Specify one width you want to use; if the specified size exceeds the original image's width, the latter will be used (i.e. images won't be scaled up)
*/
size?: number;
/**
* As an alternative to manually specifying sizes, you can specify min, max and steps, and the sizes will be generated for you.
*/
min?: number;
/**
* See min above
*/
max?: number;
/**
* Configure the number of images generated between min and max (inclusive)
*/
steps?: number;
/**
* JPEG compression quality
*/
quality?: number;
};
}

declare module '@theme/IdealImage' {
import type {ComponentProps} from 'react';

export interface Props extends ComponentProps<'img'> {
img: any;
}
export default function IdealImage(props: Props): JSX.Element;
}

declare module '@endiliey/react-ideal-image';
37 changes: 0 additions & 37 deletions packages/docusaurus-plugin-ideal-image/src/types.ts

This file was deleted.

8 changes: 8 additions & 0 deletions packages/docusaurus-theme-classic/src/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ declare module '@theme/AnnouncementBar' {
export default AnnouncementBar;
}

declare module '@theme/BackToTopButton' {
export default function BackToTopButton(): JSX.Element;
}

declare module '@theme/BlogListPaginator' {
import type {Metadata} from '@theme/BlogListPage';

Expand Down Expand Up @@ -505,6 +509,10 @@ declare module '@theme/NavbarItem' {
export default NavbarItem;
}

declare module '@theme/SearchBar' {
export default function SearchBar(): JSX.Element;
}

declare module '@theme/TabItem' {
import type {ReactNode} from 'react';

Expand Down
13 changes: 1 addition & 12 deletions packages/docusaurus/src/client/exports/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,5 @@
* LICENSE file in the root directory of this source tree.
*/

/*
// eslint-disable-next-line no-restricted-imports
export {
// constants were only available on node
// this makes some useful constants available to frontend/themes too
// import {DEFAULT_PLUGIN_ID} '@docusaurus/constants'
DEFAULT_PLUGIN_ID,
} from '../../constants';
*/

// Not duplicating the constants seems to produce
// weird TS compilation side-effects
// Constants used on the client-side: duplicated from server-side code
export const DEFAULT_PLUGIN_ID = 'default';
7 changes: 1 addition & 6 deletions packages/docusaurus/src/client/exports/useGlobalData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,7 @@
*/

import useDocusaurusContext from './useDocusaurusContext';

// TODO annoying constant duplication
// if we import something from outside the /client folder,
// the tsc directory structure is affected
// import {DEFAULT_PLUGIN_ID} from '../../constants';
const DEFAULT_PLUGIN_ID = 'default';
import {DEFAULT_PLUGIN_ID} from './constants';

export default function useGlobalData(): Record<string, unknown> {
const {globalData} = useDocusaurusContext();
Expand Down
1 change: 1 addition & 0 deletions website/src/types.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/// <reference types="@docusaurus/plugin-ideal-image" />

0 comments on commit 90098ca

Please sign in to comment.