@docusaurus/theme-classic 2.0.0-beta.ff31de0ff → 2.0.1

package/lib-next/validateThemeConfig.js

@@ -1,317 +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.
- */
-
-const {Joi, URISchema} = require('@docusaurus/utils-validation');
-
-const DEFAULT_DOCS_CONFIG = {
-  versionPersistence: 'localStorage',
-};
-const DocsSchema = Joi.object({
-  versionPersistence: Joi.string()
-    .equal('localStorage', 'none')
-    .default(DEFAULT_DOCS_CONFIG.versionPersistence),
-}).default(DEFAULT_DOCS_CONFIG);
-
-const DEFAULT_COLOR_MODE_CONFIG = {
-  defaultMode: 'light',
-  disableSwitch: false,
-  respectPrefersColorScheme: false,
-  switchConfig: {
-    darkIcon: '🌜',
-    darkIconStyle: {},
-    lightIcon: '🌞',
-    lightIconStyle: {},
-  },
-};
-
-const DEFAULT_CONFIG = {
-  colorMode: DEFAULT_COLOR_MODE_CONFIG,
-  docs: DEFAULT_DOCS_CONFIG,
-  metadatas: [],
-  prism: {
-    additionalLanguages: [],
-  },
-  navbar: {
-    hideOnScroll: false,
-    items: [],
-  },
-  hideableSidebar: false,
-};
-exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
-
-const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
-
-const BaseNavbarItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
-  label: Joi.string(),
-  className: Joi.string(),
-  prependBaseUrlToHref: Joi.string(),
-})
-  // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-
-// TODO we should probably create a custom navbar item type "dropdown"
-// having this recursive structure is bad because we only support 2 levels
-// + parent/child don't have exactly the same props
-const DefaultNavbarItemSchema = BaseNavbarItemSchema.append({
-  items: Joi.array().optional().items(BaseNavbarItemSchema),
-  position: NavbarItemPosition,
-  activeBasePath: Joi.string(),
-  activeBaseRegex: Joi.string(),
-});
-// TODO the dropdown parent item can have no href/to
-// should check should not apply to dropdown parent item
-// .xor('href', 'to');
-
-const DocsVersionNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('docsVersion').required(),
-  position: NavbarItemPosition,
-  label: Joi.string(),
-  to: Joi.string(),
-  docsPluginId: Joi.string(),
-  className: Joi.string(),
-});
-
-const DocsVersionDropdownNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('docsVersionDropdown').required(),
-  position: NavbarItemPosition,
-  docsPluginId: Joi.string(),
-  dropdownActiveClassDisabled: Joi.boolean(),
-  dropdownItemsBefore: Joi.array().items(BaseNavbarItemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(BaseNavbarItemSchema).default([]),
-  className: Joi.string(),
-});
-
-const DocItemSchema = Joi.object({
-  type: Joi.string().equal('doc').required(),
-  position: NavbarItemPosition,
-  docId: Joi.string().required(),
-  label: Joi.string(),
-  docsPluginId: Joi.string(),
-  activeSidebarClassName: Joi.string().default('navbar__link--active'),
-  className: Joi.string(),
-});
-
-const LocaleDropdownNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('localeDropdown').required(),
-  position: NavbarItemPosition,
-  dropdownItemsBefore: Joi.array().items(BaseNavbarItemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(BaseNavbarItemSchema).default([]),
-  className: Joi.string(),
-});
-
-const SearchItemSchema = Joi.object({
-  type: Joi.string().equal('search').required(),
-  position: NavbarItemPosition,
-});
-
-// Can this be made easier? :/
-const isOfType = (type) => {
-  let typeSchema = Joi.string().required();
-  // because equal(undefined) is not supported :/
-  if (type) {
-    typeSchema = typeSchema.equal(type);
-  }
-  return Joi.object({
-    type: typeSchema,
-  })
-    .unknown()
-    .required();
-};
-
-const NavbarItemSchema = Joi.object().when({
-  switch: [
-    {
-      is: isOfType('docsVersion'),
-      then: DocsVersionNavbarItemSchema,
-    },
-    {
-      is: isOfType('docsVersionDropdown'),
-      then: DocsVersionDropdownNavbarItemSchema,
-    },
-    {
-      is: isOfType('doc'),
-      then: DocItemSchema,
-    },
-    {
-      is: isOfType('localeDropdown'),
-      then: LocaleDropdownNavbarItemSchema,
-    },
-    {
-      is: isOfType('search'),
-      then: SearchItemSchema,
-    },
-    {
-      is: isOfType(undefined),
-      then: Joi.forbidden().messages({
-        'any.unknown': 'Bad navbar item type {.type}',
-      }),
-    },
-  ],
-  otherwise: DefaultNavbarItemSchema,
-});
-
-/*
-const NavbarItemSchema = Joi.object({
-  type: Joi.string().only(['docsVersion'])
-})
-  .when(Joi.object({ type: 'docsVersion' }).unknown(), {
-    then: Joi.object({ pepperoni: Joi.boolean() })
-  })
-  .when(Joi.object().unknown(), {
-    then: Joi.object({ croutons: Joi.boolean() })
-  })
-
- */
-
-/*
-const NavbarItemSchema = Joi.object().when('type', {
-  is: Joi.valid('docsVersion'),
-  then: DocsVersionNavbarItemSchema,
-  otherwise: DefaultNavbarItemSchema,
-});
- */
-
-const ColorModeSchema = Joi.object({
-  defaultMode: Joi.string()
-    .equal('dark', 'light')
-    .default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
-  disableSwitch: Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
-  respectPrefersColorScheme: Joi.bool().default(
-    DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme,
-  ),
-  switchConfig: Joi.object({
-    darkIcon: Joi.string().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIcon,
-    ),
-    darkIconStyle: Joi.object().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIconStyle,
-    ),
-    lightIcon: Joi.string().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIcon,
-    ),
-    lightIconStyle: Joi.object().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIconStyle,
-    ),
-  }).default(DEFAULT_COLOR_MODE_CONFIG.switchConfig),
-}).default(DEFAULT_COLOR_MODE_CONFIG);
-
-// schema can probably be improved
-const HtmlMetadataSchema = Joi.object({
-  id: Joi.string(),
-  name: Joi.string(),
-  property: Joi.string(),
-  content: Joi.string(),
-  itemprop: Joi.string(),
-}).unknown();
-
-const FooterLinkItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
-  html: Joi.string(),
-  label: Joi.string(),
-})
-  .xor('to', 'href', 'html')
-  .with('to', 'label')
-  .with('href', 'label')
-  .nand('html', 'label')
-  // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-
-const CustomCssSchema = Joi.alternatives()
-  .try(Joi.array().items(Joi.string().required()), Joi.string().required())
-  .optional();
-
-const ThemeConfigSchema = Joi.object({
-  // TODO temporary (@alpha-58)
-  disableDarkMode: Joi.any().forbidden(false).messages({
-    'any.unknown':
-      'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
-  }),
-  // TODO temporary (@alpha-58)
-  defaultDarkMode: Joi.any().forbidden(false).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: Joi.string(),
-  docs: DocsSchema,
-  metadatas: Joi.array()
-    .items(HtmlMetadataSchema)
-    .default(DEFAULT_CONFIG.metadatas),
-  announcementBar: Joi.object({
-    id: Joi.string().default('announcement-bar'),
-    content: Joi.string(),
-    backgroundColor: Joi.string().default('#fff'),
-    textColor: Joi.string().default('#000'),
-    isCloseable: Joi.bool().default(true),
-  }).optional(),
-  navbar: Joi.object({
-    style: Joi.string().equal('dark', 'primary'),
-    hideOnScroll: Joi.bool().default(DEFAULT_CONFIG.navbar.hideOnScroll),
-    // TODO temporary (@alpha-58)
-    links: Joi.any().forbidden().messages({
-      'any.unknown':
-        'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
-    }),
-    items: Joi.array()
-      .items(NavbarItemSchema)
-      .default(DEFAULT_CONFIG.navbar.items),
-    title: Joi.string().allow('', null),
-    logo: Joi.object({
-      alt: Joi.string().allow(''),
-      src: Joi.string().required(),
-      srcDark: Joi.string(),
-      href: Joi.string(),
-      target: Joi.string(),
-    }),
-  }).default(DEFAULT_CONFIG.navbar),
-  footer: Joi.object({
-    style: Joi.string().equal('dark', 'light').default('light'),
-    logo: Joi.object({
-      alt: Joi.string().allow(''),
-      src: Joi.string(),
-      srcDark: Joi.string(),
-      href: Joi.string(),
-    }),
-    copyright: Joi.string(),
-    links: Joi.array()
-      .items(
-        Joi.object({
-          title: Joi.string().allow(null),
-          items: Joi.array().items(FooterLinkItemSchema).default([]),
-        }),
-      )
-      .default([]),
-  }).optional(),
-  prism: Joi.object({
-    theme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-    }),
-    darkTheme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-    }),
-    defaultLanguage: Joi.string(),
-    additionalLanguages: Joi.array()
-      .items(Joi.string())
-      .default(DEFAULT_CONFIG.prism.additionalLanguages),
-  })
-    .default(DEFAULT_CONFIG.prism)
-    .unknown(),
-  hideableSidebar: Joi.bool().default(DEFAULT_CONFIG.hideableSidebar),
-});
-exports.ThemeConfigSchema = ThemeConfigSchema;
-
-exports.validateThemeConfig = ({validate, themeConfig}) => {
-  return validate(ThemeConfigSchema, themeConfig);
-};

