@docusaurus/theme-classic 2.0.0-beta.fc64c12e4 → 2.0.0

package/src/validateThemeConfig.js

@@ -1,337 +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 NavbarItemBaseSchema = Joi.object({
-  label: Joi.string(),
-  className: Joi.string(),
-})
-  // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-
-const DefaultNavbarItemSchema = NavbarItemBaseSchema.append({
-  to: Joi.string(),
-  href: URISchema,
-  activeBasePath: Joi.string(),
-  activeBaseRegex: Joi.string(),
-  prependBaseUrlToHref: Joi.bool(),
-  // This is only triggered in case of a nested dropdown
-  items: Joi.forbidden().messages({
-    'any.unknown': 'Nested dropdowns are not allowed',
-  }),
-})
-  .xor('href', 'to')
-  .messages({
-    'object.xor': 'One and only one between "to" and "href" should be provided',
-  });
-
-const DocsVersionNavbarItemSchema = NavbarItemBaseSchema.append({
-  type: Joi.string().equal('docsVersion').required(),
-  to: Joi.string(),
-  docsPluginId: Joi.string(),
-});
-
-const DocItemSchema = NavbarItemBaseSchema.append({
-  type: Joi.string().equal('doc').required(),
-  docId: Joi.string().required(),
-  docsPluginId: Joi.string(),
-  activeSidebarClassName: Joi.string().default('navbar__link--active'),
-});
-
-const itemWithType = (type) => {
-  // because equal(undefined) is not supported :/
-  const typeSchema = type
-    ? Joi.string().required().equal(type)
-    : Joi.string().forbidden();
-  return Joi.object({
-    type: typeSchema,
-  })
-    .unknown()
-    .required();
-};
-
-const DropdownSubitemSchema = Joi.object({
-  position: Joi.forbidden(),
-}).when({
-  switch: [
-    {
-      is: itemWithType('docsVersion'),
-      then: DocsVersionNavbarItemSchema,
-    },
-    {
-      is: itemWithType('doc'),
-      then: DocItemSchema,
-    },
-    {
-      is: itemWithType(undefined),
-      then: DefaultNavbarItemSchema,
-    },
-    {
-      is: Joi.alternatives().try(
-        itemWithType('dropdown'),
-        itemWithType('docsVersionDropdown'),
-        itemWithType('localeDropdown'),
-        itemWithType('search'),
-      ),
-      then: Joi.forbidden().messages({
-        'any.unknown': 'Nested dropdowns are not allowed',
-      }),
-    },
-  ],
-  otherwise: Joi.forbidden().messages({
-    'any.unknown': 'Bad navbar item type {.type}',
-  }),
-});
-
-const DropdownNavbarItemSchema = NavbarItemBaseSchema.append({
-  items: Joi.array().items(DropdownSubitemSchema).required(),
-});
-
-const DocsVersionDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
-  type: Joi.string().equal('docsVersionDropdown').required(),
-  docsPluginId: Joi.string(),
-  dropdownActiveClassDisabled: Joi.boolean(),
-  dropdownItemsBefore: Joi.array().items(DropdownSubitemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(DropdownSubitemSchema).default([]),
-});
-
-const LocaleDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
-  type: Joi.string().equal('localeDropdown').required(),
-  dropdownItemsBefore: Joi.array().items(DropdownSubitemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(DropdownSubitemSchema).default([]),
-});
-
-const SearchItemSchema = Joi.object({
-  type: Joi.string().equal('search').required(),
-});
-
-const NavbarItemSchema = Joi.object({
-  position: NavbarItemPosition,
-}).when({
-  switch: [
-    {
-      is: itemWithType('docsVersion'),
-      then: DocsVersionNavbarItemSchema,
-    },
-    {
-      is: itemWithType('dropdown'),
-      then: DropdownNavbarItemSchema,
-    },
-    {
-      is: itemWithType('docsVersionDropdown'),
-      then: DocsVersionDropdownNavbarItemSchema,
-    },
-    {
-      is: itemWithType('doc'),
-      then: DocItemSchema,
-    },
-    {
-      is: itemWithType('localeDropdown'),
-      then: LocaleDropdownNavbarItemSchema,
-    },
-    {
-      is: itemWithType('search'),
-      then: SearchItemSchema,
-    },
-    {
-      is: itemWithType(undefined),
-      then: Joi.object().when({
-        // Dropdown item can be specified without type field
-        is: Joi.object({
-          items: Joi.array().required(),
-        }).unknown(),
-        then: DropdownNavbarItemSchema,
-        otherwise: DefaultNavbarItemSchema,
-      }),
-    },
-  ],
-  otherwise: Joi.forbidden().messages({
-    'any.unknown': 'Bad navbar item type {.type}',
-  }),
-});
-
-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(),
-    textColor: Joi.string(),
-    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),
-  sidebarCollapsible: Joi.forbidden().messages({
-    'any.unknown':
-      'The themeConfig.sidebarCollapsible has been moved to docs plugin options. See: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs',
-  }),
-});
-exports.ThemeConfigSchema = ThemeConfigSchema;
-
-exports.validateThemeConfig = ({validate, themeConfig}) => {
-  return validate(ThemeConfigSchema, themeConfig);
-};

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "lib": ["DOM", "ES2019"],
-    "module": "esnext",
-    "noEmit": true,
-    "noImplicitAny": false,
-    "jsx": "react",
-    "baseUrl": "src"
-  },
-  "include": ["src/"]
-}

