@docusaurus/theme-classic 2.0.0-beta.2 → 2.0.0-beta.20

package/lib-next/__tests__/translations.test.js

@@ -1,128 +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 {updateTranslationFileMessages} from '@docusaurus/utils';
-const ThemeConfigSample = {
-  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) {
-    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});
-  });
-});

package/lib-next/__tests__/validateThemeConfig.test.js

@@ -1,333 +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 {merge} from 'lodash';
-
-const {ThemeConfigSchema, DEFAULT_CONFIG} = require('../validateThemeConfig');
-
-const {normalizeThemeConfig} = require('@docusaurus/utils-validation');
-const theme = require('prism-react-renderer/themes/github');
-const darkTheme = require('prism-react-renderer/themes/dracula');
-
-function testValidateThemeConfig(partialThemeConfig) {
-  return normalizeThemeConfig(ThemeConfigSchema, {
-    ...DEFAULT_CONFIG,
-    ...partialThemeConfig,
-  });
-}
-
-function testOk(partialThemeConfig) {
-  expect(
-    testValidateThemeConfig({...DEFAULT_CONFIG, ...partialThemeConfig}),
-  ).toEqual({
-    ...DEFAULT_CONFIG,
-    ...partialThemeConfig,
-  });
-}
-
-describe('themeConfig', () => {
-  test('should accept valid theme config', () => {
-    const userConfig = {
-      prism: {
-        theme,
-        darkTheme,
-        defaultLanguage: 'javascript',
-        additionalLanguages: ['kotlin', 'java'],
-      },
-      announcementBar: {
-        id: 'supportus',
-        content: 'pls support',
-        backgroundColor: '#fff',
-        textColor: '#000',
-        isCloseable: true,
-      },
-      image: 'img/docusaurus-soc.png',
-      navbar: {
-        style: 'primary',
-        hideOnScroll: true,
-        title: 'Docusaurus',
-        logo: {
-          alt: 'Docusaurus Logo',
-          src: 'img/docusaurus.svg',
-          srcDark: 'img/docusaurus_keytar.svg',
-        },
-        items: [
-          {
-            type: 'docsVersionDropdown',
-            position: 'left',
-            dropdownItemsBefore: [],
-            dropdownItemsAfter: [],
-          },
-          {
-            to: 'docs/next/support',
-            label: 'Community',
-            position: 'left',
-            activeBaseRegex: `docs/next/(support|team|resources)`,
-            'aria-label': 'Community',
-          },
-        ],
-      },
-      footer: {
-        style: 'dark',
-        links: [
-          {
-            title: 'Learn',
-            items: [
-              {
-                label: 'Introduction',
-                to: 'docs',
-              },
-            ],
-          },
-        ],
-        logo: {
-          alt: 'Facebook Open Source Logo',
-          src: 'img/oss_logo.png',
-          href: 'https://opensource.facebook.com',
-        },
-        copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc. Built with Docusaurus.`,
-      },
-    };
-    expect(testValidateThemeConfig(userConfig)).toEqual({
-      ...DEFAULT_CONFIG,
-      ...userConfig,
-    });
-  });
-
-  test('should allow possible types of navbar items', () => {
-    const config = {
-      navbar: {
-        items: [
-          // Doc link
-          {
-            type: 'doc',
-            position: 'left',
-            docId: 'intro',
-            label: 'Introduction',
-            activeSidebarClassName: 'custom-class',
-          },
-          // Regular link
-          {
-            to: '/guide/',
-            label: 'Guide',
-            position: 'left',
-            activeBaseRegex: '/guide/',
-          },
-          // Regular dropdown
-          {
-            label: 'Community',
-            position: 'right',
-            items: [
-              {
-                label: 'Facebook',
-                href: 'https://.facebook.com/',
-                target: '_self',
-              },
-              {
-                label: 'GitHub',
-                href: 'https://github.com/facebook/docusaurus',
-                className: 'github-link',
-              },
-            ],
-          },
-          // Doc version dropdown
-          {
-            type: 'docsVersionDropdown',
-            position: 'right',
-            dropdownActiveClassDisabled: true,
-            dropdownItemsBefore: [
-              {
-                href:
-                  'https://www.npmjs.com/package/docusaurus?activeTab=versions',
-                label: 'Versions on npm',
-                className: 'npm-styled',
-                target: '_self',
-              },
-            ],
-            dropdownItemsAfter: [
-              {
-                to: '/versions',
-                label: 'All versions',
-                className: 'all_vers',
-              },
-            ],
-          },
-          // External link with custom data attribute
-          {
-            href: 'https://github.com/facebook/docusaurus',
-            position: 'right',
-            className: 'header-github-link',
-            'aria-label': 'GitHub repository',
-          },
-          // Docs version
-          {
-            type: 'docsVersion',
-            position: 'left',
-            label: 'Current version',
-          },
-        ],
-      },
-    };
-    expect(testValidateThemeConfig(config)).toEqual({
-      ...DEFAULT_CONFIG,
-      navbar: {
-        ...DEFAULT_CONFIG.navbar,
-        ...config.navbar,
-      },
-    });
-  });
-
-  test('should allow empty alt tags for the logo image in the header', () => {
-    const altTagConfig = {
-      navbar: {
-        logo: {
-          alt: '',
-          src: '/arbitrary-logo.png',
-        },
-        hideOnScroll: false,
-      },
-    };
-    expect(testValidateThemeConfig(altTagConfig)).toEqual({
-      ...DEFAULT_CONFIG,
-      navbar: {
-        ...DEFAULT_CONFIG.navbar,
-        ...altTagConfig.navbar,
-      },
-    });
-  });
-
-  test('should allow empty alt tags for the logo image in the footer', () => {
-    const partialConfig = {
-      footer: {
-        logo: {
-          alt: '',
-          src: '/arbitrary-logo.png',
-        },
-      },
-    };
-    const normalizedConfig = testValidateThemeConfig(partialConfig);
-
-    expect(normalizedConfig).toEqual({
-      ...normalizedConfig,
-      footer: {
-        ...normalizedConfig.footer,
-        ...partialConfig.footer,
-      },
-    });
-  });
-
-  test('should accept valid prism config', () => {
-    const prismConfig = {
-      prism: {
-        additionalLanguages: ['kotlin', 'java'],
-      },
-    };
-    expect(testValidateThemeConfig(prismConfig)).toEqual({
-      ...DEFAULT_CONFIG,
-      ...prismConfig,
-    });
-  });
-
-  describe('customCss config', () => {
-    test('should accept customCss undefined', () => {
-      testOk({
-        customCss: undefined,
-      });
-    });
-
-    test('should accept customCss string', () => {
-      testOk({
-        customCss: './path/to/cssFile.css',
-      });
-    });
-
-    test('should accept customCss string array', () => {
-      testOk({
-        customCss: ['./path/to/cssFile.css', './path/to/cssFile2.css'],
-      });
-    });
-
-    test('should reject customCss number', () => {
-      expect(() =>
-        testValidateThemeConfig({
-          customCss: 42,
-        }),
-      ).toThrowErrorMatchingInlineSnapshot(
-        `"\\"customCss\\" must be one of [array, string]"`,
-      );
-    });
-  });
-
-  describe('color mode config', () => {
-    const withDefaultValues = (colorMode) =>
-      merge({}, DEFAULT_CONFIG.colorMode, colorMode);
-
-    test('minimal config', () => {
-      const colorMode = {
-        switchConfig: {
-          darkIcon: '🌙',
-        },
-      };
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: withDefaultValues(colorMode),
-      });
-    });
-
-    test('max config', () => {
-      const colorMode = {
-        defaultMode: 'dark',
-        disableSwitch: false,
-        respectPrefersColorScheme: true,
-        switchConfig: {
-          darkIcon: '🌙',
-          darkIconStyle: {
-            marginTop: '1px',
-            marginLeft: '2px',
-          },
-          lightIcon: '☀️',
-          lightIconStyle: {
-            marginLeft: '1px',
-          },
-        },
-      };
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: withDefaultValues(colorMode),
-      });
-    });
-
-    test('undefined config', () => {
-      const colorMode = undefined;
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: withDefaultValues(colorMode),
-      });
-    });
-
-    test('empty config', () => {
-      const colorMode = {};
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: {
-          ...DEFAULT_CONFIG.colorMode,
-          ...colorMode,
-        },
-      });
-    });
-
-    test('empty switch config', () => {
-      const colorMode = {
-        switchConfig: {},
-      };
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: withDefaultValues(colorMode),
-      });
-    });
-  });
-});

package/lib-next/index.js

@@ -1,221 +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 path from 'path';
-import Module from 'module';
-import rtlcss from 'rtlcss';
-import {readDefaultCodeTranslationMessages} from '@docusaurus/utils';
-const createRequire = Module.createRequire || Module.createRequireFromPath;
-const requireFromDocusaurusCore = createRequire(
-  require.resolve('@docusaurus/core/package.json'),
-);
-const ContextReplacementPlugin = requireFromDocusaurusCore(
-  'webpack/lib/ContextReplacementPlugin',
-); // Need to be inlined to prevent dark mode FOUC
-// Make sure that the 'storageKey' is the same as the one in `/theme/hooks/useTheme.js`
-
-const ThemeStorageKey = 'theme';
-
-const noFlashColorMode = ({defaultMode, respectPrefersColorScheme}) => {
-  return `(function() {
-  var defaultMode = '${defaultMode}';
-  var respectPrefersColorScheme = ${respectPrefersColorScheme};
-
-  function setDataThemeAttribute(theme) {
-    document.documentElement.setAttribute('data-theme', theme);
-  }
-
-  function getStoredTheme() {
-    var theme = null;
-    try {
-      theme = localStorage.getItem('${ThemeStorageKey}');
-    } catch (err) {}
-    return theme;
-  }
-
-  var storedTheme = getStoredTheme();
-  if (storedTheme !== null) {
-    setDataThemeAttribute(storedTheme);
-  } else {
-    if (
-      respectPrefersColorScheme &&
-      window.matchMedia('(prefers-color-scheme: dark)').matches
-    ) {
-      setDataThemeAttribute('dark');
-    } else if (
-      respectPrefersColorScheme &&
-      window.matchMedia('(prefers-color-scheme: light)').matches
-    ) {
-      setDataThemeAttribute('light');
-    } else {
-      setDataThemeAttribute(defaultMode === 'dark' ? 'dark' : 'light');
-    }
-  }
-})();`;
-}; // Duplicated constant. Unfortunately we can't import it from theme-common, as we need to support older nodejs versions without ESM support
-// TODO: import from theme-common once we only support Node.js with ESM support
-// + move all those announcementBar stuff there too
-
-export const AnnouncementBarDismissStorageKey =
-  'docusaurus.announcement.dismiss';
-const AnnouncementBarDismissDataAttribute =
-  'data-announcement-bar-initially-dismissed'; // We always render the announcement bar html on the server, to prevent layout shifts on React hydration
-// The theme can use CSS + the data attribute to hide the announcement bar asap (before React hydration)
-
-const AnnouncementBarInlineJavaScript = `
-(function() {
-  function isDismissed() {
-    try {
-      return localStorage.getItem('${AnnouncementBarDismissStorageKey}') === 'true';
-    } catch (err) {}
-    return false;
-  }
-  document.documentElement.setAttribute('${AnnouncementBarDismissDataAttribute}', isDismissed());
-})();`;
-
-function getInfimaCSSFile(direction) {
-  return `infima/dist/css/default/default${
-    direction === 'rtl' ? '-rtl' : ''
-  }.css`;
-}
-
-export default function docusaurusThemeClassic(
-  context, // TODO: LoadContext is missing some of properties
-  options,
-) {
-  const {
-    siteConfig: {themeConfig: roughlyTypedThemeConfig},
-    i18n: {currentLocale, localeConfigs},
-  } = context;
-  const themeConfig = roughlyTypedThemeConfig || {};
-  const {
-    announcementBar,
-    colorMode,
-    prism: {additionalLanguages = []} = {},
-  } = themeConfig;
-  const {customCss} = options || {};
-  const {direction} = localeConfigs[currentLocale];
-  return {
-    name: 'docusaurus-theme-classic',
-
-    /*
-    Does not seem needed: webpack can already hot reload theme files
-    getPathsToWatch() {
-      return [
-        path.join(__dirname, '..', 'lib'),
-        path.join(__dirname, '..', 'lib-next'),
-      ];
-    },
-     */
-    getThemePath() {
-      return path.join(__dirname, '..', 'lib-next', 'theme');
-    },
-
-    getTypeScriptThemePath() {
-      return path.resolve(__dirname, '..', 'src', 'theme');
-    },
-
-    getTranslationFiles: async () =>
-      getTranslationFiles({
-        themeConfig,
-      }),
-    translateThemeConfig,
-    getDefaultCodeTranslationMessages: () => {
-      return readDefaultCodeTranslationMessages({
-        dirPath: path.resolve(__dirname, '..', 'codeTranslations'),
-        locale: currentLocale,
-      });
-    },
-
-    getClientModules() {
-      const modules = [
-        require.resolve(getInfimaCSSFile(direction)),
-        path.resolve(__dirname, './prism-include-languages'),
-      ];
-
-      if (customCss) {
-        if (Array.isArray(customCss)) {
-          modules.push(...customCss);
-        } else {
-          modules.push(customCss);
-        }
-      }
-
-      return modules;
-    },
-
-    configureWebpack() {
-      const prismLanguages = additionalLanguages
-        .map((lang) => `prism-${lang}`)
-        .join('|');
-      return {
-        ignoreWarnings: [
-          // See https://github.com/facebook/docusaurus/pull/3382
-          (e) => e.message.includes("Can't resolve '@theme-init/hooks/useDocs"),
-        ],
-        plugins: [
-          new ContextReplacementPlugin(
-            /prismjs[\\/]components$/,
-            new RegExp(`^./(${prismLanguages})$`),
-          ),
-        ],
-      };
-    },
-
-    configurePostCss(postCssOptions) {
-      if (direction === 'rtl') {
-        const resolvedInfimaFile = require.resolve(getInfimaCSSFile(direction));
-
-        const plugin = {
-          postcssPlugin: 'RtlCssPlugin',
-          prepare: (result) => {
-            const file = result.root?.source?.input?.file; // Skip Infima as we are using the its RTL version.
-
-            if (file === resolvedInfimaFile) {
-              return {};
-            }
-
-            return rtlcss(result.root);
-          },
-        };
-        postCssOptions.plugins.push(plugin);
-      }
-
-      return postCssOptions;
-    },
-
-    injectHtmlTags() {
-      return {
-        preBodyTags: [
-          {
-            tagName: 'script',
-            innerHTML: `
-${noFlashColorMode(colorMode)}
-${announcementBar ? AnnouncementBarInlineJavaScript : ''}
-            `,
-          },
-        ],
-      };
-    },
-  };
-}
-const swizzleAllowedComponents = [
-  'CodeBlock',
-  'DocSidebar',
-  'Footer',
-  'NotFound',
-  'SearchBar',
-  'IconArrow',
-  'IconEdit',
-  'IconMenu',
-  'hooks/useTheme',
-  'prism-include-languages',
-];
-export function getSwizzleComponentList() {
-  return swizzleAllowedComponents;
-}
-export {validateThemeConfig} from './validateThemeConfig';