package/src/__tests__/__snapshots__/translations.test.ts.snap

@@ -1,116 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`getTranslationFiles should return translation files matching snapshot 1`] = `
-Array [
-  Object {
-    "content": Object {
-      "item.label.Dropdown": Object {
-        "description": "Navbar item with label Dropdown",
-        "message": "Dropdown",
-      },
-      "item.label.Dropdown item 1": Object {
-        "description": "Navbar item with label Dropdown item 1",
-        "message": "Dropdown item 1",
-      },
-      "item.label.Dropdown item 2": Object {
-        "description": "Navbar item with label Dropdown item 2",
-        "message": "Dropdown item 2",
-      },
-      "title": Object {
-        "description": "The title in the navbar",
-        "message": "navbar title",
-      },
-    },
-    "path": "navbar",
-  },
-  Object {
-    "content": Object {
-      "copyright": Object {
-        "description": "The footer copyright",
-        "message": "Copyright FB",
-      },
-      "link.item.label.Link 1": Object {
-        "description": "The label of footer link with label=Link 1 linking to https://facebook.com",
-        "message": "Link 1",
-      },
-      "link.item.label.Link 2": Object {
-        "description": "The label of footer link with label=Link 2 linking to https://facebook.com",
-        "message": "Link 2",
-      },
-      "link.item.label.Link 3": Object {
-        "description": "The label of footer link with label=Link 3 linking to https://facebook.com",
-        "message": "Link 3",
-      },
-      "link.title.Footer link column 1": Object {
-        "description": "The title of the footer links column with title=Footer link column 1 in the footer",
-        "message": "Footer link column 1",
-      },
-      "link.title.Footer link column 2": Object {
-        "description": "The title of the footer links column with title=Footer link column 2 in the footer",
-        "message": "Footer link column 2",
-      },
-    },
-    "path": "footer",
-  },
-]
-`;
-
-exports[`translateThemeConfig should return translated themeConfig matching snapshot 1`] = `
-Object {
-  "announcementBar": Object {},
-  "colorMode": Object {},
-  "docs": Object {
-    "versionPersistence": "none",
-  },
-  "footer": Object {
-    "copyright": "Copyright FB (translated)",
-    "links": Array [
-      Object {
-        "items": Array [
-          Object {
-            "label": "Link 1 (translated)",
-            "to": "https://facebook.com",
-          },
-          Object {
-            "label": "Link 2 (translated)",
-            "to": "https://facebook.com",
-          },
-        ],
-        "title": "Footer link column 1 (translated)",
-      },
-      Object {
-        "items": Array [
-          Object {
-            "label": "Link 3 (translated)",
-            "to": "https://facebook.com",
-          },
-        ],
-        "title": "Footer link column 2 (translated)",
-      },
-    ],
-    "style": "light",
-  },
-  "hideableSidebar": true,
-  "navbar": Object {
-    "hideOnScroll": false,
-    "items": Array [
-      Object {
-        "items": Array [
-          Object {
-            "items": Array [],
-            "label": "Dropdown item 1 (translated)",
-          },
-          Object {
-            "items": Array [],
-            "label": "Dropdown item 2 (translated)",
-          },
-        ],
-        "label": "Dropdown (translated)",
-      },
-    ],
-    "style": "dark",
-    "title": "navbar title (translated)",
-  },
-  "prism": Object {},
-}
-`;

