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

package/lib/index.d.ts

@@ -4,79 +4,19 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { ReportingSeverity, TranslationFileContent, TranslationFile } from '@docusaurus/types';
-import { posixPath as posixPathImport } from './posixPath';
-export declare const posixPath: typeof posixPathImport;
-export * from './codeTranslationsUtils';
-export * from './markdownParser';
-export * from './markdownLinks';
-export * from './escapePath';
+export { NODE_MAJOR_VERSION, NODE_MINOR_VERSION, DEFAULT_BUILD_DIR_NAME, DEFAULT_CONFIG_FILE_NAME, BABEL_CONFIG_FILE_NAME, GENERATED_FILES_DIR_NAME, SRC_DIR_NAME, STATIC_DIR_NAME, OUTPUT_STATIC_ASSETS_DIR_NAME, THEME_PATH, DEFAULT_PORT, DEFAULT_PLUGIN_ID, WEBPACK_URL_LOADER_LIMIT, } from './constants';
+export { generate, genChunkName, readOutputHTMLFile } from './emitUtils';
+export { getFileCommitDate, GitNotFoundError } from './gitUtils';
+export { mergeTranslations, updateTranslationFileMessages, getPluginI18nPath, } from './i18nUtils';
+export { removeSuffix, removePrefix, getElementsAround, mapAsyncSequential, findAsyncSequential, reportMessage, } from './jsUtils';
+export { normalizeUrl, getEditUrl, fileToPath, encodePath, isValidPathname, resolvePathname, addLeadingSlash, addTrailingSlash, removeTrailingSlash, } from './urlUtils';
+export { type Tag, type FrontMatterTag, type TaggedItemGroup, normalizeFrontMatterTag, normalizeFrontMatterTags, groupTaggedItems, } from './tags';
+export { parseMarkdownHeadingId, createExcerpt, parseFrontMatter, parseMarkdownContentTitle, parseMarkdownString, } from './markdownParser';
+export { type ContentPaths, type BrokenMarkdownLink, type ReplaceMarkdownLinksParams, type ReplaceMarkdownLinksReturn, replaceMarkdownLinks, } from './markdownLinks';
+export { type SluggerOptions, type Slugger, createSlugger } from './slugger';
+export { isNameTooLong, shortName, posixPath, toMessageRelativeFilePath, aliasedSitePath, escapePath, addTrailingPathSeparator, } from './pathUtils';
 export { md5Hash, simpleHash, docuHash } from './hashUtils';
-export declare function generate(generatedFilesDir: string, file: string, content: string, skipCache?: boolean): Promise<void>;
-export declare function objectWithKeySorted<T>(obj: Record<string, T>): Record<string, T>;
-/**
- * Convert filepath to url path.
- * Example: 'index.md' -> '/', 'foo/bar.js' -> '/foo/bar',
- */
-export declare function fileToPath(file: string): string;
-export declare function encodePath(userpath: string): string;
-/**
- * Convert first string character to the upper case.
- * E.g: docusaurus -> Docusaurus
- */
-export declare function upperFirst(str: string): string;
-/**
- * Generate unique React Component Name.
- * E.g: /foo-bar -> FooBar096
- */
-export declare function genComponentName(pagePath: string): string;
-export declare function toMessageRelativeFilePath(filePath: string): string;
-/**
- * Generate unique chunk name given a module path.
- */
-export declare function genChunkName(modulePath: string, prefix?: string, preferredName?: string, shortId?: boolean): string;
-export declare function idx(target: any, keyPaths?: string | (string | number)[]): any;
-/**
- * Given a filepath and dirpath, get the first directory.
- */
-export declare function getSubFolder(file: string, refDir: string): string | null;
-export declare function normalizeUrl(rawUrls: string[]): string;
-/**
- * Alias filepath relative to site directory, very useful so that we
- * don't expose user's site structure.
- * Example: some/path/to/website/docs/foo.md -> @site/docs/foo.md
- */
-export declare function aliasedSitePath(filePath: string, siteDir: string): string;
-export declare function getEditUrl(fileRelativePath: string, editUrl?: string): string | undefined;
-export declare function isValidPathname(str: string): boolean;
-export declare function resolvePathname(to: string, from?: string): string;
-export declare function addLeadingSlash(str: string): string;
-export declare function addTrailingPathSeparator(str: string): string;
-export declare function addTrailingSlash(str: string): string;
-export declare function removeTrailingSlash(str: string): string;
-export declare function removeSuffix(str: string, suffix: string): string;
-export declare function removePrefix(str: string, prefix: string): string;
-export declare function getElementsAround<T extends unknown>(array: T[], aroundIndex: number): {
-    next: T | undefined;
-    previous: T | undefined;
-};
-export declare function getPluginI18nPath({ siteDir, locale, pluginName, pluginId, // TODO duplicated constant
-subPaths, }: {
-    siteDir: string;
-    locale: string;
-    pluginName: string;
-    pluginId?: string | undefined;
-    subPaths?: string[];
-}): string;
-export declare function mapAsyncSequencial<T extends unknown, R extends unknown>(array: T[], action: (t: T) => Promise<R>): Promise<R[]>;
-export declare function findAsyncSequential<T>(array: T[], predicate: (t: T) => Promise<boolean>): Promise<T | undefined>;
-export declare function findFolderContainingFile(folderPaths: string[], relativeFilePath: string): Promise<string | undefined>;
-export declare function getFolderContainingFile(folderPaths: string[], relativeFilePath: string): Promise<string>;
-export declare function reportMessage(message: string, reportingSeverity: ReportingSeverity): void;
-export declare function mergeTranslations(contents: TranslationFileContent[]): TranslationFileContent;
-export declare function getSwizzledComponent(componentPath: string): string | undefined;
-export declare function updateTranslationFileMessages(translationFile: TranslationFile, updateMessage: (message: string) => string): TranslationFile;
-export declare function parseMarkdownHeadingId(heading: string): {
-    text: string;
-    id?: string;
-};
+export { Globby, GlobExcludeDefault, createMatcher, createAbsoluteFilePathMatcher, } from './globUtils';
+export { getFileLoaderUtils } from './webpackUtils';
+export { getDataFilePath, getDataFileData, getContentPathList, findFolderContainingFile, getFolderContainingFile, } from './dataFileUtils';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,wBAAwB,EACxB,YAAY,EACZ,eAAe,EACf,6BAA6B,EAC7B,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,QAAQ,EAAE,YAAY,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAC;AACvE,OAAO,EAAC,iBAAiB,EAAE,gBAAgB,EAAC,MAAM,YAAY,CAAC;AAC/D,OAAO,EACL,iBAAiB,EACjB,6BAA6B,EAC7B,iBAAiB,GAClB,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,aAAa,GACd,MAAM,WAAW,CAAC;AACnB,OAAO,EACL,YAAY,EACZ,UAAU,EACV,UAAU,EACV,UAAU,EACV,eAAe,EACf,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,KAAK,GAAG,EACR,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,uBAAuB,EACvB,wBAAwB,EACxB,gBAAgB,GACjB,MAAM,QAAQ,CAAC;AAChB,OAAO,EACL,sBAAsB,EACtB,aAAa,EACb,gBAAgB,EAChB,yBAAyB,EACzB,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,kBAAkB,EACvB,KAAK,0BAA0B,EAC/B,KAAK,0BAA0B,EAC/B,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAC,KAAK,cAAc,EAAE,KAAK,OAAO,EAAE,aAAa,EAAC,MAAM,WAAW,CAAC;AAC3E,OAAO,EACL,aAAa,EACb,SAAS,EACT,SAAS,EACT,yBAAyB,EACzB,eAAe,EACf,UAAU,EACV,wBAAwB,GACzB,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAC,MAAM,aAAa,CAAC;AAC1D,OAAO,EACL,MAAM,EACN,kBAAkB,EAClB,aAAa,EACb,6BAA6B,GAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAC,kBAAkB,EAAC,MAAM,gBAAgB,CAAC;AAClD,OAAO,EACL,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,GACxB,MAAM,iBAAiB,CAAC"}

