@docusaurus/utils 2.0.0-beta.ff31de0ff → 2.0.0-rc.1

package/lib/codeTranslationsUtils.d.ts

@@ -1,11 +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.
- */
-export declare function codeTranslationLocalesToTry(locale: string): string[];
-export declare function readDefaultCodeTranslationMessages({ dirPath, locale, }: {
-    dirPath: string;
-    locale: string;
-}): Promise<Record<string, string>>;

package/lib/codeTranslationsUtils.js

@@ -1,50 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readDefaultCodeTranslationMessages = exports.codeTranslationLocalesToTry = void 0;
-const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-// Return an ordered list of locales we should try
-function codeTranslationLocalesToTry(locale) {
-    // @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];
-    }
-}
-exports.codeTranslationLocalesToTry = codeTranslationLocalesToTry;
-// Useful to implement getDefaultCodeTranslationMessages() in themes
-async function readDefaultCodeTranslationMessages({ dirPath, locale, }) {
-    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_1.default.resolve(dirPath, `${fileName}.json`);
-        // eslint-disable-next-line no-await-in-loop
-        if (await fs_extra_1.default.pathExists(filePath)) {
-            // eslint-disable-next-line no-await-in-loop
-            const fileContent = await fs_extra_1.default.readFile(filePath, 'utf8');
-            return JSON.parse(fileContent);
-        }
-    }
-    return {};
-}
-exports.readDefaultCodeTranslationMessages = readDefaultCodeTranslationMessages;

package/lib/escapePath.d.ts

@@ -1,17 +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 declare function escapePath(str: string): string;

package/lib/escapePath.js

@@ -1,25 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.escapePath = void 0;
-/**
- * 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
- */
-function escapePath(str) {
-    const escaped = JSON.stringify(str);
-    // Remove the " around the json string;
-    return escaped.substring(1, escaped.length - 1);
-}
-exports.escapePath = escapePath;

package/lib/markdownParser.d.ts

@@ -1,28 +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.
- */
-export declare function createExcerpt(fileString: string): string | undefined;
-export declare function parseFrontMatter(markdownFileContent: string): {
-    frontMatter: Record<string, unknown>;
-    content: string;
-};
-export declare function parseMarkdownContentTitle(contentUntrimmed: string, options?: {
-    keepContentTitle?: boolean;
-}): {
-    content: string;
-    contentTitle: string | undefined;
-};
-declare type ParsedMarkdown = {
-    frontMatter: Record<string, unknown>;
-    content: string;
-    contentTitle: string | undefined;
-    excerpt: string | undefined;
-};
-export declare function parseMarkdownString(markdownFileContent: string, options?: {
-    keepContentTitle?: boolean;
-}): ParsedMarkdown;
-export declare function parseMarkdownFile(source: string): Promise<ParsedMarkdown>;
-export {};

package/lib/markdownParser.js

@@ -1,132 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseMarkdownFile = exports.parseMarkdownString = exports.parseMarkdownContentTitle = exports.parseFrontMatter = exports.createExcerpt = void 0;
-const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const gray_matter_1 = tslib_1.__importDefault(require("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.
-function createExcerpt(fileString) {
-    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, '')
-            .trim();
-        if (cleanedLine) {
-            return cleanedLine;
-        }
-    }
-    return undefined;
-}
-exports.createExcerpt = createExcerpt;
-function parseFrontMatter(markdownFileContent) {
-    var _a;
-    const { data, content } = gray_matter_1.default(markdownFileContent);
-    return {
-        frontMatter: data !== null && data !== void 0 ? data : {},
-        content: (_a = content === null || content === void 0 ? void 0 : content.trim()) !== null && _a !== void 0 ? _a : '',
-    };
-}
-exports.parseFrontMatter = parseFrontMatter;
-function parseMarkdownContentTitle(contentUntrimmed, options) {
-    var _a, _b;
-    const keepContentTitleOption = (_a = options === null || options === void 0 ? void 0 : options.keepContentTitle) !== null && _a !== void 0 ? _a : 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 !== null && regularTitleMatch !== void 0 ? regularTitleMatch : alternateTitleMatch;
-    const { pattern, title } = (_b = titleMatch === null || titleMatch === void 0 ? void 0 : titleMatch.groups) !== null && _b !== void 0 ? _b : {};
-    if (!pattern || !title) {
-        return { content, contentTitle: undefined };
-    }
-    const newContent = keepContentTitleOption
-        ? content
-        : content.replace(pattern, '');
-    return {
-        content: newContent.trim(),
-        contentTitle: title.trim(),
-    };
-}
-exports.parseMarkdownContentTitle = parseMarkdownContentTitle;
-function parseMarkdownString(markdownFileContent, options) {
-    var _a;
-    try {
-        const keepContentTitle = (_a = options === null || options === void 0 ? void 0 : options.keepContentTitle) !== null && _a !== void 0 ? _a : false;
-        const { frontMatter, content: contentWithoutFrontMatter } = parseFrontMatter(markdownFileContent);
-        const { content, contentTitle } = parseMarkdownContentTitle(contentWithoutFrontMatter, {
-            keepContentTitle,
-        });
-        const excerpt = createExcerpt(content);
-        return {
-            frontMatter,
-            content,
-            contentTitle,
-            excerpt,
-        };
-    }
-    catch (e) {
-        console.error(chalk_1.default.red(`Error while parsing markdown front matter.
-This can happen if you use special characters like : in frontmatter values (try using "" around that value)`));
-        throw e;
-    }
-}
-exports.parseMarkdownString = parseMarkdownString;
-async function parseMarkdownFile(source) {
-    const markdownString = await fs_extra_1.default.readFile(source, 'utf-8');
-    try {
-        return parseMarkdownString(markdownString);
-    }
-    catch (e) {
-        throw new Error(`Error while parsing markdown file ${source}
-${e.message}`);
-    }
-}
-exports.parseMarkdownFile = parseMarkdownFile;

