@docusaurus/utils 2.0.0-beta.fc64c12e4 → 2.0.0

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/markdownParser.ts

@@ -1,182 +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 chalk from 'chalk';
-import fs from 'fs-extra';
-import matter from 'gray-matter';
-
-// Hacky way of stripping out import statements from the excerpt
-// TODO: Find a better way to do so, possibly by compiling the Markdown content,
-// stripping out HTML tags and obtaining the first line.
-export function createExcerpt(fileString: string): string | undefined {
-  const fileLines = fileString
-    .trimLeft()
-    // Remove Markdown alternate title
-    .replace(/^[^\n]*\n[=]+/g, '')
-    .split('\n');
-
-  /* eslint-disable no-continue */
-  // eslint-disable-next-line no-restricted-syntax
-  for (const fileLine of fileLines) {
-    // Skip empty line.
-    if (!fileLine.trim()) {
-      continue;
-    }
-
-    // Skip import/export declaration.
-    if (/^\s*?import\s.*(from.*)?;?|export\s.*{.*};?/.test(fileLine)) {
-      continue;
-    }
-
-    const cleanedLine = fileLine
-      // Remove HTML tags.
-      .replace(/<[^>]*>/g, '')
-      // Remove Title headers
-      .replace(/^#\s*([^#]*)\s*#?/gm, '')
-      // Remove Markdown + ATX-style headers
-      .replace(/^#{1,6}\s*([^#]*)\s*(#{1,6})?/gm, '$1')
-      // Remove emphasis and strikethroughs.
-      .replace(/([*_~]{1,3})(\S.*?\S{0,1})\1/g, '$2')
-      // Remove images.
-      .replace(/!\[(.*?)\][[(].*?[\])]/g, '$1')
-      // Remove footnotes.
-      .replace(/\[\^.+?\](: .*?$)?/g, '')
-      // Remove inline links.
-      .replace(/\[(.*?)\][[(].*?[\])]/g, '$1')
-      // Remove inline code.
-      .replace(/`(.+?)`/g, '$1')
-      // Remove blockquotes.
-      .replace(/^\s{0,3}>\s?/g, '')
-      // Remove admonition definition.
-      .replace(/(:{3}.*)/, '')
-      // Remove Emoji names within colons include preceding whitespace.
-      .replace(/\s?(:(::|[^:\n])+:)/g, '')
-      // Remove custom Markdown heading id.
-      .replace(/{#*[\w-]+}/, '')
-      .trim();
-
-    if (cleanedLine) {
-      return cleanedLine;
-    }
-  }
-
-  return undefined;
-}
-
-export function parseFrontMatter(
-  markdownFileContent: string,
-): {
-  frontMatter: Record<string, unknown>;
-  content: string;
-} {
-  const {data, content} = matter(markdownFileContent);
-  return {
-    frontMatter: data ?? {},
-    content: content?.trim() ?? '',
-  };
-}
-
-// Try to convert markdown heading as text
-// Does not need to be perfect, it is only used as a fallback when frontMatter.title is not provided
-// For now, we just unwrap possible inline code blocks (# `config.js`)
-function toTextContentTitle(contentTitle: string): string {
-  if (contentTitle.startsWith('`') && contentTitle.endsWith('`')) {
-    return contentTitle.substring(1, contentTitle.length - 1);
-  }
-  return contentTitle;
-}
-
-export function parseMarkdownContentTitle(
-  contentUntrimmed: string,
-  options?: {removeContentTitle?: boolean},
-): {content: string; contentTitle: string | undefined} {
-  const removeContentTitleOption = options?.removeContentTitle ?? false;
-
-  const content = contentUntrimmed.trim();
-
-  const IMPORT_STATEMENT = /import\s+(([\w*{}\s\n,]+)from\s+)?["'\s]([@\w/_.-]+)["'\s];?|\n/
-    .source;
-  const REGULAR_TITLE = /(?<pattern>#\s*(?<title>[^#\n{]*)+[ \t]*(?<suffix>({#*[\w-]+})|#)?\n*?)/
-    .source;
-  const ALTERNATE_TITLE = /(?<pattern>\s*(?<title>[^\n]*)\s*\n[=]+)/.source;
-
-  const regularTitleMatch = new RegExp(
-    `^(?:${IMPORT_STATEMENT})*?${REGULAR_TITLE}`,
-    'g',
-  ).exec(content);
-  const alternateTitleMatch = new RegExp(
-    `^(?:${IMPORT_STATEMENT})*?${ALTERNATE_TITLE}`,
-    'g',
-  ).exec(content);
-
-  const titleMatch = regularTitleMatch ?? alternateTitleMatch;
-  const {pattern, title} = titleMatch?.groups ?? {};
-
-  if (!pattern || !title) {
-    return {content, contentTitle: undefined};
-  } else {
-    const newContent = removeContentTitleOption
-      ? content.replace(pattern, '')
-      : content;
-    return {
-      content: newContent.trim(),
-      contentTitle: toTextContentTitle(title.trim()).trim(),
-    };
-  }
-}
-
-type ParsedMarkdown = {
-  frontMatter: Record<string, unknown>;
-  content: string;
-  contentTitle: string | undefined;
-  excerpt: string | undefined;
-};
-
-export function parseMarkdownString(
-  markdownFileContent: string,
-  options?: {removeContentTitle?: boolean},
-): ParsedMarkdown {
-  try {
-    const {frontMatter, content: contentWithoutFrontMatter} = parseFrontMatter(
-      markdownFileContent,
-    );
-
-    const {content, contentTitle} = parseMarkdownContentTitle(
-      contentWithoutFrontMatter,
-      options,
-    );
-
-    const excerpt = createExcerpt(content);
-
-    return {
-      frontMatter,
-      content,
-      contentTitle,
-      excerpt,
-    };
-  } catch (e) {
-    console.error(
-      chalk.red(`Error while parsing Markdown frontmatter.
-This can happen if you use special characters in frontmatter values (try using double quotes around that value).`),
-    );
-    throw e;
-  }
-}
-
-export async function parseMarkdownFile(
-  source: string,
-  options?: {removeContentTitle?: boolean},
-): Promise<ParsedMarkdown> {
-  const markdownString = await fs.readFile(source, 'utf-8');
-  try {
-    return parseMarkdownString(markdownString, options);
-  } catch (e) {
-    throw new Error(
-      `Error while parsing Markdown file ${source}: "${e.message}".`,
-    );
-  }
-}

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"
-  }
-}