package/lib/index.js

@@ -6,398 +6,87 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseMarkdownHeadingId = exports.updateTranslationFileMessages = exports.getSwizzledComponent = exports.mergeTranslations = exports.reportMessage = exports.getFolderContainingFile = exports.findFolderContainingFile = exports.findAsyncSequential = exports.mapAsyncSequencial = exports.getPluginI18nPath = exports.getElementsAround = exports.removePrefix = exports.removeSuffix = exports.removeTrailingSlash = exports.addTrailingSlash = exports.addTrailingPathSeparator = exports.addLeadingSlash = exports.resolvePathname = exports.isValidPathname = exports.getEditUrl = exports.aliasedSitePath = exports.normalizeUrl = exports.getSubFolder = exports.idx = exports.genChunkName = exports.toMessageRelativeFilePath = exports.genComponentName = exports.upperFirst = exports.encodePath = exports.fileToPath = exports.objectWithKeySorted = exports.generate = exports.docuHash = exports.simpleHash = exports.md5Hash = exports.posixPath = void 0;
-const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const crypto_1 = require("crypto");
-const lodash_1 = require("lodash");
-const escape_string_regexp_1 = tslib_1.__importDefault(require("escape-string-regexp"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const url_1 = require("url");
-// @ts-expect-error: no typedefs :s
-const resolve_pathname_1 = tslib_1.__importDefault(require("resolve-pathname"));
-const posixPath_1 = require("./posixPath");
-const hashUtils_1 = require("./hashUtils");
-exports.posixPath = posixPath_1.posixPath;
-tslib_1.__exportStar(require("./codeTranslationsUtils"), exports);
-tslib_1.__exportStar(require("./markdownParser"), exports);
-tslib_1.__exportStar(require("./markdownLinks"), exports);
-tslib_1.__exportStar(require("./escapePath"), exports);
-var hashUtils_2 = require("./hashUtils");
-Object.defineProperty(exports, "md5Hash", { enumerable: true, get: function () { return hashUtils_2.md5Hash; } });
-Object.defineProperty(exports, "simpleHash", { enumerable: true, get: function () { return hashUtils_2.simpleHash; } });
-Object.defineProperty(exports, "docuHash", { enumerable: true, get: function () { return hashUtils_2.docuHash; } });
-const fileHash = new Map();
-async function generate(generatedFilesDir, file, content, skipCache = process.env.NODE_ENV === 'production') {
-    const filepath = path_1.default.join(generatedFilesDir, file);
-    if (skipCache) {
-        await fs_extra_1.default.ensureDir(path_1.default.dirname(filepath));
-        await fs_extra_1.default.writeFile(filepath, content);
-        return;
-    }
-    let lastHash = fileHash.get(filepath);
-    // If file already exists but its not in runtime cache yet,
-    // we try to calculate the content hash and then compare
-    // This is to avoid unnecessary overwriting and we can reuse old file.
-    if (!lastHash && fs_extra_1.default.existsSync(filepath)) {
-        const lastContent = await fs_extra_1.default.readFile(filepath, 'utf8');
-        lastHash = crypto_1.createHash('md5').update(lastContent).digest('hex');
-        fileHash.set(filepath, lastHash);
-    }
-    const currentHash = crypto_1.createHash('md5').update(content).digest('hex');
-    if (lastHash !== currentHash) {
-        await fs_extra_1.default.ensureDir(path_1.default.dirname(filepath));
-        await fs_extra_1.default.writeFile(filepath, content);
-        fileHash.set(filepath, currentHash);
-    }
-}
-exports.generate = generate;
-function objectWithKeySorted(obj) {
-    // https://github.com/lodash/lodash/issues/1459#issuecomment-460941233
-    return Object.keys(obj)
-        .sort()
-        .reduce((acc, key) => {
-        acc[key] = obj[key];
-        return acc;
-    }, {});
-}
-exports.objectWithKeySorted = objectWithKeySorted;
-const indexRE = /(^|.*\/)index\.(md|mdx|js|jsx|ts|tsx)$/i;
-const extRE = /\.(md|mdx|js|jsx|ts|tsx)$/;
-/**
- * Convert filepath to url path.
- * Example: 'index.md' -> '/', 'foo/bar.js' -> '/foo/bar',
- */
-function fileToPath(file) {
-    if (indexRE.test(file)) {
-        return file.replace(indexRE, '/$1');
-    }
-    return `/${file.replace(extRE, '').replace(/\\/g, '/')}`;
-}
-exports.fileToPath = fileToPath;
-function encodePath(userpath) {
-    return userpath
-        .split('/')
-        .map((item) => encodeURIComponent(item))
-        .join('/');
-}
-exports.encodePath = encodePath;
-/**
- * Convert first string character to the upper case.
- * E.g: docusaurus -> Docusaurus
- */
-function upperFirst(str) {
-    return str ? str.charAt(0).toUpperCase() + str.slice(1) : '';
-}
-exports.upperFirst = upperFirst;
-/**
- * Generate unique React Component Name.
- * E.g: /foo-bar -> FooBar096
- */
-function genComponentName(pagePath) {
-    if (pagePath === '/') {
-        return 'index';
-    }
-    const pageHash = hashUtils_1.docuHash(pagePath);
-    return upperFirst(lodash_1.camelCase(pageHash));
-}
-exports.genComponentName = genComponentName;
-// When you want to display a path in a message/warning/error,
-// it's more convenient to:
-// - make it relative to cwd()
-// - convert to posix (ie not using windows \ path separator)
-// This way, Jest tests can run more reliably on any computer/CI
-// on both Unix/Windows
-// For Windows users this is not perfect (as they see / instead of \) but it's probably good enough
-function toMessageRelativeFilePath(filePath) {
-    return exports.posixPath(path_1.default.relative(process.cwd(), filePath));
-}
-exports.toMessageRelativeFilePath = toMessageRelativeFilePath;
-const chunkNameCache = new Map();
-/**
- * Generate unique chunk name given a module path.
- */
-function genChunkName(modulePath, prefix, preferredName, shortId = process.env.NODE_ENV === 'production') {
-    let chunkName = chunkNameCache.get(modulePath);
-    if (!chunkName) {
-        if (shortId) {
-            chunkName = hashUtils_1.simpleHash(modulePath, 8);
-        }
-        else {
-            let str = modulePath;
-            if (preferredName) {
-                const shortHash = hashUtils_1.simpleHash(modulePath, 3);
-                str = `${preferredName}${shortHash}`;
-            }
-            const name = str === '/' ? 'index' : hashUtils_1.docuHash(str);
-            chunkName = prefix ? `${prefix}---${name}` : name;
-        }
-        chunkNameCache.set(modulePath, chunkName);
-    }
-    return chunkName;
-}
-exports.genChunkName = genChunkName;
-// Too dynamic
-// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
-function idx(target, keyPaths) {
-    return (target &&
-        keyPaths &&
-        (Array.isArray(keyPaths)
-            ? keyPaths.reduce((obj, key) => obj && obj[key], target)
-            : target[keyPaths]));
-}
-exports.idx = idx;
-/**
- * Given a filepath and dirpath, get the first directory.
- */
-function getSubFolder(file, refDir) {
-    const separator = escape_string_regexp_1.default(path_1.default.sep);
-    const baseDir = escape_string_regexp_1.default(path_1.default.basename(refDir));
-    const regexSubFolder = new RegExp(`${baseDir}${separator}(.*?)${separator}.*`);
-    const match = regexSubFolder.exec(file);
-    return match && match[1];
-}
-exports.getSubFolder = getSubFolder;
-function normalizeUrl(rawUrls) {
-    const urls = [...rawUrls];
-    const resultArray = [];
-    let hasStartingSlash = false;
-    let hasEndingSlash = false;
-    // If the first part is a plain protocol, we combine it with the next part.
-    if (urls[0].match(/^[^/:]+:\/*$/) && urls.length > 1) {
-        const first = urls.shift();
-        urls[0] = first + urls[0];
-    }
-    // There must be two or three slashes in the file protocol,
-    // two slashes in anything else.
-    const replacement = urls[0].match(/^file:\/\/\//) ? '$1:///' : '$1://';
-    urls[0] = urls[0].replace(/^([^/:]+):\/*/, replacement);
-    // eslint-disable-next-line
-    for (let i = 0; i < urls.length; i++) {
-        let component = urls[i];
-        if (typeof component !== 'string') {
-            throw new TypeError(`Url must be a string. Received ${typeof component}`);
-        }
-        if (component === '') {
-            if (i === urls.length - 1 && hasEndingSlash) {
-                resultArray.push('/');
-            }
-            // eslint-disable-next-line
-            continue;
-        }
-        if (component !== '/') {
-            if (i > 0) {
-                // Removing the starting slashes for each component but the first.
-                component = component.replace(/^[/]+/, 
-                // Special case where the first element of rawUrls is empty ["", "/hello"] => /hello
-                component[0] === '/' && !hasStartingSlash ? '/' : '');
-            }
-            hasEndingSlash = component[component.length - 1] === '/';
-            // Removing the ending slashes for each component but the last.
-            // For the last component we will combine multiple slashes to a single one.
-            component = component.replace(/[/]+$/, i < urls.length - 1 ? '' : '/');
-        }
-        hasStartingSlash = true;
-        resultArray.push(component);
-    }
-    let str = resultArray.join('/');
-    // Each input component is now separated by a single slash
-    // except the possible first plain protocol part.
-    // Remove trailing slash before parameters or hash.
-    str = str.replace(/\/(\?|&|#[^!])/g, '$1');
-    // Replace ? in parameters with &.
-    const parts = str.split('?');
-    str = parts.shift() + (parts.length > 0 ? '?' : '') + parts.join('&');
-    // Dedupe forward slashes in the entire path, avoiding protocol slashes.
-    str = str.replace(/([^:]\/)\/+/g, '$1');
-    // Dedupe forward slashes at the beginning of the path.
-    str = str.replace(/^\/+/g, '/');
-    return str;
-}
-exports.normalizeUrl = normalizeUrl;
-/**
- * Alias filepath relative to site directory, very useful so that we
- * don't expose user's site structure.
- * Example: some/path/to/website/docs/foo.md -> @site/docs/foo.md
- */
-function aliasedSitePath(filePath, siteDir) {
-    const relativePath = exports.posixPath(path_1.default.relative(siteDir, filePath));
-    // Cannot use path.join() as it resolves '../' and removes
-    // the '@site'. Let webpack loader resolve it.
-    return `@site/${relativePath}`;
-}
-exports.aliasedSitePath = aliasedSitePath;
-function getEditUrl(fileRelativePath, editUrl) {
-    return editUrl
-        ? normalizeUrl([editUrl, exports.posixPath(fileRelativePath)])
-        : undefined;
-}
-exports.getEditUrl = getEditUrl;
-function isValidPathname(str) {
-    if (!str.startsWith('/')) {
-        return false;
-    }
-    try {
-        // weird, but is there a better way?
-        const parsedPathname = new url_1.URL(str, 'https://domain.com').pathname;
-        return parsedPathname === str || parsedPathname === encodeURI(str);
-    }
-    catch (e) {
-        return false;
-    }
-}
-exports.isValidPathname = isValidPathname;
-// resolve pathname and fail fast if resolution fails
-function resolvePathname(to, from) {
-    return resolve_pathname_1.default(to, from);
-}
-exports.resolvePathname = resolvePathname;
-function addLeadingSlash(str) {
-    return str.startsWith('/') ? str : `/${str}`;
-}
-exports.addLeadingSlash = addLeadingSlash;
-function addTrailingPathSeparator(str) {
-    return str.endsWith(path_1.default.sep) ? str : `${str}${path_1.default.sep}`;
-}
-exports.addTrailingPathSeparator = addTrailingPathSeparator;
-// TODO deduplicate: also present in @docusaurus/utils-common
-function addTrailingSlash(str) {
-    return str.endsWith('/') ? str : `${str}/`;
-}
-exports.addTrailingSlash = addTrailingSlash;
-function removeTrailingSlash(str) {
-    return removeSuffix(str, '/');
-}
-exports.removeTrailingSlash = removeTrailingSlash;
-function removeSuffix(str, suffix) {
-    if (suffix === '') {
-        return str; // always returns "" otherwise!
-    }
-    return str.endsWith(suffix) ? str.slice(0, -suffix.length) : str;
-}
-exports.removeSuffix = removeSuffix;
-function removePrefix(str, prefix) {
-    return str.startsWith(prefix) ? str.slice(prefix.length) : str;
-}
-exports.removePrefix = removePrefix;
-function getElementsAround(array, aroundIndex) {
-    const min = 0;
-    const max = array.length - 1;
-    if (aroundIndex < min || aroundIndex > max) {
-        throw new Error(`Valid "aroundIndex" for array (of size ${array.length}) are between ${min} and ${max}, but you provided ${aroundIndex}.`);
-    }
-    const previous = aroundIndex === min ? undefined : array[aroundIndex - 1];
-    const next = aroundIndex === max ? undefined : array[aroundIndex + 1];
-    return { previous, next };
-}
-exports.getElementsAround = getElementsAround;
-function getPluginI18nPath({ siteDir, locale, pluginName, pluginId = 'default', // TODO duplicated constant
-subPaths = [], }) {
-    return path_1.default.join(siteDir, 'i18n', 
-    // namespace first by locale: convenient to work in a single folder for a translator
-    locale, 
-    // Make it convenient to use for single-instance
-    // ie: return "docs", not "docs-default" nor "docs/default"
-    `${pluginName}${
-    // TODO duplicate constant :(
-    pluginId === 'default' ? '' : `-${pluginId}`}`, ...subPaths);
-}
-exports.getPluginI18nPath = getPluginI18nPath;
-async function mapAsyncSequencial(array, action) {
-    const results = [];
-    // eslint-disable-next-line no-restricted-syntax
-    for (const t of array) {
-        // eslint-disable-next-line no-await-in-loop
-        const result = await action(t);
-        results.push(result);
-    }
-    return results;
-}
-exports.mapAsyncSequencial = mapAsyncSequencial;
-async function findAsyncSequential(array, predicate) {
-    // eslint-disable-next-line no-restricted-syntax
-    for (const t of array) {
-        // eslint-disable-next-line no-await-in-loop
-        if (await predicate(t)) {
-            return t;
-        }
-    }
-    return undefined;
-}
-exports.findAsyncSequential = findAsyncSequential;
-// return the  first folder path in which the file exists in
-async function findFolderContainingFile(folderPaths, relativeFilePath) {
-    return findAsyncSequential(folderPaths, (folderPath) => fs_extra_1.default.pathExists(path_1.default.join(folderPath, relativeFilePath)));
-}
-exports.findFolderContainingFile = findFolderContainingFile;
-async function getFolderContainingFile(folderPaths, relativeFilePath) {
-    const maybeFolderPath = await findFolderContainingFile(folderPaths, relativeFilePath);
-    // should never happen, as the source was read from the FS anyway...
-    if (!maybeFolderPath) {
-        throw new Error(`File "${relativeFilePath}" does not exist in any of these folders:\n- ${folderPaths.join('\n- ')}]`);
-    }
-    return maybeFolderPath;
-}
-exports.getFolderContainingFile = getFolderContainingFile;
-function reportMessage(message, reportingSeverity) {
-    switch (reportingSeverity) {
-        case 'ignore':
-            break;
-        case 'log':
-            console.log(chalk_1.default.bold.blue('info ') + chalk_1.default.blue(message));
-            break;
-        case 'warn':
-            console.warn(chalk_1.default.bold.yellow('warn ') + chalk_1.default.yellow(message));
-            break;
-        case 'error':
-            console.error(chalk_1.default.bold.red('error ') + chalk_1.default.red(message));
-            break;
-        case 'throw':
-            throw new Error(message);
-        default:
-            throw new Error(`Unexpected "reportingSeverity" value: ${reportingSeverity}.`);
-    }
-}
-exports.reportMessage = reportMessage;
-function mergeTranslations(contents) {
-    return contents.reduce((acc, content) => {
-        return { ...acc, ...content };
-    }, {});
-}
-exports.mergeTranslations = mergeTranslations;
-function getSwizzledComponent(componentPath) {
-    const swizzledComponentPath = path_1.default.resolve(process.cwd(), 'src', componentPath);
-    return fs_extra_1.default.existsSync(swizzledComponentPath)
-        ? swizzledComponentPath
-        : undefined;
-}
-exports.getSwizzledComponent = getSwizzledComponent;
-// Useful to update all the messages of a translation file
-// Used in tests to simulate translations
-function updateTranslationFileMessages(translationFile, updateMessage) {
-    return {
-        ...translationFile,
-        content: lodash_1.mapValues(translationFile.content, (translation) => ({
-            ...translation,
-            message: updateMessage(translation.message),
-        })),
-    };
-}
-exports.updateTranslationFileMessages = updateTranslationFileMessages;
-// Input: ## Some heading {#some-heading}
-// Output: {text: "## Some heading", id: "some-heading"}
-function parseMarkdownHeadingId(heading) {
-    const customHeadingIdRegex = /^(.*?)\s*\{#([\w-]+)\}$/;
-    const matches = customHeadingIdRegex.exec(heading);
-    if (matches) {
-        return {
-            text: matches[1],
-            id: matches[2],
-        };
-    }
-    else {
-        return { text: heading, id: undefined };
-    }
-}
-exports.parseMarkdownHeadingId = parseMarkdownHeadingId;
+exports.toMessageRelativeFilePath = exports.posixPath = exports.shortName = exports.isNameTooLong = exports.createSlugger = exports.replaceMarkdownLinks = exports.parseMarkdownString = exports.parseMarkdownContentTitle = exports.parseFrontMatter = exports.createExcerpt = exports.parseMarkdownHeadingId = exports.groupTaggedItems = exports.normalizeFrontMatterTags = exports.normalizeFrontMatterTag = exports.removeTrailingSlash = exports.addTrailingSlash = exports.addLeadingSlash = exports.resolvePathname = exports.isValidPathname = exports.encodePath = exports.fileToPath = exports.getEditUrl = exports.normalizeUrl = exports.reportMessage = exports.findAsyncSequential = exports.mapAsyncSequential = exports.getElementsAround = exports.removePrefix = exports.removeSuffix = exports.getPluginI18nPath = exports.updateTranslationFileMessages = exports.mergeTranslations = exports.GitNotFoundError = exports.getFileCommitDate = exports.readOutputHTMLFile = exports.genChunkName = exports.generate = exports.WEBPACK_URL_LOADER_LIMIT = exports.DEFAULT_PLUGIN_ID = exports.DEFAULT_PORT = exports.THEME_PATH = exports.OUTPUT_STATIC_ASSETS_DIR_NAME = exports.STATIC_DIR_NAME = exports.SRC_DIR_NAME = exports.GENERATED_FILES_DIR_NAME = exports.BABEL_CONFIG_FILE_NAME = exports.DEFAULT_CONFIG_FILE_NAME = exports.DEFAULT_BUILD_DIR_NAME = exports.NODE_MINOR_VERSION = exports.NODE_MAJOR_VERSION = void 0;
+exports.getFolderContainingFile = exports.findFolderContainingFile = exports.getContentPathList = exports.getDataFileData = exports.getDataFilePath = exports.getFileLoaderUtils = exports.createAbsoluteFilePathMatcher = exports.createMatcher = exports.GlobExcludeDefault = exports.Globby = exports.docuHash = exports.simpleHash = exports.md5Hash = exports.addTrailingPathSeparator = exports.escapePath = exports.aliasedSitePath = void 0;
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "NODE_MAJOR_VERSION", { enumerable: true, get: function () { return constants_1.NODE_MAJOR_VERSION; } });
+Object.defineProperty(exports, "NODE_MINOR_VERSION", { enumerable: true, get: function () { return constants_1.NODE_MINOR_VERSION; } });
+Object.defineProperty(exports, "DEFAULT_BUILD_DIR_NAME", { enumerable: true, get: function () { return constants_1.DEFAULT_BUILD_DIR_NAME; } });
+Object.defineProperty(exports, "DEFAULT_CONFIG_FILE_NAME", { enumerable: true, get: function () { return constants_1.DEFAULT_CONFIG_FILE_NAME; } });
+Object.defineProperty(exports, "BABEL_CONFIG_FILE_NAME", { enumerable: true, get: function () { return constants_1.BABEL_CONFIG_FILE_NAME; } });
+Object.defineProperty(exports, "GENERATED_FILES_DIR_NAME", { enumerable: true, get: function () { return constants_1.GENERATED_FILES_DIR_NAME; } });
+Object.defineProperty(exports, "SRC_DIR_NAME", { enumerable: true, get: function () { return constants_1.SRC_DIR_NAME; } });
+Object.defineProperty(exports, "STATIC_DIR_NAME", { enumerable: true, get: function () { return constants_1.STATIC_DIR_NAME; } });
+Object.defineProperty(exports, "OUTPUT_STATIC_ASSETS_DIR_NAME", { enumerable: true, get: function () { return constants_1.OUTPUT_STATIC_ASSETS_DIR_NAME; } });
+Object.defineProperty(exports, "THEME_PATH", { enumerable: true, get: function () { return constants_1.THEME_PATH; } });
+Object.defineProperty(exports, "DEFAULT_PORT", { enumerable: true, get: function () { return constants_1.DEFAULT_PORT; } });
+Object.defineProperty(exports, "DEFAULT_PLUGIN_ID", { enumerable: true, get: function () { return constants_1.DEFAULT_PLUGIN_ID; } });
+Object.defineProperty(exports, "WEBPACK_URL_LOADER_LIMIT", { enumerable: true, get: function () { return constants_1.WEBPACK_URL_LOADER_LIMIT; } });
+var emitUtils_1 = require("./emitUtils");
+Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return emitUtils_1.generate; } });
+Object.defineProperty(exports, "genChunkName", { enumerable: true, get: function () { return emitUtils_1.genChunkName; } });
+Object.defineProperty(exports, "readOutputHTMLFile", { enumerable: true, get: function () { return emitUtils_1.readOutputHTMLFile; } });
+var gitUtils_1 = require("./gitUtils");
+Object.defineProperty(exports, "getFileCommitDate", { enumerable: true, get: function () { return gitUtils_1.getFileCommitDate; } });
+Object.defineProperty(exports, "GitNotFoundError", { enumerable: true, get: function () { return gitUtils_1.GitNotFoundError; } });
+var i18nUtils_1 = require("./i18nUtils");
+Object.defineProperty(exports, "mergeTranslations", { enumerable: true, get: function () { return i18nUtils_1.mergeTranslations; } });
+Object.defineProperty(exports, "updateTranslationFileMessages", { enumerable: true, get: function () { return i18nUtils_1.updateTranslationFileMessages; } });
+Object.defineProperty(exports, "getPluginI18nPath", { enumerable: true, get: function () { return i18nUtils_1.getPluginI18nPath; } });
+var jsUtils_1 = require("./jsUtils");
+Object.defineProperty(exports, "removeSuffix", { enumerable: true, get: function () { return jsUtils_1.removeSuffix; } });
+Object.defineProperty(exports, "removePrefix", { enumerable: true, get: function () { return jsUtils_1.removePrefix; } });
+Object.defineProperty(exports, "getElementsAround", { enumerable: true, get: function () { return jsUtils_1.getElementsAround; } });
+Object.defineProperty(exports, "mapAsyncSequential", { enumerable: true, get: function () { return jsUtils_1.mapAsyncSequential; } });
+Object.defineProperty(exports, "findAsyncSequential", { enumerable: true, get: function () { return jsUtils_1.findAsyncSequential; } });
+Object.defineProperty(exports, "reportMessage", { enumerable: true, get: function () { return jsUtils_1.reportMessage; } });
+var urlUtils_1 = require("./urlUtils");
+Object.defineProperty(exports, "normalizeUrl", { enumerable: true, get: function () { return urlUtils_1.normalizeUrl; } });
+Object.defineProperty(exports, "getEditUrl", { enumerable: true, get: function () { return urlUtils_1.getEditUrl; } });
+Object.defineProperty(exports, "fileToPath", { enumerable: true, get: function () { return urlUtils_1.fileToPath; } });
+Object.defineProperty(exports, "encodePath", { enumerable: true, get: function () { return urlUtils_1.encodePath; } });
+Object.defineProperty(exports, "isValidPathname", { enumerable: true, get: function () { return urlUtils_1.isValidPathname; } });
+Object.defineProperty(exports, "resolvePathname", { enumerable: true, get: function () { return urlUtils_1.resolvePathname; } });
+Object.defineProperty(exports, "addLeadingSlash", { enumerable: true, get: function () { return urlUtils_1.addLeadingSlash; } });
+Object.defineProperty(exports, "addTrailingSlash", { enumerable: true, get: function () { return urlUtils_1.addTrailingSlash; } });
+Object.defineProperty(exports, "removeTrailingSlash", { enumerable: true, get: function () { return urlUtils_1.removeTrailingSlash; } });
+var tags_1 = require("./tags");
+Object.defineProperty(exports, "normalizeFrontMatterTag", { enumerable: true, get: function () { return tags_1.normalizeFrontMatterTag; } });
+Object.defineProperty(exports, "normalizeFrontMatterTags", { enumerable: true, get: function () { return tags_1.normalizeFrontMatterTags; } });
+Object.defineProperty(exports, "groupTaggedItems", { enumerable: true, get: function () { return tags_1.groupTaggedItems; } });
+var markdownParser_1 = require("./markdownParser");
+Object.defineProperty(exports, "parseMarkdownHeadingId", { enumerable: true, get: function () { return markdownParser_1.parseMarkdownHeadingId; } });
+Object.defineProperty(exports, "createExcerpt", { enumerable: true, get: function () { return markdownParser_1.createExcerpt; } });
+Object.defineProperty(exports, "parseFrontMatter", { enumerable: true, get: function () { return markdownParser_1.parseFrontMatter; } });
+Object.defineProperty(exports, "parseMarkdownContentTitle", { enumerable: true, get: function () { return markdownParser_1.parseMarkdownContentTitle; } });
+Object.defineProperty(exports, "parseMarkdownString", { enumerable: true, get: function () { return markdownParser_1.parseMarkdownString; } });
+var markdownLinks_1 = require("./markdownLinks");
+Object.defineProperty(exports, "replaceMarkdownLinks", { enumerable: true, get: function () { return markdownLinks_1.replaceMarkdownLinks; } });
+var slugger_1 = require("./slugger");
+Object.defineProperty(exports, "createSlugger", { enumerable: true, get: function () { return slugger_1.createSlugger; } });
+var pathUtils_1 = require("./pathUtils");
+Object.defineProperty(exports, "isNameTooLong", { enumerable: true, get: function () { return pathUtils_1.isNameTooLong; } });
+Object.defineProperty(exports, "shortName", { enumerable: true, get: function () { return pathUtils_1.shortName; } });
+Object.defineProperty(exports, "posixPath", { enumerable: true, get: function () { return pathUtils_1.posixPath; } });
+Object.defineProperty(exports, "toMessageRelativeFilePath", { enumerable: true, get: function () { return pathUtils_1.toMessageRelativeFilePath; } });
+Object.defineProperty(exports, "aliasedSitePath", { enumerable: true, get: function () { return pathUtils_1.aliasedSitePath; } });
+Object.defineProperty(exports, "escapePath", { enumerable: true, get: function () { return pathUtils_1.escapePath; } });
+Object.defineProperty(exports, "addTrailingPathSeparator", { enumerable: true, get: function () { return pathUtils_1.addTrailingPathSeparator; } });
+var hashUtils_1 = require("./hashUtils");
+Object.defineProperty(exports, "md5Hash", { enumerable: true, get: function () { return hashUtils_1.md5Hash; } });
+Object.defineProperty(exports, "simpleHash", { enumerable: true, get: function () { return hashUtils_1.simpleHash; } });
+Object.defineProperty(exports, "docuHash", { enumerable: true, get: function () { return hashUtils_1.docuHash; } });
+var globUtils_1 = require("./globUtils");
+Object.defineProperty(exports, "Globby", { enumerable: true, get: function () { return globUtils_1.Globby; } });
+Object.defineProperty(exports, "GlobExcludeDefault", { enumerable: true, get: function () { return globUtils_1.GlobExcludeDefault; } });
+Object.defineProperty(exports, "createMatcher", { enumerable: true, get: function () { return globUtils_1.createMatcher; } });
+Object.defineProperty(exports, "createAbsoluteFilePathMatcher", { enumerable: true, get: function () { return globUtils_1.createAbsoluteFilePathMatcher; } });
+var webpackUtils_1 = require("./webpackUtils");
+Object.defineProperty(exports, "getFileLoaderUtils", { enumerable: true, get: function () { return webpackUtils_1.getFileLoaderUtils; } });
+var dataFileUtils_1 = require("./dataFileUtils");
+Object.defineProperty(exports, "getDataFilePath", { enumerable: true, get: function () { return dataFileUtils_1.getDataFilePath; } });
+Object.defineProperty(exports, "getDataFileData", { enumerable: true, get: function () { return dataFileUtils_1.getDataFileData; } });
+Object.defineProperty(exports, "getContentPathList", { enumerable: true, get: function () { return dataFileUtils_1.getContentPathList; } });
+Object.defineProperty(exports, "findFolderContainingFile", { enumerable: true, get: function () { return dataFileUtils_1.findFolderContainingFile; } });
+Object.defineProperty(exports, "getFolderContainingFile", { enumerable: true, get: function () { return dataFileUtils_1.getFolderContainingFile; } });
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,yCAcqB;AAbnB,+GAAA,kBAAkB,OAAA;AAClB,+GAAA,kBAAkB,OAAA;AAClB,mHAAA,sBAAsB,OAAA;AACtB,qHAAA,wBAAwB,OAAA;AACxB,mHAAA,sBAAsB,OAAA;AACtB,qHAAA,wBAAwB,OAAA;AACxB,yGAAA,YAAY,OAAA;AACZ,4GAAA,eAAe,OAAA;AACf,0HAAA,6BAA6B,OAAA;AAC7B,uGAAA,UAAU,OAAA;AACV,yGAAA,YAAY,OAAA;AACZ,8GAAA,iBAAiB,OAAA;AACjB,qHAAA,wBAAwB,OAAA;AAE1B,yCAAuE;AAA/D,qGAAA,QAAQ,OAAA;AAAE,yGAAA,YAAY,OAAA;AAAE,+GAAA,kBAAkB,OAAA;AAClD,uCAA+D;AAAvD,6GAAA,iBAAiB,OAAA;AAAE,4GAAA,gBAAgB,OAAA;AAC3C,yCAIqB;AAHnB,8GAAA,iBAAiB,OAAA;AACjB,0HAAA,6BAA6B,OAAA;AAC7B,8GAAA,iBAAiB,OAAA;AAEnB,qCAOmB;AANjB,uGAAA,YAAY,OAAA;AACZ,uGAAA,YAAY,OAAA;AACZ,4GAAA,iBAAiB,OAAA;AACjB,6GAAA,kBAAkB,OAAA;AAClB,8GAAA,mBAAmB,OAAA;AACnB,wGAAA,aAAa,OAAA;AAEf,uCAUoB;AATlB,wGAAA,YAAY,OAAA;AACZ,sGAAA,UAAU,OAAA;AACV,sGAAA,UAAU,OAAA;AACV,sGAAA,UAAU,OAAA;AACV,2GAAA,eAAe,OAAA;AACf,2GAAA,eAAe,OAAA;AACf,2GAAA,eAAe,OAAA;AACf,4GAAA,gBAAgB,OAAA;AAChB,+GAAA,mBAAmB,OAAA;AAErB,+BAOgB;AAHd,+GAAA,uBAAuB,OAAA;AACvB,gHAAA,wBAAwB,OAAA;AACxB,wGAAA,gBAAgB,OAAA;AAElB,mDAM0B;AALxB,wHAAA,sBAAsB,OAAA;AACtB,+GAAA,aAAa,OAAA;AACb,kHAAA,gBAAgB,OAAA;AAChB,2HAAA,yBAAyB,OAAA;AACzB,qHAAA,mBAAmB,OAAA;AAErB,iDAMyB;AADvB,qHAAA,oBAAoB,OAAA;AAEtB,qCAA2E;AAAhC,wGAAA,aAAa,OAAA;AACxD,yCAQqB;AAPnB,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA;AACT,sGAAA,SAAS,OAAA;AACT,sHAAA,yBAAyB,OAAA;AACzB,4GAAA,eAAe,OAAA;AACf,uGAAA,UAAU,OAAA;AACV,qHAAA,wBAAwB,OAAA;AAE1B,yCAA0D;AAAlD,oGAAA,OAAO,OAAA;AAAE,uGAAA,UAAU,OAAA;AAAE,qGAAA,QAAQ,OAAA;AACrC,yCAKqB;AAJnB,mGAAA,MAAM,OAAA;AACN,+GAAA,kBAAkB,OAAA;AAClB,0GAAA,aAAa,OAAA;AACb,0HAAA,6BAA6B,OAAA;AAE/B,+CAAkD;AAA1C,kHAAA,kBAAkB,OAAA;AAC1B,iDAMyB;AALvB,gHAAA,eAAe,OAAA;AACf,gHAAA,eAAe,OAAA;AACf,mHAAA,kBAAkB,OAAA;AAClB,yHAAA,wBAAwB,OAAA;AACxB,wHAAA,uBAAuB,OAAA"}

package/lib/jsUtils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 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 type { ReportingSeverity } from '@docusaurus/types';
+export declare function removeSuffix(str: string, suffix: string): string;
+export declare function removePrefix(str: string, prefix: string): string;
+export declare function getElementsAround<T>(array: T[], aroundIndex: number): {
+    next: T | undefined;
+    previous: T | undefined;
+};
+export declare function mapAsyncSequential<T, R>(array: T[], action: (t: T) => Promise<R>): Promise<R[]>;
+export declare function findAsyncSequential<T>(array: T[], predicate: (t: T) => Promise<boolean>): Promise<T | undefined>;
+export declare function reportMessage(message: string, reportingSeverity: ReportingSeverity): void;
+//# sourceMappingURL=jsUtils.d.ts.map

package/lib/jsUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsUtils.d.ts","sourceRoot":"","sources":["../src/jsUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,mBAAmB,CAAC;AAGzD,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAKhE;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAEhE;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EACjC,KAAK,EAAE,CAAC,EAAE,EACV,WAAW,EAAE,MAAM,GAClB;IACD,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC;IACpB,QAAQ,EAAE,CAAC,GAAG,SAAS,CAAC;CACzB,CAWA;AAED,wBAAsB,kBAAkB,CAAC,CAAC,EAAE,CAAC,EAC3C,KAAK,EAAE,CAAC,EAAE,EACV,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAC3B,OAAO,CAAC,CAAC,EAAE,CAAC,CAOd;AAED,wBAAsB,mBAAmB,CAAC,CAAC,EACzC,KAAK,EAAE,CAAC,EAAE,EACV,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,GACpC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAOxB;AAED,wBAAgB,aAAa,CAC3B,OAAO,EAAE,MAAM,EACf,iBAAiB,EAAE,iBAAiB,GACnC,IAAI,CAoBN"}