@docusaurus/utils 2.0.0-beta.15d451942 → 2.0.0-beta.16

package/lib/index.js

@@ -6,23 +6,76 @@
  * 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.getFilePathForRoutePath = exports.removePrefix = exports.removeSuffix = exports.removeTrailingSlash = exports.addTrailingPathSeparator = exports.addTrailingSlash = 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.docuHash = exports.simpleHash = exports.encodePath = exports.fileToPath = exports.objectWithKeySorted = exports.generate = exports.posixPath = void 0;
+exports.genChunkName = exports.encodePath = exports.fileToPath = exports.generate = 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.escapePath = exports.aliasedSitePath = 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.getEditUrl = exports.normalizeUrl = exports.GitNotFoundError = exports.getFileCommitDate = 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.updateTranslationFileMessages = exports.mergeTranslations = exports.reportMessage = exports.findAsyncSequential = exports.mapAsyncSequential = exports.readOutputHTMLFile = exports.getPluginI18nPath = exports.getElementsAround = exports.removePrefix = exports.removeSuffix = exports.removeTrailingSlash = exports.addTrailingSlash = exports.addTrailingPathSeparator = exports.addLeadingSlash = exports.resolvePathname = exports.isValidPathname = void 0;
 const tslib_1 = require("tslib");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const path_1 = tslib_1.__importDefault(require("path"));
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const path_1 = (0, 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 lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
+const fs_extra_1 = (0, 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");
-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);
+const resolve_pathname_1 = (0, tslib_1.__importDefault)(require("resolve-pathname"));
+const hashUtils_1 = require("./hashUtils");
+const constants_1 = require("./constants");
+var constants_2 = require("./constants");
+Object.defineProperty(exports, "NODE_MAJOR_VERSION", { enumerable: true, get: function () { return constants_2.NODE_MAJOR_VERSION; } });
+Object.defineProperty(exports, "NODE_MINOR_VERSION", { enumerable: true, get: function () { return constants_2.NODE_MINOR_VERSION; } });
+Object.defineProperty(exports, "DEFAULT_BUILD_DIR_NAME", { enumerable: true, get: function () { return constants_2.DEFAULT_BUILD_DIR_NAME; } });
+Object.defineProperty(exports, "DEFAULT_CONFIG_FILE_NAME", { enumerable: true, get: function () { return constants_2.DEFAULT_CONFIG_FILE_NAME; } });
+Object.defineProperty(exports, "BABEL_CONFIG_FILE_NAME", { enumerable: true, get: function () { return constants_2.BABEL_CONFIG_FILE_NAME; } });
+Object.defineProperty(exports, "GENERATED_FILES_DIR_NAME", { enumerable: true, get: function () { return constants_2.GENERATED_FILES_DIR_NAME; } });
+Object.defineProperty(exports, "SRC_DIR_NAME", { enumerable: true, get: function () { return constants_2.SRC_DIR_NAME; } });
+Object.defineProperty(exports, "STATIC_DIR_NAME", { enumerable: true, get: function () { return constants_2.STATIC_DIR_NAME; } });
+Object.defineProperty(exports, "OUTPUT_STATIC_ASSETS_DIR_NAME", { enumerable: true, get: function () { return constants_2.OUTPUT_STATIC_ASSETS_DIR_NAME; } });
+Object.defineProperty(exports, "THEME_PATH", { enumerable: true, get: function () { return constants_2.THEME_PATH; } });
+Object.defineProperty(exports, "DEFAULT_PORT", { enumerable: true, get: function () { return constants_2.DEFAULT_PORT; } });
+Object.defineProperty(exports, "DEFAULT_PLUGIN_ID", { enumerable: true, get: function () { return constants_2.DEFAULT_PLUGIN_ID; } });
+Object.defineProperty(exports, "WEBPACK_URL_LOADER_LIMIT", { enumerable: true, get: function () { return constants_2.WEBPACK_URL_LOADER_LIMIT; } });
+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 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; } });
+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; } });
+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; } });
+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; } });
 const fileHash = new Map();
 async function generate(generatedFilesDir, file, content, skipCache = process.env.NODE_ENV === 'production') {
     const filepath = path_1.default.join(generatedFilesDir, file);
@@ -35,12 +88,12 @@ async function generate(generatedFilesDir, file, content, skipCache = process.en
     // 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)) {
+    if (!lastHash && (await fs_extra_1.default.pathExists(filepath))) {
         const lastContent = await fs_extra_1.default.readFile(filepath, 'utf8');
-        lastHash = crypto_1.createHash('md5').update(lastContent).digest('hex');
+        lastHash = (0, crypto_1.createHash)('md5').update(lastContent).digest('hex');
         fileHash.set(filepath, lastHash);
     }
-    const currentHash = crypto_1.createHash('md5').update(content).digest('hex');
+    const currentHash = (0, 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);
@@ -48,18 +101,8 @@ async function generate(generatedFilesDir, file, content, skipCache = process.en
     }
 }
 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)$/;
