Finish build function

facebook · Oct 16, 2021 · 9094c89 · 9094c89
1 parent f0b4c2f
commit 9094c89
Show file tree

Hide file tree

Showing 33 changed files with 1,838 additions and 1,634 deletions.
diff --git a/examples/classic-typescript/package.json b/examples/classic-typescript/package.json
@@ -16,8 +16,8 @@
     "dev": "docusaurus start"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.6",
-    "@docusaurus/preset-classic": "2.0.0-beta.6",
+    "@docusaurus/core": "2.0.0-beta.7",
+    "@docusaurus/preset-classic": "2.0.0-beta.7",
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
@@ -28,7 +28,7 @@
     "url-loader": "^4.1.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.6",
+    "@docusaurus/module-type-aliases": "2.0.0-beta.7",
     "@tsconfig/docusaurus": "^1.0.4",
     "@types/react": "^17.0.14",
     "@types/react-helmet": "^6.1.2",
@@ -48,4 +48,4 @@
     ]
   },
   "description": "Docusaurus example project (classic-typescript template)"
-}
+}
diff --git a/examples/classic/package.json b/examples/classic/package.json
@@ -15,8 +15,8 @@
     "dev": "docusaurus start"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.6",
-    "@docusaurus/preset-classic": "2.0.0-beta.6",
+    "@docusaurus/core": "2.0.0-beta.7",
+    "@docusaurus/preset-classic": "2.0.0-beta.7",
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
@@ -39,4 +39,4 @@
     ]
   },
   "description": "Docusaurus example project"
-}
+}
diff --git a/examples/facebook/package.json b/examples/facebook/package.json
@@ -19,8 +19,8 @@
     "dev": "docusaurus start"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.6",
-    "@docusaurus/preset-classic": "2.0.0-beta.6",
+    "@docusaurus/core": "2.0.0-beta.7",
+    "@docusaurus/preset-classic": "2.0.0-beta.7",
     "@mdx-js/react": "^1.6.21",
     "@svgr/webpack": "^5.5.0",
     "clsx": "^1.1.1",
@@ -55,4 +55,4 @@
     ]
   },
   "description": "Docusaurus example project (facebook template)"
-}
+}
diff --git a/jest.config.js b/jest.config.js
@@ -41,6 +41,6 @@ module.exports = {
     // Maybe point to a fixture?
     '@generated/.*': '<rootDir>/jest/emptyModule.js',
     // TODO maybe use "projects" + multiple configs if we plan to add tests to another theme?
-    '@theme/(.*)': '@docusaurus/theme-classic/lib-next/theme/$1',
+    '@theme/(.*)': '@docusaurus/theme-classic/lib/theme/$1',
   },
 };
diff --git a/packages/create-docusaurus/bin/index.js b/packages/create-docusaurus/bin/index.js
@@ -1,7 +1,4 @@
 #!/usr/bin/env node
-
-// TODO remove when fixed: https://github.com/Stuk/eslint-plugin-header/issues/39
-/* eslint-disable header/header */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *

diff --git a/packages/docusaurus-migrate/bin/index.js b/packages/docusaurus-migrate/bin/index.js
@@ -1,7 +1,4 @@
 #!/usr/bin/env node
-
-// TODO remove when fixed: https://github.com/Stuk/eslint-plugin-header/issues/39
-/* eslint-disable header/header */
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *

diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json
@@ -19,9 +19,7 @@
   "license": "MIT",
   "dependencies": {
     "@docusaurus/core": "2.0.0-beta.7",
-    "@docusaurus/types": "2.0.0-beta.7",
     "@docusaurus/utils": "2.0.0-beta.7",
-    "@docusaurus/utils-build": "2.0.0-beta.7",
     "@docusaurus/utils-common": "2.0.0-beta.7",
     "@docusaurus/utils-validation": "2.0.0-beta.7",
     "chalk": "^4.1.2",
@@ -31,6 +29,10 @@
     "lodash": "^4.17.20",
     "tslib": "^2.3.1"
   },
+  "devDependencies": {
+    "@docusaurus/types": "2.0.0-beta.7",
+    "@docusaurus/utils-build": "2.0.0-beta.7"
+  },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"

diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json
@@ -20,9 +20,7 @@
   "dependencies": {
     "@docusaurus/core": "2.0.0-beta.7",
     "@docusaurus/mdx-loader": "2.0.0-beta.7",
-    "@docusaurus/types": "2.0.0-beta.7",
     "@docusaurus/utils": "2.0.0-beta.7",
-    "@docusaurus/utils-build": "2.0.0-beta.7",
     "@docusaurus/utils-validation": "2.0.0-beta.7",
     "chalk": "^4.1.2",
     "escape-string-regexp": "^4.0.0",
@@ -38,6 +36,10 @@
     "utility-types": "^3.10.0",
     "webpack": "^5.40.0"
   },
+  "devDependencies": {
+    "@docusaurus/types": "2.0.0-beta.7",
+    "@docusaurus/utils-build": "2.0.0-beta.7"
+  },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"

diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json
@@ -18,8 +18,9 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@docusaurus/utils-build": "2.0.0-beta.7",
     "@docusaurus/module-type-aliases": "2.0.0-beta.7",
