@docusaurus/preset-classic 2.0.0-beta.12faed89d → 2.0.0-beta.14

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+import type { Preset, LoadContext } from '@docusaurus/types';
+import type { Options } from '@docusaurus/preset-classic';
+export default function preset(context: LoadContext, opts?: Options): Preset;

package/lib/index.js

@@ -0,0 +1,53 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+function makePluginConfig(source, options) {
+    if (options) {
+        return [require.resolve(source), options];
+    }
+    return require.resolve(source);
+}
+function preset(context, opts = {}) {
+    const { siteConfig } = context;
+    const { themeConfig } = siteConfig;
+    const { algolia } = themeConfig;
+    const isProd = process.env.NODE_ENV === 'production';
+    const { debug, docs, blog, pages, sitemap, theme, googleAnalytics, gtag, ...rest } = opts;
+    const themes = [];
+    themes.push(makePluginConfig('@docusaurus/theme-classic', theme));
+    if (algolia) {
+        themes.push(require.resolve('@docusaurus/theme-search-algolia'));
+    }
+    const plugins = [];
+    if (docs !== false) {
+        plugins.push(makePluginConfig('@docusaurus/plugin-content-docs', docs));
+    }
+    if (blog !== false) {
+        plugins.push(makePluginConfig('@docusaurus/plugin-content-blog', blog));
+    }
+    if (pages !== false) {
+        plugins.push(makePluginConfig('@docusaurus/plugin-content-pages', pages));
+    }
+    if (isProd && googleAnalytics) {
+        plugins.push(makePluginConfig('@docusaurus/plugin-google-analytics', googleAnalytics));
+    }
+    if (debug || (debug === undefined && !isProd)) {
+        plugins.push(require.resolve('@docusaurus/plugin-debug'));
+    }
+    if (isProd && gtag) {
+        plugins.push(makePluginConfig('@docusaurus/plugin-google-gtag', gtag));
+    }
+    if (isProd && sitemap !== false) {
+        plugins.push(makePluginConfig('@docusaurus/plugin-sitemap', sitemap));
+    }
+    if (Object.keys(rest).length > 0) {
+        throw new Error(`Unrecognized keys ${Object.keys(rest).join(', ')} found in preset-classic configuration. The allowed keys are debug, docs, blog, pages, sitemap, theme, googleAnalytics, gtag. Check the documentation: https://docusaurus.io/docs/presets#docusauruspreset-classic for more information on how to configure individual plugins.`);
+    }
+    return { themes, plugins };
+}
+exports.default = preset;

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "@docusaurus/preset-classic",
-  "version": "2.0.0-beta.12faed89d",
+  "version": "2.0.0-beta.14",
   "description": "Classic preset for Docusaurus.",
-  "main": "src/index.js",
+  "main": "lib/index.js",
+  "types": "src/preset-classic.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -13,23 +18,23 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-content-blog": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-content-docs": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-content-pages": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-debug": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-google-analytics": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-google-gtag": "2.0.0-beta.12faed89d",
-    "@docusaurus/plugin-sitemap": "2.0.0-beta.12faed89d",
-    "@docusaurus/theme-classic": "2.0.0-beta.12faed89d",
-    "@docusaurus/theme-search-algolia": "2.0.0-beta.12faed89d"
+    "@docusaurus/core": "2.0.0-beta.14",
+    "@docusaurus/plugin-content-blog": "2.0.0-beta.14",
+    "@docusaurus/plugin-content-docs": "2.0.0-beta.14",
+    "@docusaurus/plugin-content-pages": "2.0.0-beta.14",
+    "@docusaurus/plugin-debug": "2.0.0-beta.14",
+    "@docusaurus/plugin-google-analytics": "2.0.0-beta.14",
+    "@docusaurus/plugin-google-gtag": "2.0.0-beta.14",
+    "@docusaurus/plugin-sitemap": "2.0.0-beta.14",
+    "@docusaurus/theme-classic": "2.0.0-beta.14",
+    "@docusaurus/theme-search-algolia": "2.0.0-beta.14"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
-  "gitHead": "1430dbacfbe9da59a17ce395ed29bdbddaf90049"
+  "gitHead": "c4824a8937d8f1aa0806667749cbc74058e2b294"
 }

package/src/index.ts