+const indexRE = /(?<dirname>^|.*\/)index\.(?:mdx?|jsx?|tsx?)$/i;
+const extRE = /\.(?:mdx?|jsx?|tsx?)$/;
 /**
  * Convert filepath to url path.
  * Example: 'index.md' -> '/', 'foo/bar.js' -> '/foo/bar',
@@ -71,60 +114,13 @@ function fileToPath(file) {
     return `/${file.replace(extRE, '').replace(/\\/g, '/')}`;
 }
 exports.fileToPath = fileToPath;
-function encodePath(userpath) {
-    return userpath
+function encodePath(userPath) {
+    return userPath
         .split('/')
         .map((item) => encodeURIComponent(item))
         .join('/');
 }
 exports.encodePath = encodePath;
-function simpleHash(str, length) {
-    return crypto_1.createHash('md5').update(str).digest('hex').substr(0, length);
-}
-exports.simpleHash = simpleHash;
-/**
- * Given an input string, convert to kebab-case and append a hash.
- * Avoid str collision.
- */
-function docuHash(str) {
-    if (str === '/') {
-        return 'index';
-    }
-    const shortHash = simpleHash(str, 3);
-    return `${lodash_1.kebabCase(str)}-${shortHash}`;
-}
-exports.docuHash = docuHash;
-/**
- * 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 = 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.
@@ -133,15 +129,15 @@ function genChunkName(modulePath, prefix, preferredName, shortId = process.env.N
     let chunkName = chunkNameCache.get(modulePath);
     if (!chunkName) {
         if (shortId) {
-            chunkName = simpleHash(modulePath, 8);
+            chunkName = (0, hashUtils_1.simpleHash)(modulePath, 8);
         }
         else {
             let str = modulePath;
             if (preferredName) {
-                const shortHash = simpleHash(modulePath, 3);
+                const shortHash = (0, hashUtils_1.simpleHash)(modulePath, 3);
                 str = `${preferredName}${shortHash}`;
             }
-            const name = str === '/' ? 'index' : docuHash(str);
+            const name = str === '/' ? 'index' : (0, hashUtils_1.docuHash)(str);
             chunkName = prefix ? `${prefix}---${name}` : name;
         }
         chunkNameCache.set(modulePath, chunkName);
@@ -149,102 +145,6 @@ function genChunkName(modulePath, prefix, preferredName, shortId = process.env.N
     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;
@@ -254,28 +154,32 @@ function isValidPathname(str) {
         const parsedPathname = new url_1.URL(str, 'https://domain.com').pathname;
         return parsedPathname === str || parsedPathname === encodeURI(str);
     }
-    catch (e) {
+    catch {
         return false;
     }
 }
 exports.isValidPathname = isValidPathname;
 // resolve pathname and fail fast if resolution fails
 function resolvePathname(to, from) {
-    return resolve_pathname_1.default(to, from);
+    return (0, 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
+        : // If this is Windows, we need to change the forward slash to backward
+            `${str.replace(/\/$/, '')}${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 addTrailingPathSeparator(str) {
-    return str.endsWith(path_1.default.sep) ? str : `${str}${path_1.default.sep}`;
-}
-exports.addTrailingPathSeparator = addTrailingPathSeparator;
 function removeTrailingSlash(str) {
     return removeSuffix(str, '/');
 }
@@ -291,50 +195,63 @@ function removePrefix(str, prefix) {
     return str.startsWith(prefix) ? str.slice(prefix.length) : str;
 }
 exports.removePrefix = removePrefix;
-function getFilePathForRoutePath(routePath) {
-    const fileName = path_1.default.basename(routePath);
-    const filePath = path_1.default.dirname(routePath);
-    return path_1.default.join(filePath, `${fileName}/index.html`);
-}
-exports.getFilePathForRoutePath = getFilePathForRoutePath;
 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=${aroundIndex}`);
+        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 = [], }) {
+function getPluginI18nPath({ siteDir, locale, pluginName, pluginId = constants_1.DEFAULT_PLUGIN_ID, subPaths = [], }) {
     return path_1.default.join(siteDir, 'i18n', 
-    // namespace first by locale: convenient to work in a single folder for a translator
+    // 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);
+    `${pluginName}${pluginId === constants_1.DEFAULT_PLUGIN_ID ? '' : `-${pluginId}`}`, ...subPaths);
 }
 exports.getPluginI18nPath = getPluginI18nPath;
-async function mapAsyncSequencial(array, action) {
+/**
+ * @param permalink The URL that the HTML file corresponds to, without base URL
+ * @param outDir Full path to the output directory
+ * @param trailingSlash The site config option. If provided, only one path will
+ * be read.
+ * @returns This returns a buffer, which you have to decode string yourself if
+ * needed. (Not always necessary since the output isn't for human consumption
+ * anyways, and most HTML manipulation libs accept buffers)
+ */
+async function readOutputHTMLFile(permalink, outDir, trailingSlash) {
+    const withTrailingSlashPath = path_1.default.join(outDir, permalink, 'index.html');
+    const withoutTrailingSlashPath = path_1.default.join(outDir, `${permalink.replace(/\/$/, '')}.html`);
+    if (trailingSlash) {
+        return fs_extra_1.default.readFile(withTrailingSlashPath);
+    }
+    else if (trailingSlash === false) {
+        return fs_extra_1.default.readFile(withoutTrailingSlashPath);
+    }
+    const HTMLPath = await findAsyncSequential([withTrailingSlashPath, withoutTrailingSlashPath], fs_extra_1.default.pathExists);
+    if (!HTMLPath) {
+        throw new Error(`Expected output HTML file to be found at ${withTrailingSlashPath}`);
+    }
+    return fs_extra_1.default.readFile(HTMLPath);
+}
+exports.readOutputHTMLFile = readOutputHTMLFile;
+async function mapAsyncSequential(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;
+exports.mapAsyncSequential = mapAsyncSequential;
 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;
         }
