@docusaurus/theme-classic 0.0.0-5192 → 0.0.0-5197

package/lib/index.d.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { LoadContext, Plugin } from '@docusaurus/types';
-import type { Options } from '@docusaurus/theme-classic';
+import type { PluginOptions } from '@docusaurus/theme-classic';
 export declare const AnnouncementBarDismissStorageKey = "docusaurus.announcement.dismiss";
-export default function themeClassic(context: LoadContext, options: Options): Plugin<undefined>;
+export default function themeClassic(context: LoadContext, options: PluginOptions): Plugin<undefined>;
 export { default as getSwizzleConfig } from './getSwizzleConfig';
-export { validateThemeConfig } from './validateThemeConfig';
+export { validateThemeConfig, validateOptions } from './options';

package/lib/index.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateThemeConfig = exports.getSwizzleConfig = exports.AnnouncementBarDismissStorageKey = void 0;
+exports.validateOptions = exports.validateThemeConfig = exports.getSwizzleConfig = exports.AnnouncementBarDismissStorageKey = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const module_1 = require("module");
@@ -82,7 +82,7 @@ function themeClassic(context, options) {
     const { i18n: { currentLocale, localeConfigs }, } = context;
     const themeConfig = context.siteConfig.themeConfig;
     const { announcementBar, colorMode, prism: { additionalLanguages }, } = themeConfig;
-    const { customCss } = options ?? {};
+    const { customCss } = options;
     const { direction } = localeConfigs[currentLocale];
     return {
         name: 'docusaurus-theme-classic',
@@ -109,9 +109,7 @@ function themeClassic(context, options) {
                 './prism-include-languages',
                 './nprogress',
             ];
-            if (customCss) {
-                modules.push(...(Array.isArray(customCss) ? customCss : [customCss]).map((p) => path_1.default.resolve(context.siteDir, p)));
-            }
+            modules.push(...customCss.map((p) => path_1.default.resolve(context.siteDir, p)));
             return modules;
         },
         configureWebpack() {
@@ -163,5 +161,6 @@ ${announcementBar ? AnnouncementBarInlineJavaScript : ''}
 exports.default = themeClassic;
 var getSwizzleConfig_1 = require("./getSwizzleConfig");
 Object.defineProperty(exports, "getSwizzleConfig", { enumerable: true, get: function () { return tslib_1.__importDefault(getSwizzleConfig_1).default; } });
-var validateThemeConfig_1 = require("./validateThemeConfig");
-Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return validateThemeConfig_1.validateThemeConfig; } });
+var options_1 = require("./options");
+Object.defineProperty(exports, "validateThemeConfig", { enumerable: true, get: function () { return options_1.validateThemeConfig; } });
+Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/{validateThemeConfig.d.ts → options.d.ts}

@@ -5,8 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
+import type { Options, PluginOptions } from '@docusaurus/theme-classic';
 import type { ThemeConfig } from '@docusaurus/theme-common';