package/src/__tests__/translations.test.ts

@@ -1,116 +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.
- */
-
-import {getTranslationFiles, translateThemeConfig} from '../translations';
-import {ThemeConfig} from '@docusaurus/theme-common';
-import {updateTranslationFileMessages} from '@docusaurus/utils';
-
-const ThemeConfigSample: ThemeConfig = {
-  colorMode: {},
-  announcementBar: {},
-  prism: {},
-  docs: {
-    versionPersistence: 'none',
-  },
-  hideableSidebar: true,
-  navbar: {
-    title: 'navbar title',
-    style: 'dark',
-    hideOnScroll: false,
-    items: [
-      {
-        label: 'Dropdown',
-        items: [
-          {label: 'Dropdown item 1', items: []},
-          {label: 'Dropdown item 2', items: []},
-        ],
-      },
-    ],
-  },
-  footer: {
-    copyright: 'Copyright FB',
-    style: 'light',
-    links: [
-      {
-        title: 'Footer link column 1',
-        items: [
-          {label: 'Link 1', to: 'https://facebook.com'},
-          {label: 'Link 2', to: 'https://facebook.com'},
-        ],
-      },
-      {
-        title: 'Footer link column 2',
-        items: [{label: 'Link 3', to: 'https://facebook.com'}],
-      },
-    ],
-  },
-};
-
-function getSampleTranslationFiles() {
-  return getTranslationFiles({
-    themeConfig: ThemeConfigSample,
-  });
-}
-
-function getSampleTranslationFilesTranslated() {
-  const translationFiles = getSampleTranslationFiles();
-  return translationFiles.map((translationFile) =>
-    updateTranslationFileMessages(
-      translationFile,
-      (message) => `${message} (translated)`,
-    ),
-  );
-}
-
-describe('getTranslationFiles', () => {
-  test('should return translation files matching snapshot', () => {
-    expect(getSampleTranslationFiles()).toMatchSnapshot();
-  });
-});
-
-describe('translateThemeConfig', () => {
-  test('should not translate anything if translation files are untranslated', () => {
-    const translationFiles = getSampleTranslationFiles();
-    expect(
-      translateThemeConfig({
-        themeConfig: ThemeConfigSample,
-        translationFiles,
-      }),
-    ).toEqual(ThemeConfigSample);
-  });
-
-  test('should return translated themeConfig matching snapshot', () => {
-    const translationFiles = getSampleTranslationFilesTranslated();
-    expect(
-      translateThemeConfig({
-        themeConfig: ThemeConfigSample,
-        translationFiles,
-      }),
-    ).toMatchSnapshot();
-  });
-});
-
-describe('getTranslationFiles and translateThemeConfig isomorphism', () => {
-  function verifyIsomorphism(themeConfig: ThemeConfig) {
-    const translationFiles = getTranslationFiles({themeConfig});
-    const translatedThemeConfig = translateThemeConfig({
-      themeConfig,
-      translationFiles,
-    });
-    expect(translatedThemeConfig).toEqual(themeConfig);
-  }
-
-  test('should be verified for main sample', () => {
-    verifyIsomorphism(ThemeConfigSample);
-  });
-
-  // undefined footer should not make the translation code crash
-  // See https://github.com/facebook/docusaurus/issues/3936
-  test('should be verified for sample without footer', () => {
-    verifyIsomorphism({...ThemeConfigSample, footer: undefined});
-  });
-});