@@ -342,78 +259,40 @@ async function findAsyncSequential(array, predicate) {
     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(`relativeFilePath=[${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));
+            logger_1.default.info(message);
             break;
         case 'warn':
-            console.warn(chalk_1.default.bold.yellow('warn ') + chalk_1.default.yellow(message));
+            logger_1.default.warn(message);
             break;
         case 'error':
-            console.error(chalk_1.default.bold.red('error ') + chalk_1.default.red(message));
+            logger_1.default.error(message);
             break;
         case 'throw':
             throw new Error(message);
         default:
-            throw new Error(`unexpected reportingSeverity value: ${reportingSeverity}`);
+            throw new Error(`Unexpected "reportingSeverity" value: ${reportingSeverity}.`);
     }
 }
 exports.reportMessage = reportMessage;
 function mergeTranslations(contents) {
-    return contents.reduce((acc, content) => {
-        return { ...acc, ...content };
-    }, {});
+    return contents.reduce((acc, content) => ({ ...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) => ({
+        content: lodash_1.default.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;
+//# 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,6EAAwC;AACxC,6DAAwB;AACxB,mCAAkC;AAClC,iEAAuB;AACvB,qEAA0B;AAC1B,6BAAwB;AAOxB,qFAAqD;AAErD,2CAAiD;AACjD,2CAA8C;AAE9C,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,uCAA+D;AAAvD,6GAAA,iBAAiB,OAAA;AAAE,4GAAA,gBAAgB,OAAA;AAC3C,uCAAoD;AAA5C,wGAAA,YAAY,OAAA;AAAE,sGAAA,UAAU,OAAA;AAChC,+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,yCAOqB;AANnB,0GAAA,aAAa,OAAA;AACb,sGAAA,SAAS,OAAA;AACT,sGAAA,SAAS,OAAA;AACT,sHAAA,yBAAyB,OAAA;AACzB,4GAAA,eAAe,OAAA;AACf,uGAAA,UAAU,OAAA;AAEZ,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;AAGzB,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;AACpC,KAAK,UAAU,QAAQ,CAC5B,iBAAyB,EACzB,IAAY,EACZ,OAAe,EACf,YAAqB,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IAE1D,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;IAEpD,IAAI,SAAS,EAAE;QACb,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3C,MAAM,kBAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACtC,OAAO;KACR;IAED,IAAI,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAEtC,2DAA2D;IAC3D,wDAAwD;IACxD,sEAAsE;IACtE,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,kBAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE;QAChD,MAAM,WAAW,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACxD,QAAQ,GAAG,IAAA,mBAAU,EAAC,KAAK,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/D,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;KAClC;IAED,MAAM,WAAW,GAAG,IAAA,mBAAU,EAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEpE,IAAI,QAAQ,KAAK,WAAW,EAAE;QAC5B,MAAM,kBAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC3C,MAAM,kBAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACtC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;KACrC;AACH,CAAC;AAhCD,4BAgCC;AAED,MAAM,OAAO,GAAG,+CAA+C,CAAC;AAChE,MAAM,KAAK,GAAG,uBAAuB,CAAC;AAEtC;;;GAGG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;KACrC;IACD,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;AAC3D,CAAC;AALD,gCAKC;AAED,SAAgB,UAAU,CAAC,QAAgB;IACzC,OAAO,QAAQ;SACZ,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;SACvC,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AALD,gCAKC;AAED,MAAM,cAAc,GAAG,IAAI,GAAG,EAAE,CAAC;AACjC;;GAEG;AACH,SAAgB,YAAY,CAC1B,UAAkB,EAClB,MAAe,EACf,aAAsB,EACtB,UAAmB,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;IAExD,IAAI,SAAS,GAAuB,cAAc,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACnE,IAAI,CAAC,SAAS,EAAE;QACd,IAAI,OAAO,EAAE;YACX,SAAS,GAAG,IAAA,sBAAU,EAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SACvC;aAAM;YACL,IAAI,GAAG,GAAG,UAAU,CAAC;YACrB,IAAI,aAAa,EAAE;gBACjB,MAAM,SAAS,GAAG,IAAA,sBAAU,EAAC,UAAU,EAAE,CAAC,CAAC,CAAC;gBAC5C,GAAG,GAAG,GAAG,aAAa,GAAG,SAAS,EAAE,CAAC;aACtC;YACD,MAAM,IAAI,GAAG,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAA,oBAAQ,EAAC,GAAG,CAAC,CAAC;YACnD,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SACnD;QACD,cAAc,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;KAC3C;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAtBD,oCAsBC;AAED,SAAgB,eAAe,CAAC,GAAW;IACzC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;QACxB,OAAO,KAAK,CAAC;KACd;IACD,IAAI;QACF,oCAAoC;QACpC,MAAM,cAAc,GAAG,IAAI,SAAG,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAC,QAAQ,CAAC;QACnE,OAAO,cAAc,KAAK,GAAG,IAAI,cAAc,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC;KACpE;IAAC,MAAM;QACN,OAAO,KAAK,CAAC;KACd;AACH,CAAC;AAXD,0CAWC;AAED,qDAAqD;AACrD,SAAgB,eAAe,CAAC,EAAU,EAAE,IAAa;IACvD,OAAO,IAAA,0BAAqB,EAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AACzC,CAAC;AAFD,0CAEC;AACD,SAAgB,eAAe,CAAC,GAAW;IACzC,OAAO,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;AAC/C,CAAC;AAFD,0CAEC;AAED,SAAgB,wBAAwB,CAAC,GAAW;IAClD,OAAO,GAAG,CAAC,QAAQ,CAAC,cAAI,CAAC,GAAG,CAAC;QAC3B,CAAC,CAAC,GAAG;QACL,CAAC,CAAC,sEAAsE;YACtE,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,cAAI,CAAC,GAAG,EAAE,CAAC;AAC7C,CAAC;AALD,4DAKC;AAED,6DAA6D;AAC7D,SAAgB,gBAAgB,CAAC,GAAW;IAC1C,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC;AAC7C,CAAC;AAFD,4CAEC;AACD,SAAgB,mBAAmB,CAAC,GAAW;IAC7C,OAAO,YAAY,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAChC,CAAC;AAFD,kDAEC;AAED,SAAgB,YAAY,CAAC,GAAW,EAAE,MAAc;IACtD,IAAI,MAAM,KAAK,EAAE,EAAE;QACjB,OAAO,GAAG,CAAC,CAAC,+BAA+B;KAC5C;IACD,OAAO,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AACnE,CAAC;AALD,oCAKC;AAED,SAAgB,YAAY,CAAC,GAAW,EAAE,MAAc;IACtD,OAAO,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AACjE,CAAC;AAFD,oCAEC;AAED,SAAgB,iBAAiB,CAC/B,KAAU,EACV,WAAmB;IAKnB,MAAM,GAAG,GAAG,CAAC,CAAC;IACd,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC7B,IAAI,WAAW,GAAG,GAAG,IAAI,WAAW,GAAG,GAAG,EAAE;QAC1C,MAAM,IAAI,KAAK,CACb,0CAA0C,KAAK,CAAC,MAAM,iBAAiB,GAAG,QAAQ,GAAG,sBAAsB,WAAW,GAAG,CAC1H,CAAC;KACH;IACD,MAAM,QAAQ,GAAG,WAAW,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;IAC1E,MAAM,IAAI,GAAG,WAAW,KAAK,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC;IACtE,OAAO,EAAC,QAAQ,EAAE,IAAI,EAAC,CAAC;AAC1B,CAAC;AAjBD,8CAiBC;AAED,SAAgB,iBAAiB,CAAC,EAChC,OAAO,EACP,MAAM,EACN,UAAU,EACV,QAAQ,GAAG,6BAAiB,EAC5B,QAAQ,GAAG,EAAE,GAOd;IACC,OAAO,cAAI,CAAC,IAAI,CACd,OAAO,EACP,MAAM;IACN,yEAAyE;IACzE,aAAa;IACb,MAAM;IACN,gDAAgD;IAChD,2DAA2D;IAC3D,GAAG,UAAU,GAAG,QAAQ,KAAK,6BAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,EAAE,EACtE,GAAG,QAAQ,CACZ,CAAC;AACJ,CAAC;AAxBD,8CAwBC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,kBAAkB,CACtC,SAAiB,EACjB,MAAc,EACd,aAAkC;IAElC,MAAM,qBAAqB,GAAG,cAAI,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,CAAC;IACzE,MAAM,wBAAwB,GAAG,cAAI,CAAC,IAAI,CACxC,MAAM,EACN,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CACvC,CAAC;IACF,IAAI,aAAa,EAAE;QACjB,OAAO,kBAAE,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;KAC3C;SAAM,IAAI,aAAa,KAAK,KAAK,EAAE;QAClC,OAAO,kBAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC,CAAC;KAC9C;IACD,MAAM,QAAQ,GAAG,MAAM,mBAAmB,CACxC,CAAC,qBAAqB,EAAE,wBAAwB,CAAC,EACjD,kBAAE,CAAC,UAAU,CACd,CAAC;IACF,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CACb,4CAA4C,qBAAqB,EAAE,CACpE,CAAC;KACH;IACD,OAAO,kBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC/B,CAAC;AAzBD,gDAyBC;AAEM,KAAK,UAAU,kBAAkB,CACtC,KAAU,EACV,MAA4B;IAE5B,MAAM,OAAO,GAAQ,EAAE,CAAC;IACxB,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;QACrB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,CAAC,CAAC,CAAC;QAC/B,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KACtB;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAVD,gDAUC;AAEM,KAAK,UAAU,mBAAmB,CACvC,KAAU,EACV,SAAqC;IAErC,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;QACrB,IAAI,MAAM,SAAS,CAAC,CAAC,CAAC,EAAE;YACtB,OAAO,CAAC,CAAC;SACV;KACF;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAVD,kDAUC;AAED,SAAgB,aAAa,CAC3B,OAAe,EACf,iBAAoC;IAEpC,QAAQ,iBAAiB,EAAE;QACzB,KAAK,QAAQ;YACX,MAAM;QACR,KAAK,KAAK;YACR,gBAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,MAAM;QACR,KAAK,MAAM;YACT,gBAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,MAAM;QACR,KAAK,OAAO;YACV,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACtB,MAAM;QACR,KAAK,OAAO;YACV,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B;YACE,MAAM,IAAI,KAAK,CACb,yCAAyC,iBAAiB,GAAG,CAC9D,CAAC;KACL;AACH,CAAC;AAvBD,sCAuBC;AAED,SAAgB,iBAAiB,CAC/B,QAAkC;IAElC,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,EAAC,GAAG,GAAG,EAAE,GAAG,OAAO,EAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACvE,CAAC;AAJD,8CAIC;AAED,0DAA0D;AAC1D,yCAAyC;AACzC,SAAgB,6BAA6B,CAC3C,eAAgC,EAChC,aAA0C;IAE1C,OAAO;QACL,GAAG,eAAe;QAClB,OAAO,EAAE,gBAAC,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;YAC9D,GAAG,WAAW;YACd,OAAO,EAAE,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC;SAC5C,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC;AAXD,sEAWC"}

package/lib/markdownLinks.d.ts

@@ -25,3 +25,4 @@ export declare type ReplaceMarkdownLinksReturn<T extends ContentPaths> = {
     brokenMarkdownLinks: BrokenMarkdownLink<T>[];
 };
 export declare function replaceMarkdownLinks<T extends ContentPaths>({ siteDir, fileString, filePath, contentPaths, sourceToPermalink, }: ReplaceMarkdownLinksParams<T>): ReplaceMarkdownLinksReturn<T>;
+//# sourceMappingURL=markdownLinks.d.ts.map

package/lib/markdownLinks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdownLinks.d.ts","sourceRoot":"","sources":["../src/markdownLinks.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,oBAAY,YAAY,GAAG;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,oBAAY,kBAAkB,CAAC,CAAC,SAAS,YAAY,IAAI;IACvD,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,CAAC,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,oBAAY,0BAA0B,CAAC,CAAC,SAAS,YAAY,IAAI;IAC/D,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,CAAC,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC3C,CAAC;AAEF,oBAAY,0BAA0B,CAAC,CAAC,SAAS,YAAY,IAAI;IAC/D,UAAU,EAAE,MAAM,CAAC;IACnB,mBAAmB,EAAE,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC;CAC9C,CAAC;AAEF,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,YAAY,EAAE,EAC3D,OAAO,EACP,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,iBAAiB,GAClB,EAAE,0BAA0B,CAAC,CAAC,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,CA0E/D"}

package/lib/markdownLinks.js

@@ -7,35 +7,59 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.replaceMarkdownLinks = void 0;
-const url_1 = require("url");
-const index_1 = require("./index");
+const tslib_1 = require("tslib");
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const pathUtils_1 = require("./pathUtils");
 function replaceMarkdownLinks({ siteDir, fileString, filePath, contentPaths, sourceToPermalink, }) {
     const { contentPath, contentPathLocalized } = contentPaths;
     const brokenMarkdownLinks = [];
     // Replace internal markdown linking (except in fenced blocks).
     let fencedBlock = false;
+    let lastCodeFence = '';
     const lines = fileString.split('\n').map((line) => {
         if (line.trim().startsWith('```')) {
-            fencedBlock = !fencedBlock;
+            if (!fencedBlock) {
+                fencedBlock = true;
+                [lastCodeFence] = line.trim().match(/^`+/);
+                // If we are in a ````-fenced block, all ``` would be plain text instead
+                // of fences
+            }
+            else if (line.trim().match(/^`+/)[0].length >= lastCodeFence.length) {
+                fencedBlock = false;
+            }
         }
         if (fencedBlock) {
             return line;
         }
         let modifiedLine = line;
         // Replace inline-style links or reference-style links e.g:
-        // This is [Document 1](doc1.md) -> we replace this doc1.md with correct link
+        // This is [Document 1](doc1.md) -> we replace this doc1.md with correct
+        // ink
         // [doc1]: doc1.md -> we replace this doc1.md with correct link
-        const mdRegex = /(?:(?:\]\()|(?:\]:\s?))(?!https)([^'")\]\s>]+\.mdx?)/g;
+        const mdRegex = /(?:(?:\]\()|(?:\]:\s*))(?!https?:\/\/|@site\/)(?<filename>[^'")\]\s>]+\.mdx?)/g;
         let mdMatch = mdRegex.exec(modifiedLine);
         while (mdMatch !== null) {
             // Replace it to correct html link.
-            const mdLink = mdMatch[1];
-            const aliasedSource = (source) => index_1.aliasedSitePath(source, siteDir);
-            const permalink = sourceToPermalink[aliasedSource(url_1.resolve(filePath, mdLink))] ||
-                sourceToPermalink[aliasedSource(`${contentPathLocalized}/${mdLink}`)] ||
-                sourceToPermalink[aliasedSource(`${contentPath}/${mdLink}`)];
+            const mdLink = mdMatch.groups.filename;
+            const sourcesToTry = [
+                path_1.default.resolve(path_1.default.dirname(filePath), decodeURIComponent(mdLink)),
+                `${contentPathLocalized}/${decodeURIComponent(mdLink)}`,
+                `${contentPath}/${decodeURIComponent(mdLink)}`,
+            ];
+            const aliasedSourceMatch = sourcesToTry
+                .map((source) => (0, pathUtils_1.aliasedSitePath)(source, siteDir))
+                .find((source) => sourceToPermalink[source]);
+            const permalink = aliasedSourceMatch
+                ? sourceToPermalink[aliasedSourceMatch]
+                : undefined;
             if (permalink) {
-                modifiedLine = modifiedLine.replace(mdLink, permalink);
+                // MDX won't be happy if the permalink contains a space, we need to
+                // convert it to %20
+                const encodedPermalink = permalink
+                    .split('/')
+                    .map((part) => part.replace(/\s/g, '%20'))
+                    .join('/');
+                modifiedLine = modifiedLine.replace(mdLink, encodedPermalink);
             }
             else {
                 const brokenMarkdownLink = {
@@ -53,3 +77,4 @@ function replaceMarkdownLinks({ siteDir, fileString, filePath, contentPaths, sou
     return { newContent, brokenMarkdownLinks };
 }
 exports.replaceMarkdownLinks = replaceMarkdownLinks;
+//# sourceMappingURL=markdownLinks.js.map

package/lib/markdownLinks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdownLinks.js","sourceRoot":"","sources":["../src/markdownLinks.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,6DAAwB;AACxB,2CAA4C;AA0B5C,SAAgB,oBAAoB,CAAyB,EAC3D,OAAO,EACP,UAAU,EACV,QAAQ,EACR,YAAY,EACZ,iBAAiB,GACa;IAC9B,MAAM,EAAC,WAAW,EAAE,oBAAoB,EAAC,GAAG,YAAY,CAAC;IAEzD,MAAM,mBAAmB,GAA4B,EAAE,CAAC;IAExD,+DAA+D;IAC/D,IAAI,WAAW,GAAG,KAAK,CAAC;IACxB,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAChD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YACjC,IAAI,CAAC,WAAW,EAAE;gBAChB,WAAW,GAAG,IAAI,CAAC;gBACnB,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAE,CAAC;gBAC5C,wEAAwE;gBACxE,YAAY;aACb;iBAAM,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,EAAE;gBACtE,WAAW,GAAG,KAAK,CAAC;aACrB;SACF;QACD,IAAI,WAAW,EAAE;YACf,OAAO,IAAI,CAAC;SACb;QAED,IAAI,YAAY,GAAG,IAAI,CAAC;QACxB,2DAA2D;QAC3D,wEAAwE;QACxE,MAAM;QACN,+DAA+D;QAC/D,MAAM,OAAO,GACX,gFAAgF,CAAC;QACnF,IAAI,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACzC,OAAO,OAAO,KAAK,IAAI,EAAE;YACvB,mCAAmC;YACnC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAO,CAAC,QAAQ,CAAC;YAExC,MAAM,YAAY,GAAG;gBACnB,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC;gBAChE,GAAG,oBAAoB,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE;gBACvD,GAAG,WAAW,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE;aAC/C,CAAC;YAEF,MAAM,kBAAkB,GAAG,YAAY;iBACpC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,2BAAe,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;iBACjD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;YAE/C,MAAM,SAAS,GAAuB,kBAAkB;gBACtD,CAAC,CAAC,iBAAiB,CAAC,kBAAkB,CAAC;gBACvC,CAAC,CAAC,SAAS,CAAC;YAEd,IAAI,SAAS,EAAE;gBACb,mEAAmE;gBACnE,oBAAoB;gBACpB,MAAM,gBAAgB,GAAG,SAAS;qBAC/B,KAAK,CAAC,GAAG,CAAC;qBACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;qBACzC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACb,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;aAC/D;iBAAM;gBACL,MAAM,kBAAkB,GAA0B;oBAChD,YAAY;oBACZ,QAAQ;oBACR,IAAI,EAAE,MAAM;iBACb,CAAC;gBAEF,mBAAmB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;aAC9C;YACD,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SACtC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEpC,OAAO,EAAC,UAAU,EAAE,mBAAmB,EAAC,CAAC;AAC3C,CAAC;AAhFD,oDAgFC"}