+    "@docusaurus/types": "2.0.0-beta.7",
+    "@docusaurus/utils-build": "2.0.0-beta.7",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -29,7 +30,6 @@
   "dependencies": {
     "@docusaurus/core": "2.0.0-beta.7",
     "@docusaurus/mdx-loader": "2.0.0-beta.7",
-    "@docusaurus/types": "2.0.0-beta.7",
     "@docusaurus/utils": "2.0.0-beta.7",
     "@docusaurus/utils-validation": "2.0.0-beta.7",
     "chalk": "^4.1.2",

diff --git a/packages/docusaurus-plugin-content-docs/src/index.ts b/packages/docusaurus-plugin-content-docs/src/index.ts
@@ -77,7 +77,7 @@ export default function pluginContentDocs(
     name: 'docusaurus-plugin-content-docs',
 
     getThemePath() {
-      return path.resolve(__dirname, 'js-theme');
+      return path.resolve(__dirname, 'theme');
     },
 
     getTypeScriptThemePath() {

diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json
@@ -20,16 +20,18 @@
   "dependencies": {
     "@docusaurus/core": "2.0.0-beta.7",
     "@docusaurus/mdx-loader": "2.0.0-beta.7",
-    "@docusaurus/types": "2.0.0-beta.7",
     "@docusaurus/utils": "2.0.0-beta.7",
-    "@docusaurus/utils-build": "2.0.0-beta.7",
     "@docusaurus/utils-validation": "2.0.0-beta.7",
     "globby": "^11.0.2",
     "lodash": "^4.17.20",
     "remark-admonitions": "^1.2.1",
     "tslib": "^2.3.1",
     "webpack": "^5.40.0"
   },
+  "devDependencies": {
+    "@docusaurus/types": "2.0.0-beta.7",
+    "@docusaurus/utils-build": "2.0.0-beta.7"
+  },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"

diff --git a/packages/docusaurus-plugin-debug/copyUntypedFiles.js b/packages/docusaurus-plugin-debug/copyUntypedFiles.js
diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json
@@ -26,7 +26,7 @@
     "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@docusaurus/utils-plugin": "2.0.0-beta.6"
+    "@docusaurus/utils-build": "2.0.0-beta.7"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",

diff --git a/packages/docusaurus-plugin-debug/src/index.ts b/packages/docusaurus-plugin-debug/src/index.ts
@@ -24,7 +24,7 @@ export default function pluginDebug({
     name: 'docusaurus-plugin-debug',
 
     getThemePath() {
-      return path.resolve(__dirname, 'js-theme');
+      return path.resolve(__dirname, 'theme');
     },
 
     getTypeScriptThemePath() {

diff --git a/packages/docusaurus-plugin-ideal-image/copyUntypedFiles.js b/packages/docusaurus-plugin-ideal-image/copyUntypedFiles.js
diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json
@@ -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": "docusaurus-plugin build",
     "watch": "docusaurus-plugin watch"
@@ -17,7 +18,7 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@docusaurus/utils-plugin": "2.0.0-beta.6",
+    "@docusaurus/utils-build": "2.0.0-beta.7",
     "fs-extra": "^10.0.0"
   },
   "dependencies": {

diff --git a/packages/docusaurus-plugin-ideal-image/src/index.ts b/packages/docusaurus-plugin-ideal-image/src/index.ts
@@ -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';
@@ -18,7 +18,11 @@ export default function (
     name: 'docusaurus-plugin-ideal-image',
 
     getThemePath() {
-      return path.resolve(__dirname, './theme');
+      return path.resolve(__dirname, 'theme');
+    },
+
+    getTypeScriptThemePath() {
+      return path.resolve(__dirname, '..', 'src', 'theme');
     },
 
     configureWebpack(_config: Configuration, isServer: boolean) {

diff --git a/packages/docusaurus-plugin-ideal-image/src/plugin-ideal-image.d.ts b/packages/docusaurus-plugin-ideal-image/src/plugin-ideal-image.d.ts
@@ -0,0 +1,41 @@
+/**
+ * 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 '@endiliey/react-ideal-image';
diff --git a/...lugin-ideal-image/src/theme/IdealImage.js → ...ugin-ideal-image/src/theme/IdealImage.tsx b/...lugin-ideal-image/src/theme/IdealImage.js → ...ugin-ideal-image/src/theme/IdealImage.tsx
@@ -8,7 +8,7 @@
 import React from 'react';
 import IdealImage from '@endiliey/react-ideal-image';
 
-function Image(props) {
+function Image(props: React.ComponentProps<'img'> & {img: any}): JSX.Element {
   const {alt, className, img} = props;
 
   // In dev env just use regular img with original file
@@ -25,7 +25,7 @@ function Image(props) {
       width={img.src.width || 100}
       placeholder={{lqip: img.preSrc}}
       src={img.src.src}
-      srcSet={img.src.images.map((image) => ({
+      srcSet={img.src.images.map((image: any) => ({
         ...image,
         src: image.path,
       }))}

diff --git a/packages/docusaurus-plugin-ideal-image/src/types.ts b/packages/docusaurus-plugin-ideal-image/src/types.ts
diff --git a/packages/docusaurus-theme-classic/package.json b/packages/docusaurus-theme-classic/package.json
@@ -25,7 +25,6 @@
     "@docusaurus/plugin-content-docs": "2.0.0-beta.7",
     "@docusaurus/plugin-content-pages": "2.0.0-beta.7",
     "@docusaurus/theme-common": "2.0.0-beta.7",
-    "@docusaurus/types": "2.0.0-beta.7",
     "@docusaurus/utils": "2.0.0-beta.7",
     "@docusaurus/utils-build": "2.0.0-beta.7",
     "@docusaurus/utils-common": "2.0.0-beta.7",
@@ -49,6 +48,7 @@
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.0.0-beta.7",
+    "@docusaurus/types": "2.0.0-beta.7",
     "@docusaurus/utils-build": "2.0.0-beta.7",
     "@types/mdx-js__react": "^1.5.4",
     "@types/parse-numeric-range": "^0.0.1",