@@ -0,0 +1,85 @@
+/**
+ * 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.
+ */
+
+import type {
+  Preset,
+  LoadContext,
+  PluginConfig,
+  PluginOptions,
+} from '@docusaurus/types';
+import type {Options, ThemeConfig} from '@docusaurus/preset-classic';
+
+function makePluginConfig(
+  source: string,
+  options?: PluginOptions,
+): string | [string, PluginOptions] {
+  if (options) {
+    return [require.resolve(source), options];
+  }
+  return require.resolve(source);
+}
+
+export default function preset(
+  context: LoadContext,
+  opts: Options = {},
+): Preset {
+  const {siteConfig} = context;
+  const {themeConfig} = siteConfig;
+  const {algolia} = themeConfig as Partial<ThemeConfig>;
+  const isProd = process.env.NODE_ENV === 'production';
+  const {
+    debug,
+    docs,
+    blog,
+    pages,
+    sitemap,
+    theme,
+    googleAnalytics,
+    gtag,
+    ...rest
+  } = opts;
+
+  const themes: PluginConfig[] = [];
+  themes.push(makePluginConfig('@docusaurus/theme-classic', theme));
+  if (algolia) {
+    themes.push(require.resolve('@docusaurus/theme-search-algolia'));
+  }
+
+  const plugins: PluginConfig[] = [];
+  if (docs !== false) {
+    plugins.push(makePluginConfig('@docusaurus/plugin-content-docs', docs));
+  }
+  if (blog !== false) {
+    plugins.push(makePluginConfig('@docusaurus/plugin-content-blog', blog));
+  }
+  if (pages !== false) {
+    plugins.push(makePluginConfig('@docusaurus/plugin-content-pages', pages));
+  }
+  if (isProd && googleAnalytics) {
+    plugins.push(
+      makePluginConfig('@docusaurus/plugin-google-analytics', googleAnalytics),
+    );
+  }
+  if (debug || (debug === undefined && !isProd)) {
+    plugins.push(require.resolve('@docusaurus/plugin-debug'));
+  }
+  if (isProd && gtag) {
+    plugins.push(makePluginConfig('@docusaurus/plugin-google-gtag', gtag));
+  }
+  if (isProd && sitemap !== false) {
+    plugins.push(makePluginConfig('@docusaurus/plugin-sitemap', sitemap));
+  }
+  if (Object.keys(rest).length > 0) {
+    throw new Error(
+      `Unrecognized keys ${Object.keys(rest).join(
+        ', ',
+      )} found in preset-classic configuration. The allowed keys are debug, docs, blog, pages, sitemap, theme, googleAnalytics, gtag. Check the documentation: https://docusaurus.io/docs/presets#docusauruspreset-classic for more information on how to configure individual plugins.`,
+    );
+  }
+
+  return {themes, plugins};
+}

package/src/preset-classic.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 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.
+ */
+
+export type Options = {
+  debug?: boolean;
+  docs?: false | import('@docusaurus/plugin-content-docs').Options;
+  blog?: false | import('@docusaurus/plugin-content-blog').Options;
+  pages?: false | import('@docusaurus/plugin-content-pages').Options;
+  sitemap?: false | import('@docusaurus/plugin-sitemap').Options;
+  theme?: import('@docusaurus/theme-classic').Options;
+  googleAnalytics?: import('@docusaurus/plugin-google-analytics').Options;
+  gtag?: import('@docusaurus/plugin-google-gtag').Options;
+};
+
+export type ThemeConfig = import('@docusaurus/types').ThemeConfig &
+  import('@docusaurus/theme-common').UserThemeConfig & {
+    algolia?: unknown; // TODO type plugin
+  };

package/src/index.js

@@ -1,48 +0,0 @@
-/**
- * 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.
- */
-
-module.exports = function preset(context, opts = {}) {
-  const {siteConfig = {}} = context;
-  const {themeConfig} = siteConfig;
-  const {algolia, googleAnalytics, gtag} = themeConfig;
-  const isProd = process.env.NODE_ENV === 'production';
-
-  const debug =
-    typeof opts.debug !== 'undefined' ? Boolean(opts.debug) : !isProd;
-
-  return {
-    themes: [
-      [require.resolve('@docusaurus/theme-classic'), opts.theme],
-      // Don't add this if algolia config is not defined.
-      algolia && require.resolve('@docusaurus/theme-search-algolia'),
-    ],
-    plugins: [
-      opts.docs !== false && [
-        require.resolve('@docusaurus/plugin-content-docs'),
-        opts.docs,
-      ],
-      opts.blog !== false && [
-        require.resolve('@docusaurus/plugin-content-blog'),
-        opts.blog,
-      ],
-      opts.pages !== false && [
-        require.resolve('@docusaurus/plugin-content-pages'),
-        opts.pages,
-      ],
-      isProd &&
-        googleAnalytics &&
-        require.resolve('@docusaurus/plugin-google-analytics'),
-      debug && require.resolve('@docusaurus/plugin-debug'),
-      isProd && gtag && require.resolve('@docusaurus/plugin-google-gtag'),
-      isProd &&
-        opts.sitemap !== false && [
-          require.resolve('@docusaurus/plugin-sitemap'),
-          opts.sitemap,
-        ],
-    ],
-  };
-};