@docusaurus/preset-classic 2.0.0-beta.1decd6f80 → 2.0.0-beta.20

package/README.md

@@ -4,4 +4,4 @@ Classic preset for Docusaurus.
 
 ## Usage
 
-See [presets documentation](https://docusaurus.io/docs/presets).
+See [presets documentation](https://docusaurus.io/docs/using-plugins#using-presets).

package/lib/index.d.ts

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

package/lib/index.js

@@ -0,0 +1,59 @@
+"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'));
+    }
+    if ('gtag' in themeConfig) {
+        throw new Error('The "gtag" field in themeConfig should now be specified as option for plugin-google-gtag. For preset-classic, simply move themeConfig.gtag to preset options. More information at https://github.com/facebook/docusaurus/pull/5832.');
+    }
+    if ('googleAnalytics' in themeConfig) {
+        throw new Error('The "googleAnalytics" field in themeConfig should now be specified as option for plugin-google-analytics. For preset-classic, simply move themeConfig.googleAnalytics to preset options. More information at https://github.com/facebook/docusaurus/pull/5832.');
+    }
+    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 (googleAnalytics) {
+        plugins.push(makePluginConfig('@docusaurus/plugin-google-analytics', googleAnalytics));
+    }
+    if (debug || (debug === undefined && !isProd)) {
+        plugins.push(require.resolve('@docusaurus/plugin-debug'));
+    }
+    if (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/lib/options.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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 { Options as DocsPluginOptions } from '@docusaurus/plugin-content-docs';
+import type { Options as BlogPluginOptions } from '@docusaurus/plugin-content-blog';
+import type { Options as PagesPluginOptions } from '@docusaurus/plugin-content-pages';
+import type { Options as SitemapPluginOptions } from '@docusaurus/plugin-sitemap';
+import type { Options as GAPluginOptions } from '@docusaurus/plugin-google-analytics';
+import type { Options as GtagPluginOptions } from '@docusaurus/plugin-google-gtag';
+import type { Options as ThemeOptions } from '@docusaurus/theme-classic';
+import type { ThemeConfig as BaseThemeConfig } from '@docusaurus/types';
+import type { UserThemeConfig as ClassicThemeConfig } from '@docusaurus/theme-common';
+import type { UserThemeConfig as AlgoliaThemeConfig } from '@docusaurus/theme-search-algolia';
+export declare type Options = {
+    /**
+     * Options for `@docusaurus/plugin-debug`. Use `false` to disable, or `true`
+     * to enable even in production.
+     */
+    debug?: boolean;
+    /** Options for `@docusaurus/plugin-content-docs`. Use `false` to disable. */
+    docs?: false | DocsPluginOptions;
+    /** Options for `@docusaurus/plugin-content-blog`. Use `false` to disable. */
+    blog?: false | BlogPluginOptions;
+    /** Options for `@docusaurus/plugin-content-pages`. Use `false` to disable. */
+    pages?: false | PagesPluginOptions;
+    /** Options for `@docusaurus/plugin-sitemap`. Use `false` to disable. */
+    sitemap?: false | SitemapPluginOptions;
+    /** Options for `@docusaurus/theme-classic`. */
+    theme?: ThemeOptions;
+    /**
+     * Options for `@docusaurus/plugin-google-analytics`. Only enabled when the
+     * key is present.
+     */
+    googleAnalytics?: GAPluginOptions;
+    /**
+     * Options for `@docusaurus/plugin-google-gtag`. Only enabled when the key
+     * is present.
+     */
+    gtag?: GtagPluginOptions;
+};
+export declare type ThemeConfig = BaseThemeConfig & ClassicThemeConfig & AlgoliaThemeConfig;

package/lib/options.js

@@ -0,0 +1,8 @@
+"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 });

package/package.json

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

package/src/index.ts

@@ -0,0 +1,97 @@
+/**
+ * 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 './options';
+
+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'));
+  }
+  if ('gtag' in themeConfig) {
+    throw new Error(
+      'The "gtag" field in themeConfig should now be specified as option for plugin-google-gtag. For preset-classic, simply move themeConfig.gtag to preset options. More information at https://github.com/facebook/docusaurus/pull/5832.',
+    );
+  }
+  if ('googleAnalytics' in themeConfig) {
+    throw new Error(
+      'The "googleAnalytics" field in themeConfig should now be specified as option for plugin-google-analytics. For preset-classic, simply move themeConfig.googleAnalytics to preset options. More information at https://github.com/facebook/docusaurus/pull/5832.',
+    );
+  }
+
+  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 (googleAnalytics) {
+    plugins.push(
+      makePluginConfig('@docusaurus/plugin-google-analytics', googleAnalytics),
+    );
+  }
+  if (debug || (debug === undefined && !isProd)) {
+    plugins.push(require.resolve('@docusaurus/plugin-debug'));
+  }
+  if (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};
+}
+
+export type {Options, ThemeConfig};

package/src/options.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 {Options as DocsPluginOptions} from '@docusaurus/plugin-content-docs';
+import type {Options as BlogPluginOptions} from '@docusaurus/plugin-content-blog';
+import type {Options as PagesPluginOptions} from '@docusaurus/plugin-content-pages';
+import type {Options as SitemapPluginOptions} from '@docusaurus/plugin-sitemap';
+import type {Options as GAPluginOptions} from '@docusaurus/plugin-google-analytics';
+import type {Options as GtagPluginOptions} from '@docusaurus/plugin-google-gtag';
+import type {Options as ThemeOptions} from '@docusaurus/theme-classic';
+import type {ThemeConfig as BaseThemeConfig} from '@docusaurus/types';
+import type {UserThemeConfig as ClassicThemeConfig} from '@docusaurus/theme-common';
+import type {UserThemeConfig as AlgoliaThemeConfig} from '@docusaurus/theme-search-algolia';
+
+export type Options = {
+  /**
+   * Options for `@docusaurus/plugin-debug`. Use `false` to disable, or `true`
+   * to enable even in production.
+   */
+  debug?: boolean;
+  /** Options for `@docusaurus/plugin-content-docs`. Use `false` to disable. */
+  docs?: false | DocsPluginOptions;
+  /** Options for `@docusaurus/plugin-content-blog`. Use `false` to disable. */
+  blog?: false | BlogPluginOptions;
+  /** Options for `@docusaurus/plugin-content-pages`. Use `false` to disable. */
+  pages?: false | PagesPluginOptions;
+  /** Options for `@docusaurus/plugin-sitemap`. Use `false` to disable. */
+  sitemap?: false | SitemapPluginOptions;
+  /** Options for `@docusaurus/theme-classic`. */
+  theme?: ThemeOptions;
+  /**
+   * Options for `@docusaurus/plugin-google-analytics`. Only enabled when the
+   * key is present.
+   */
+  googleAnalytics?: GAPluginOptions;
+  /**
+   * Options for `@docusaurus/plugin-google-gtag`. Only enabled when the key
+   * is present.
+   */
+  gtag?: GtagPluginOptions;
+};
+
+export type ThemeConfig = BaseThemeConfig &
+  ClassicThemeConfig &
+  AlgoliaThemeConfig;

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,
-        ],
-    ],
-  };
-};