package/update-code-translations.js

@@ -1,242 +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 chalk = require('chalk');
-const path = require('path');
-const fs = require('fs-extra');
-const globby = require('globby');
-const {mapValues, pickBy, difference, orderBy} = require('lodash');
-
-const CodeDirPaths = [
-  path.join(__dirname, 'lib-next'),
-  // TODO other themes should rather define their own translations in the future?
-  path.join(__dirname, '..', 'docusaurus-theme-search-algolia', 'src', 'theme'),
-  path.join(__dirname, '..', 'docusaurus-theme-live-codeblock', 'src', 'theme'),
-  path.join(__dirname, '..', 'docusaurus-plugin-pwa', 'src', 'theme'),
-];
-
-console.log('Will scan folders for code translations:', CodeDirPaths);
-
-function removeDescriptionSuffix(key) {
-  if (key.replace('___DESCRIPTION')) {
-    return key.replace('___DESCRIPTION', '');
-  }
-  return key;
-}
-
-function sortObjectKeys(obj) {
-  let keys = Object.keys(obj);
-  keys = orderBy(keys, [(k) => removeDescriptionSuffix(k)]);
-  return keys.reduce((acc, key) => {
-    acc[key] = obj[key];
-    return acc;
-  }, {});
-}
-
-function logSection(title) {
-  console.log(``);
-  console.log(``);
-  console.log(`##############################`);
-  console.log(`## ${chalk.blue(title)}`);
-}
-
-function logKeys(keys) {
-  return `Keys:\n- ${keys.join('\n- ')}\``;
-}
-
-async function extractThemeCodeMessages() {
-  // Unsafe import, should we create a package for the translationsExtractor ?
-  const {
-    globSourceCodeFilePaths,
-    extractAllSourceCodeFileTranslations,
-    // eslint-disable-next-line global-require
-  } = require('@docusaurus/core/lib/server/translations/translationsExtractor');
-
-  const filePaths = (
-    await globSourceCodeFilePaths(CodeDirPaths)
-  ).filter((filePath) => ['.js', '.jsx'].includes(path.extname(filePath)));
-
-  const filesExtractedTranslations = await extractAllSourceCodeFileTranslations(
-    filePaths,
-    {
-      presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-    },
-  );
-
-  filesExtractedTranslations.forEach((fileExtractedTranslations) => {
-    fileExtractedTranslations.warnings.forEach((warning) => {
-      throw new Error(`
-Please make sure all theme translations are static!
-Some warnings were found!
-
-${warning}
-      `);
-    });
-  });
-
-  const translations = filesExtractedTranslations.reduce(
-    (acc, extractedTranslations) => {
-      return {...acc, ...extractedTranslations.translations};
-    },
-    {},
-  );
-
-  return translations;
-}
-
-async function readMessagesFile(filePath) {
-  return JSON.parse(await fs.readFile(filePath));
-}
-
-async function writeMessagesFile(filePath, messages) {
-  const sortedMessages = sortObjectKeys(messages);
-
-  const content = `${JSON.stringify(sortedMessages, null, 2)}\n`; // \n makes prettier happy
-  await fs.writeFile(filePath, content);
-  console.log(
-    `${path.basename(filePath)} updated (${
-      Object.keys(sortedMessages).length
-    } messages)`,
-  );
-}
-
-async function getCodeTranslationFiles() {
-  const codeTranslationsDir = path.join(__dirname, 'codeTranslations');
-  const baseFile = path.join(codeTranslationsDir, 'base.json');
-  const localesFiles = (await globby(codeTranslationsDir)).filter(
-    (filepath) =>
-      path.extname(filepath) === '.json' && !filepath.endsWith('base.json'),
-  );
-  return {baseFile, localesFiles};
-}
-
-const DescriptionSuffix = '___DESCRIPTION';
-
-async function updateBaseFile(baseFile) {
-  const baseMessagesWithDescriptions = await readMessagesFile(baseFile);
-  const baseMessages = pickBy(
-    baseMessagesWithDescriptions,
-    (_, key) => !key.endsWith(DescriptionSuffix),
-  );
-
-  const codeExtractedTranslations = await extractThemeCodeMessages();
-  const codeMessages = mapValues(
-    codeExtractedTranslations,
-    (translation) => translation.message,
-  );
-
-  const unknownMessages = difference(
-    Object.keys(baseMessages),
-    Object.keys(codeMessages),
-  );
-
-  if (unknownMessages.length) {
-    console.log(
-      chalk.red(`Some messages exist in base.json but were not found by the code extractor!
-They won't be removed automatically, so do the cleanup manually if necessary!
-${logKeys(unknownMessages)}`),
-    );
-  }
-
-  const newBaseMessages = {
-    ...baseMessages, // Ensure we don't automatically remove unknown messages
-    ...codeMessages,
-  };
-
-  const newBaseMessagesDescriptions = Object.entries(newBaseMessages).reduce(
-    (acc, [key]) => {
-      const codeTranslation = codeExtractedTranslations[key];
-      return {
-        ...acc,
-        [`${key}${DescriptionSuffix}`]: codeTranslation
-          ? codeTranslation.description
-          : undefined,
-      };
-    },
-    {},
-  );
-
-  const newBaseMessagesWitDescription = {
-    ...newBaseMessages,
-    ...newBaseMessagesDescriptions,
-  };
-
-  await writeMessagesFile(baseFile, newBaseMessagesWitDescription);
-
-  return newBaseMessages;
-}
-
-async function updateLocaleCodeTranslations(localeFile, baseFileMessages) {
-  const localeFileMessages = await readMessagesFile(localeFile);
-
-  const unknownMessages = difference(
-    Object.keys(localeFileMessages),
-    Object.keys(baseFileMessages),
-  );
-
-  if (unknownMessages.length) {
-    console.log(
-      chalk.red(`Some localized messages do not exist in base.json!
-You may want to delete these!
-${logKeys(unknownMessages)}`),
-    );
-  }
-
-  const newLocaleFileMessages = {
-    ...baseFileMessages,
-    ...localeFileMessages,
-  };
-
-  const untranslatedKeys = Object.entries(newLocaleFileMessages)
-    .filter(([key, value]) => {
-      return value === baseFileMessages[key];
-    })
-    .map(([key]) => key);
-
-  if (untranslatedKeys.length) {
-    console.warn(
-      chalk.yellow(`Some messages do not seem to be translated!
-${logKeys(untranslatedKeys)}`),
-    );
-  }
-
-  await writeMessagesFile(localeFile, newLocaleFileMessages);
-}
-
-async function updateCodeTranslations() {
-  logSection('Will update base file');
-  const {baseFile, localesFiles} = await getCodeTranslationFiles();
-  const baseFileMessages = await updateBaseFile(baseFile);
-
-  // eslint-disable-next-line no-restricted-syntax
-  for (const localeFile of localesFiles) {
-    logSection(`Will update ${path.basename(localeFile)}`);
-    // eslint-disable-next-line no-await-in-loop
-    await updateLocaleCodeTranslations(localeFile, baseFileMessages);
-  }
-}
-
-function run() {
-  updateCodeTranslations().then(
-    () => {
-      console.log('');
-      console.log(chalk.green('updateCodeTranslations end'));
-      console.log('');
-    },
-    (e) => {
-      console.log('');
-      console.error(chalk.red(`updateCodeTranslations failure: ${e.message}`));
-      console.log('');
-      console.error(e.stack);
-      console.log('');
-      process.exit(1);
-    },
-  );
-}
-
-exports.run = run;
-exports.extractThemeCodeMessages = extractThemeCodeMessages;

package/update-code-translations.test.js

@@ -1,33 +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 {extractThemeCodeMessages} = require('./update-code-translations');
-const path = require('path');
-const fs = require('fs-extra');
-const {mapValues, pickBy} = require('lodash');
-
-// Seems the 5s default timeout fails sometimes
-jest.setTimeout(15000);
-
-describe('update-code-translations', () => {
-  test(`to have base.json contain all the translations extracted from the theme. Please run "yarn workspace @docusaurus/theme-classic update-code-translations" to keep base.json up-to-date.`, async () => {
-    const baseMessages = pickBy(
-      JSON.parse(
-        await fs.readFile(
-          path.join(__dirname, 'codeTranslations', 'base.json'),
-        ),
-      ),
-      (_, key) => !key.endsWith('___DESCRIPTION'),
-    );
-
-    const codeMessages = mapValues(
-      await extractThemeCodeMessages(),
-      (translation) => translation.message,
-    );
-    expect(codeMessages).toEqual(baseMessages);
-  });
-});