package/lib/posixPath.d.ts

@@ -1,14 +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 declare function posixPath(str: string): string;

package/lib/posixPath.js

@@ -1,28 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.posixPath = void 0;
-/**
- * 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
- *
- */
-function posixPath(str) {
-    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, '/');
-}
-exports.posixPath = posixPath;

package/src/__tests__/__fixtures__/defaultCodeTranslations/en.json

@@ -1,4 +0,0 @@
-{
-  "id1": "message 1 en",
-  "id2": "message 2 en"
-}

package/src/__tests__/__fixtures__/defaultCodeTranslations/fr-FR.json

@@ -1,5 +0,0 @@
-{
-  "id1": "message 1 fr_FR",
-  "id2": "message 2 fr_FR",
-  "id3": "message 3 fr_FR"
-}

package/src/__tests__/__fixtures__/defaultCodeTranslations/fr.json

@@ -1,4 +0,0 @@
-{
-  "id1": "message 1 fr",
-  "id2": "message 2 fr"
-}

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

@@ -1,8 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`getFolderContainingFile throw if no folder contain such file 1`] = `
-"relativeFilePath=[index.test.ts] does not exist in any of these folders: 
-- /abcdef
-- /gehij
-- /klmn]"
-`;

package/src/__tests__/codeTranslationsUtils.test.ts

@@ -1,112 +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';
-import {
-  codeTranslationLocalesToTry,
-  readDefaultCodeTranslationMessages,
-} from '../codeTranslationsUtils';
-
-describe('codeTranslationLocalesToTry', () => {
-  test('should return appropriate locale lists', () => {
-    expect(codeTranslationLocalesToTry('fr')).toEqual(['fr', 'fr-FR']);
-    expect(codeTranslationLocalesToTry('fr-FR')).toEqual(['fr-FR', 'fr']);
-    // Note: "pt" is expanded into "pt-BR", not "pt-PT", as "pt-BR" is more widely used!
-    // See https://github.com/facebook/docusaurus/pull/4536#issuecomment-810088783
-    expect(codeTranslationLocalesToTry('pt')).toEqual(['pt', 'pt-BR']);
-    expect(codeTranslationLocalesToTry('pt-BR')).toEqual(['pt-BR', 'pt']);
-    expect(codeTranslationLocalesToTry('pt-PT')).toEqual(['pt-PT', 'pt']);
-  });
-});
-
-describe('readDefaultCodeTranslationMessages', () => {
-  const dirPath = path.resolve(
-    __dirname,
-    '__fixtures__',
-    'defaultCodeTranslations',
-  );
-
-  async function readAsJSON(filename: string) {
-    return JSON.parse(
-      await fs.readFile(path.resolve(dirPath, filename), 'utf8'),
-    );
-  }
-
-  test('for empty locale', async () => {
-    await expect(
-      readDefaultCodeTranslationMessages({
-        locale: '',
-        dirPath,
-      }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"First argument to Intl.Locale constructor can't be empty or missing"`,
-    );
-  });
-
-  test('for unexisting locale', async () => {
-    await expect(
-      readDefaultCodeTranslationMessages({
-        locale: 'es',
-        dirPath,
-      }),
-    ).resolves.toEqual({});
-  });
-
-  test('for fr but bad folder', async () => {
-    await expect(
-      readDefaultCodeTranslationMessages({
-        locale: 'fr',
-        dirPath: __dirname,
-      }),
-    ).resolves.toEqual({});
-  });
-
-  test('for fr', async () => {
-    await expect(
-      readDefaultCodeTranslationMessages({
-        locale: 'fr',
-        dirPath,
-      }),
-    ).resolves.toEqual(await readAsJSON('fr.json'));
-  });
-
-  test('for fr-FR', async () => {
-    await expect(
-      readDefaultCodeTranslationMessages({
-        locale: 'fr-FR',
-        dirPath,
-      }),
-    ).resolves.toEqual(await readAsJSON('fr-FR.json'));
-  });
-
-  test('for en', async () => {
-    await expect(
-      readDefaultCodeTranslationMessages({
-        locale: 'en',
-        dirPath,
-      }),
-    ).resolves.toEqual(await readAsJSON('en.json'));
-  });
-
-  test('for en-US', async () => {
-    await expect(
-      readDefaultCodeTranslationMessages({
-        locale: 'en-US',
-        dirPath,
-      }),
-    ).resolves.toEqual(await readAsJSON('en.json'));
-  });
-
-  test('for en-WHATEVER', async () => {
-    await expect(
-      readDefaultCodeTranslationMessages({
-        locale: 'en-WHATEVER',
-        dirPath,
-      }),
-    ).resolves.toEqual(await readAsJSON('en.json'));
-  });
-});

package/src/__tests__/escapePath.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 {escapePath} from '../escapePath';
-
-describe('escapePath', () => {
-  test('escapePath 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(escapePath(file)).toBe(asserts[file]);
-    });
-  });
-});