@docusaurus/utils 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

package/src/__tests__/pathUtils.test.ts

@@ -1,63 +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 {isNameTooLong, shortName} from '../pathUtils';
-
-describe('pathUtils', () => {
-  test('isNameTooLong', () => {
-    const asserts: Record<string, boolean> = {
-      '': false,
-      'foo-bar-096': false,
-      'foo-bar-1df': false,
-      'endi-lie-9fa': false,
-      'endi-lie-fd3': false,
-      'yangshun-tay-48d': false,
-      'yangshun-tay-f3b': false,
-      'foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-d46': true,
-      'foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-test-1-test-2-787': true,
-    };
-    Object.keys(asserts).forEach((path) => {
-      expect(isNameTooLong(path)).toBe(asserts[path]);
-    });
-  });
-
-  describe('shortName', () => {
-    test('works', () => {
-      const asserts: Record<string, string> = {
-        '': '',
-        'foo-bar': 'foo-bar',
-        'endi-lie': 'endi-lie',
-        'yangshun-tay': 'yangshun-tay',
-        'foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar':
-          'foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-',
-        'foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-test-1-test-2':
-          'foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-foo-bar-test-1-test-',
-      };
-      Object.keys(asserts).forEach((file) => {
-        expect(shortName(file)).toBe(asserts[file]);
-      });
-    });
-
-    // Based on https://github.com/gatsbyjs/gatsby/pull/21518/files
-
-    const SHORT_PATH = `/short/path/without/trailing/slash`;
-    const VERY_LONG_PATH = `/${`x`.repeat(256)}/`;
-    const VERY_LONG_PATH_NON_LATIN = `/${`あ`.repeat(255)}/`;
-
-    it(`Truncates long paths correctly`, () => {
-      const truncatedPathLatin = shortName(VERY_LONG_PATH);
-      const truncatedPathNonLatin = shortName(VERY_LONG_PATH_NON_LATIN);
-      expect(truncatedPathLatin.length).toBeLessThanOrEqual(255);
-      expect(truncatedPathNonLatin.length).toBeLessThanOrEqual(255);
-    });
-
-    it(`Does not truncate short paths`, () => {
-      const truncatedPath = shortName(SHORT_PATH);
-      expect(truncatedPath).toEqual(SHORT_PATH);
-    });
-  });
-});

package/src/__tests__/posixPath.test.ts

@@ -1,25 +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 {posixPath} from '../posixPath';
-
-describe('posixPath', () => {
-  test('posixPath works', () => {
-    const asserts: Record<string, string> = {
-      'c:/aaaa\\bbbb': 'c:/aaaa/bbbb',
-      'c:\\aaaa\\bbbb\\★': 'c:\\aaaa\\bbbb\\★',
-      '\\\\?\\c:\\aaaa\\bbbb': '\\\\?\\c:\\aaaa\\bbbb',
-      'c:\\aaaa\\bbbb': 'c:/aaaa/bbbb',
-      'foo\\bar': 'foo/bar',
-      'foo\\bar/lol': 'foo/bar/lol',
-      'website\\docs/**/*.{md,mdx}': 'website/docs/**/*.{md,mdx}',
-    };
-    Object.keys(asserts).forEach((file) => {
-      expect(posixPath(file)).toBe(asserts[file]);
-    });
-  });
-});

package/src/codeTranslationsUtils.ts

@@ -1,56 +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 path from 'path';
-import fs from 'fs-extra';
-
-// Return an ordered list of locales we should try
-export function codeTranslationLocalesToTry(locale: string): string[] {
-  // @ts-expect-error: TODO until available in TS, see https://github.com/microsoft/TypeScript/issues/37326
-  const intlLocale = Intl.Locale ? new Intl.Locale(locale) : undefined;
-  if (!intlLocale) {
-    return [locale];
-  }
-  // if locale is just a simple language like "pt", we want to fallback to pt-BR (not pt-PT!)
-  // see https://github.com/facebook/docusaurus/pull/4536#issuecomment-810088783
-  if (intlLocale.language === locale) {
-    const maximizedLocale = intlLocale.maximize(); // pt-Latn-BR`
-    // ["pt","pt-BR"]
-    return [locale, `${maximizedLocale.language}-${maximizedLocale.region}`];
-  }
-  // if locale is like "pt-BR", we want to fallback to "pt"
-  else {
-    return [locale, intlLocale.language];
-  }
-}
-
-// Useful to implement getDefaultCodeTranslationMessages() in themes
-export async function readDefaultCodeTranslationMessages({
-  dirPath,
-  locale,
-}: {
-  dirPath: string;
-  locale: string;
-}): Promise<Record<string, string>> {
-  const localesToTry = codeTranslationLocalesToTry(locale);
-
-  // Return the content of the first file that match
-  // fr_FR.json => fr.json => nothing
-  // eslint-disable-next-line no-restricted-syntax
-  for (const fileName of localesToTry) {
-    const filePath = path.resolve(dirPath, `${fileName}.json`);
-
-    // eslint-disable-next-line no-await-in-loop
-    if (await fs.pathExists(filePath)) {
-      // eslint-disable-next-line no-await-in-loop
-      const fileContent = await fs.readFile(filePath, 'utf8');
-      return JSON.parse(fileContent);
-    }
-  }
-
-  return {};
-}

package/src/escapePath.ts

@@ -1,23 +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.
- */
-
-/**
- * When you have a path like C:\X\Y
- * It is not safe to use directly when generating code
- * For example, this would fail due to unescaped \: `<img src={require('${filePath}')} />`
- * But this would work: `<img src={require('${escapePath(filePath)}')} />`
- *
- * Workaround for issue in posixPath, maybe we won't need it anymore soon?
- * https://github.com/facebook/docusaurus/issues/4730#issuecomment-833530370
- * https://github.com/sindresorhus/slash/pull/16#issuecomment-833528479
- */
-export function escapePath(str: string): string {
-  const escaped = JSON.stringify(str);
-
-  // Remove the " around the json string;
-  return escaped.substring(1, escaped.length - 1);
-}

package/src/posixPath.ts

@@ -1,27 +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.
- */
-
-/**
- * Convert Windows backslash paths to posix style paths.
- * E.g: endi\\lie -> endi/lie
- *
- * Looks like this code was originally copied from https://github.com/sindresorhus/slash/blob/main/index.js
- *
- */
-export function posixPath(str: string): string {
-  const isExtendedLengthPath = /^\\\\\?\\/.test(str);
-
-  // TODO not sure why we need this
-  // See https://github.com/sindresorhus/slash/pull/16#issuecomment-833528479
-  // See https://github.com/facebook/docusaurus/issues/4730#issuecomment-833530370
-  const hasNonAscii = /[^\u0000-\u0080]+/.test(str); // eslint-disable-line
-
-  if (isExtendedLengthPath || hasNonAscii) {
-    return str;
-  }
-  return str.replace(/\\/g, '/');
-}

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "incremental": true,
-    "tsBuildInfoFile": "./lib/.tsbuildinfo",
-    "rootDir": "src",
-    "outDir": "lib"
-  }
-}