-import type { ThemeConfigValidationContext } from '@docusaurus/types';
+import type { ThemeConfigValidationContext, OptionValidationContext } from '@docusaurus/types';
 export declare const DEFAULT_CONFIG: ThemeConfig;
 export declare const ThemeConfigSchema: Joi.ObjectSchema<ThemeConfig>;
 export declare function validateThemeConfig({ validate, themeConfig, }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;

package/lib/{validateThemeConfig.js → options.js}

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateThemeConfig = exports.ThemeConfigSchema = exports.DEFAULT_CONFIG = void 0;
+exports.validateOptions = exports.validateThemeConfig = exports.ThemeConfigSchema = exports.DEFAULT_CONFIG = void 0;
 const tslib_1 = require("tslib");
 const palenight_1 = tslib_1.__importDefault(require("prism-react-renderer/themes/palenight"));
 const utils_validation_1 = require("@docusaurus/utils-validation");
@@ -265,9 +265,6 @@ const FooterLinkItemSchema = utils_validation_1.Joi.object({
     // We allow any unknown attributes on the links (users may need additional
     // attributes like target, aria-role, data-customAttribute...)
     .unknown();
-const CustomCssSchema = utils_validation_1.Joi.alternatives()
-    .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required()), utils_validation_1.Joi.string().required())
-    .optional();
 const LogoSchema = utils_validation_1.Joi.object({
     alt: utils_validation_1.Joi.string().allow(''),
     src: utils_validation_1.Joi.string().required(),
@@ -289,7 +286,6 @@ exports.ThemeConfigSchema = utils_validation_1.Joi.object({
     defaultDarkMode: utils_validation_1.Joi.any().forbidden().messages({
         'any.unknown': 'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
     }),
-    customCss: CustomCssSchema,
     colorMode: ColorModeSchema,
     image: utils_validation_1.Joi.string(),
     docs: DocsSchema,
@@ -393,3 +389,21 @@ function validateThemeConfig({ validate, themeConfig, }) {
     return validate(exports.ThemeConfigSchema, themeConfig);
 }
 exports.validateThemeConfig = validateThemeConfig;
+const DEFAULT_OPTIONS = {
+    customCss: [],
+};
+const PluginOptionSchema = utils_validation_1.Joi.object({
+    customCss: utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required()), utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().required(), {
+        then: utils_validation_1.Joi.custom((val) => [val]),
+        otherwise: utils_validation_1.Joi.forbidden().messages({
+            'any.unknown': '"customCss" must be a string or an array of strings',
+        }),
+    }))
+        .default(DEFAULT_OPTIONS.customCss),
+});
+function validateOptions({ validate, options, }) {
+    const validatedOptions = validate(PluginOptionSchema, options);
+    return validatedOptions;
+}
+exports.validateOptions = validateOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "0.0.0-5192",
+  "version": "0.0.0-5197",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -20,18 +20,18 @@
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5192",
-    "@docusaurus/mdx-loader": "0.0.0-5192",
-    "@docusaurus/module-type-aliases": "0.0.0-5192",
-    "@docusaurus/plugin-content-blog": "0.0.0-5192",
-    "@docusaurus/plugin-content-docs": "0.0.0-5192",
-    "@docusaurus/plugin-content-pages": "0.0.0-5192",
-    "@docusaurus/theme-common": "0.0.0-5192",
-    "@docusaurus/theme-translations": "0.0.0-5192",
-    "@docusaurus/types": "0.0.0-5192",
-    "@docusaurus/utils": "0.0.0-5192",
-    "@docusaurus/utils-common": "0.0.0-5192",
-    "@docusaurus/utils-validation": "0.0.0-5192",
+    "@docusaurus/core": "0.0.0-5197",
+    "@docusaurus/mdx-loader": "0.0.0-5197",
+    "@docusaurus/module-type-aliases": "0.0.0-5197",
+    "@docusaurus/plugin-content-blog": "0.0.0-5197",
+    "@docusaurus/plugin-content-docs": "0.0.0-5197",
+    "@docusaurus/plugin-content-pages": "0.0.0-5197",
+    "@docusaurus/theme-common": "0.0.0-5197",
+    "@docusaurus/theme-translations": "0.0.0-5197",
+    "@docusaurus/types": "0.0.0-5197",
+    "@docusaurus/utils": "0.0.0-5197",
+    "@docusaurus/utils-common": "0.0.0-5197",
+    "@docusaurus/utils-validation": "0.0.0-5197",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.2.1",
     "copy-text-to-clipboard": "^3.0.1",
@@ -64,5 +64,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "927fb5af9e9bbf6e86673c499c7d3cff4134490e"
+  "gitHead": "03070cb8cdcb45a00d370920b202a99e4d5ab734"
 }

package/src/index.ts

@@ -13,7 +13,7 @@ import {getTranslationFiles, translateThemeConfig} from './translations';
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {ThemeConfig} from '@docusaurus/theme-common';
 import type {Plugin as PostCssPlugin} from 'postcss';
-import type {Options} from '@docusaurus/theme-classic';
+import type {PluginOptions} from '@docusaurus/theme-classic';
 import type webpack from 'webpack';
 
 const requireFromDocusaurusCore = createRequire(
@@ -98,7 +98,7 @@ function getInfimaCSSFile(direction: string) {
 
 export default function themeClassic(
   context: LoadContext,
-  options: Options,
+  options: PluginOptions,
 ): Plugin<undefined> {
   const {
     i18n: {currentLocale, localeConfigs},
@@ -109,7 +109,7 @@ export default function themeClassic(
     colorMode,
     prism: {additionalLanguages},
   } = themeConfig;
-  const {customCss} = options ?? {};
+  const {customCss} = options;
   const {direction} = localeConfigs[currentLocale]!;
 
   return {
@@ -145,13 +145,7 @@ export default function themeClassic(
         './nprogress',
       ];
 
-      if (customCss) {
-        modules.push(
-          ...(Array.isArray(customCss) ? customCss : [customCss]).map((p) =>
-            path.resolve(context.siteDir, p),
-          ),
-        );
-      }
+      modules.push(...customCss.map((p) => path.resolve(context.siteDir, p)));
 
       return modules;
     },
@@ -211,4 +205,4 @@ ${announcementBar ? AnnouncementBarInlineJavaScript : ''}
 }
 
 export {default as getSwizzleConfig} from './getSwizzleConfig';
-export {validateThemeConfig} from './validateThemeConfig';
+export {validateThemeConfig, validateOptions} from './options';

package/src/{validateThemeConfig.ts → options.ts}

@@ -7,8 +7,12 @@
 
 import defaultPrismTheme from 'prism-react-renderer/themes/palenight';
 import {Joi, URISchema} from '@docusaurus/utils-validation';
+import type {Options, PluginOptions} from '@docusaurus/theme-classic';
 import type {ThemeConfig} from '@docusaurus/theme-common';
-import type {ThemeConfigValidationContext} from '@docusaurus/types';
+import type {
+  ThemeConfigValidationContext,
+  OptionValidationContext,
+} from '@docusaurus/types';
 
 const DEFAULT_DOCS_CONFIG: ThemeConfig['docs'] = {
   versionPersistence: 'localStorage',
@@ -296,10 +300,6 @@ const FooterLinkItemSchema = Joi.object({
   // attributes like target, aria-role, data-customAttribute...)
   .unknown();
 
-const CustomCssSchema = Joi.alternatives()
-  .try(Joi.array().items(Joi.string().required()), Joi.string().required())
-  .optional();
-
 const LogoSchema = Joi.object({
   alt: Joi.string().allow(''),
   src: Joi.string().required(),
@@ -324,7 +324,6 @@ export const ThemeConfigSchema = Joi.object<ThemeConfig>({
     'any.unknown':
       'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
   }),
-  customCss: CustomCssSchema,
   colorMode: ColorModeSchema,
   image: Joi.string(),
   docs: DocsSchema,
@@ -442,3 +441,29 @@ export function validateThemeConfig({
 }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig {
   return validate(ThemeConfigSchema, themeConfig);
 }
+
+const DEFAULT_OPTIONS = {
+  customCss: [],
+};
+
+const PluginOptionSchema = Joi.object<PluginOptions>({
+  customCss: Joi.alternatives()
+    .try(
+      Joi.array().items(Joi.string().required()),
+      Joi.alternatives().conditional(Joi.string().required(), {
+        then: Joi.custom((val: string) => [val]),
+        otherwise: Joi.forbidden().messages({
+          'any.unknown': '"customCss" must be a string or an array of strings',
+        }),
+      }),
+    )
+    .default(DEFAULT_OPTIONS.customCss),
+});
+
+export function validateOptions({
+  validate,
+  options,
+}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
+  const validatedOptions = validate(PluginOptionSchema, options);
+  return validatedOptions;
+}

package/src/theme-classic.d.ts

@@ -23,8 +23,12 @@
 declare module '@docusaurus/theme-classic' {
   import type {LoadContext, Plugin, PluginModule} from '@docusaurus/types';
 
+  export type PluginOptions = {
+    customCss: string[];
+  };
+
   export type Options = {
-    customCss?: string | string[];
+    customCss?: string[] | string;
   };
 
   export const getSwizzleConfig: PluginModule['getSwizzleConfig'];