@docusaurus/utils 2.0.0-beta.17 → 2.0.0-beta.18

package/src/urlUtils.ts

@@ -8,6 +8,18 @@
 import {removeSuffix} from './jsUtils';
 import resolvePathnameUnsafe from 'resolve-pathname';
 
+/**
+ * Much like `path.join`, but much better. Takes an array of URL segments, and
+ * joins them into a reasonable URL.
+ *
+ * - `["file:", "/home", "/user/", "website"]` => `file:///home/user/website`
+ * - `["file://", "home", "/user/", "website"]` => `file://home/user/website` (relative!)
+ * - Remove trailing slash before parameters or hash.
+ * - Replace `?` in query parameters with `&`.
+ * - Dedupe forward slashes in the entire path, avoiding protocol slashes.
+ *
+ * @throws {TypeError} If any of the URL segment is not a string, this throws.
+ */
 export function normalizeUrl(rawUrls: string[]): string {
   const urls = [...rawUrls];
   const resultArray = [];
@@ -15,10 +27,17 @@ export function normalizeUrl(rawUrls: string[]): string {
   let hasStartingSlash = false;
   let hasEndingSlash = false;
 
+  const isNonEmptyArray = (arr: string[]): arr is [string, ...string[]] =>
+    arr.length > 0;
+
+  if (!isNonEmptyArray(urls)) {
+    return '';
+  }
+
   // 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();
-    if (first!.startsWith('file:') && urls[0].startsWith('/')) {
+    const first = urls.shift()!;
+    if (first.startsWith('file:') && urls[0].startsWith('/')) {
       // Force a double slash here, else we lose the information that the next
       // segment is an absolute path
       urls[0] = `${first}//${urls[0]}`;
@@ -43,7 +62,6 @@ export function normalizeUrl(rawUrls: string[]): string {
       if (i === urls.length - 1 && hasEndingSlash) {
         resultArray.push('/');
       }
-      // eslint-disable-next-line no-continue
       continue;
     }
 
@@ -51,7 +69,7 @@ export function normalizeUrl(rawUrls: string[]): string {
       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 ? '/' : '',
@@ -61,7 +79,7 @@ export function normalizeUrl(rawUrls: string[]): string {
       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 ? '' : '/');
+      component = component.replace(/\/+$/, i < urls.length - 1 ? '' : '/');
     }
 
     hasStartingSlash = true;
@@ -69,8 +87,8 @@ export function normalizeUrl(rawUrls: string[]): string {
   }
 
   let str = resultArray.join('/');
-  // Each input component is now separated by a single slash
-  // except the possible first plain protocol part.
+  // 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(/\/(?<search>\?|&|#[^!])/g, '$1');
@@ -88,6 +106,11 @@ export function normalizeUrl(rawUrls: string[]): string {
   return str;
 }
 
+/**
+ * Takes a file's path, relative to its content folder, and computes its edit
+ * URL. If `editUrl` is `undefined`, this returns `undefined`, as is the case
+ * when the user doesn't want an edit URL in her config.
+ */
 export function getEditUrl(
   fileRelativePath: string,
   editUrl?: string,
@@ -99,8 +122,8 @@ export function getEditUrl(
 }
 
 /**
- * Convert filepath to url path.
- * Example: 'index.md' -> '/', 'foo/bar.js' -> '/foo/bar',
+ * Converts file path to a reasonable URL path, e.g. `'index.md'` -> `'/'`,
+ * `'foo/bar.js'` -> `'/foo/bar'`
  */
 export function fileToPath(file: string): string {
   const indexRE = /(?<dirname>^|.*\/)index\.(?:mdx?|jsx?|tsx?)$/i;
@@ -112,6 +135,13 @@ export function fileToPath(file: string): string {
   return `/${file.replace(extRE, '').replace(/\\/g, '/')}`;
 }
 
+/**
+ * Similar to `encodeURI`, but uses `encodeURIComponent` and assumes there's no
+ * query.
+ *
+ * `encodeURI("/question?/answer")` => `"/question?/answer#section"`;
+ * `encodePath("/question?/answer#section")` => `"/question%3F/answer%23foo"`
+ */
 export function encodePath(userPath: string): string {
   return userPath
     .split('/')
@@ -119,6 +149,10 @@ export function encodePath(userPath: string): string {
     .join('/');
 }
 
+/**
+ * Whether `str` is a valid pathname. It must be absolute, and not contain
+ * special characters.
+ */
 export function isValidPathname(str: string): boolean {
   if (!str.startsWith('/')) {
     return false;
@@ -132,18 +166,70 @@ export function isValidPathname(str: string): boolean {
   }
 }
 
-// resolve pathname and fail fast if resolution fails
+/**
+ * Resolve pathnames and fail-fast if resolution fails. Uses standard URL
+ * semantics (provided by `resolve-pathname` which is used internally by React
+ * router)
+ */
 export function resolvePathname(to: string, from?: string): string {
   return resolvePathnameUnsafe(to, from);
 }
+/** Appends a leading slash to `str`, if one doesn't exist. */
 export function addLeadingSlash(str: string): string {
   return str.startsWith('/') ? str : `/${str}`;
 }
 
 // TODO deduplicate: also present in @docusaurus/utils-common
+/** Appends a trailing slash to `str`, if one doesn't exist. */
 export function addTrailingSlash(str: string): string {
   return str.endsWith('/') ? str : `${str}/`;
 }
+
+/** Removes the trailing slash from `str`. */
 export function removeTrailingSlash(str: string): string {
   return removeSuffix(str, '/');
 }
+
+/** Constructs an SSH URL that can be used to push to GitHub. */
+export function buildSshUrl(
+  githubHost: string,
+  organizationName: string,
+  projectName: string,
+  githubPort?: string,
+): string {
+  if (githubPort) {
+    return `ssh://git@${githubHost}:${githubPort}/${organizationName}/${projectName}.git`;
+  }
+  return `git@${githubHost}:${organizationName}/${projectName}.git`;
+}
+
+/** Constructs an HTTP URL that can be used to push to GitHub. */
+export function buildHttpsUrl(
+  gitCredentials: string,
+  githubHost: string,
+  organizationName: string,
+  projectName: string,
+  githubPort?: string,
+): string {
+  if (githubPort) {
+    return `https://${gitCredentials}@${githubHost}:${githubPort}/${organizationName}/${projectName}.git`;
+  }
+  return `https://${gitCredentials}@${githubHost}/${organizationName}/${projectName}.git`;
+}
+
+/**
+ * Whether the current URL is an SSH protocol. In addition to looking for
+ * `ssh:`, it will also allow protocol-less URLs like
+ * `git@github.com:facebook/docusaurus.git`.
+ */
+export function hasSSHProtocol(sourceRepoUrl: string): boolean {
+  try {
+    if (new URL(sourceRepoUrl).protocol === 'ssh:') {
+      return true;
+    }
+    return false;
+  } catch {
+    // Fails when there isn't a protocol
+    return /^(?:[\w-]+@)?[\w.-]+:[\w./-]+/.test(sourceRepoUrl);
+  }
+}

package/src/webpackUtils.ts

@@ -31,7 +31,11 @@ type FileLoaderUtils = {
   };
 };
 
-// Inspired by https://github.com/gatsbyjs/gatsby/blob/8e6e021014da310b9cc7d02e58c9b3efe938c665/packages/gatsby/src/utils/webpack-utils.ts#L447
+/**
+ * Returns unified loader configurations to be used for various file types.
+ *
+ * Inspired by https://github.com/gatsbyjs/gatsby/blob/8e6e021014da310b9cc7d02e58c9b3efe938c665/packages/gatsby/src/utils/webpack-utils.ts#L447
+ */
 export function getFileLoaderUtils(): FileLoaderUtils {
   // files/images < urlLoaderLimit will be inlined as base64 strings directly in
   // the html
@@ -39,7 +43,11 @@ export function getFileLoaderUtils(): FileLoaderUtils {
 
   // defines the path/pattern of the assets handled by webpack
   const fileLoaderFileName = (folder: AssetFolder) =>
-    `${OUTPUT_STATIC_ASSETS_DIR_NAME}/${folder}/[name]-[contenthash].[ext]`;
+    path.posix.join(
+      OUTPUT_STATIC_ASSETS_DIR_NAME,
+      folder,
+      '[name]-[contenthash].[ext]',
+    );
 
   const loaders: FileLoaderUtils['loaders'] = {
     file: (options: {folder: AssetFolder}) => ({

package/lib/markdownParser.d.ts

@@ -1,32 +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 parseMarkdownHeadingId(heading: string): {
-    text: string;
-    id?: string;
-};
-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?: {
-    removeContentTitle?: 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?: {
-    removeContentTitle?: boolean;
-}): ParsedMarkdown;
-export {};
-//# sourceMappingURL=markdownParser.d.ts.map

package/lib/markdownParser.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"markdownParser.d.ts","sourceRoot":"","sources":["../src/markdownParser.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAOH,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,MAAM,GAAG;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,CAAC,EAAE,MAAM,CAAC;CACb,CAUA;AAKD,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAyEpE;AAED,wBAAgB,gBAAgB,CAAC,mBAAmB,EAAE,MAAM,GAAG;IAC7D,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;CACjB,CAMA;AAcD,wBAAgB,yBAAyB,CACvC,gBAAgB,EAAE,MAAM,EACxB,OAAO,CAAC,EAAE;IAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAAC,GACvC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAA;CAAC,CAkCrD;AAED,aAAK,cAAc,GAAG;IACpB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,wBAAgB,mBAAmB,CACjC,mBAAmB,EAAE,MAAM,EAC3B,OAAO,CAAC,EAAE;IAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAAC,GACvC,cAAc,CAuBhB"}

package/lib/markdownParser.js

@@ -1,160 +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.parseMarkdownString = exports.parseMarkdownContentTitle = exports.parseFrontMatter = exports.createExcerpt = exports.parseMarkdownHeadingId = void 0;
-const tslib_1 = require("tslib");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const gray_matter_1 = tslib_1.__importDefault(require("gray-matter"));
-// Input: ## Some heading {#some-heading}
-// Output: {text: "## Some heading", id: "some-heading"}
-function parseMarkdownHeadingId(heading) {
-    const customHeadingIdRegex = /^(?<text>.*?)\s*\{#(?<id>[\w-]+)\}$/;
-    const matches = customHeadingIdRegex.exec(heading);
-    if (matches) {
-        return {
-            text: matches.groups.text,
-            id: matches.groups.id,
-        };
-    }
-    return { text: heading, id: undefined };
-}
-exports.parseMarkdownHeadingId = parseMarkdownHeadingId;
-// 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');
-    let inCode = false;
-    let lastCodeFence = '';
-    /* eslint-disable no-continue */
-    for (const fileLine of fileLines) {
-        // Skip empty line.
-        if (!fileLine.trim()) {
-            continue;
-        }
-        // Skip import/export declaration.
-        if (/^(?:import|export)\s.*/.test(fileLine)) {
-            continue;
-        }
-        // Skip code block line.
-        if (fileLine.trim().startsWith('```')) {
-            if (!inCode) {
-                inCode = true;
-                [lastCodeFence] = fileLine.trim().match(/^`+/);
-                // If we are in a ````-fenced block, all ``` would be plain text instead
-                // of fences
-            }
-            else if (fileLine.trim().match(/^`+/)[0].length >= lastCodeFence.length) {
-                inCode = false;
-            }
-            continue;
-        }
-        else if (inCode) {
-            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*(?<text>[^#]*)\s*(?:#{1,6})?/gm, '$1')
-            // Remove emphasis.
-            .replace(/(?<opening>[*_]{1,3})(?<text>.*?)\1/g, '$2')
-            // Remove strikethroughs.
-            .replace(/~~(?<text>\S.*\S)~~/g, '$1')
-            // Remove images.
-            .replace(/!\[(?<alt>.*?)\][[(].*?[\])]/g, '$1')
-            // Remove footnotes.
-            .replace(/\[\^.+?\](?:: .*?$)?/g, '')
-            // Remove inline links.
-            .replace(/\[(?<alt>.*?)\][[(].*?[\])]/g, '$1')
-            // Remove inline code.
-            .replace(/`(?<text>.+?)`/g, '$1')
-            // Remove blockquotes.
-            .replace(/^\s{0,3}>\s?/g, '')
-            // Remove admonition definition.
-            .replace(/:::.*/, '')
-            // Remove Emoji names within colons include preceding whitespace.
-            .replace(/\s?:(?:::|[^:\n])+:/g, '')
-            // Remove custom Markdown heading id.
-            .replace(/{#*[\w-]+}/, '')
-            .trim();
-        if (cleanedLine) {
-            return cleanedLine;
-        }
-    }
-    return undefined;
-}
-exports.createExcerpt = createExcerpt;
-function parseFrontMatter(markdownFileContent) {
-    const { data, content } = (0, gray_matter_1.default)(markdownFileContent);
-    return {
-        frontMatter: data,
-        content: content.trim(),
-    };
-}
-exports.parseFrontMatter = parseFrontMatter;
-/**
- * Try to convert markdown heading to text. Does not need to be perfect, it is
- * only used as a fallback when frontMatter.title is not provided. For now, we
- * just unwrap possible inline code blocks (# `config.js`)
- */
-function toTextContentTitle(contentTitle) {
-    if (contentTitle.startsWith('`') && contentTitle.endsWith('`')) {
-        return contentTitle.substring(1, contentTitle.length - 1);
-    }
-    return contentTitle;
-}
-function parseMarkdownContentTitle(contentUntrimmed, options) {
-    const removeContentTitleOption = options?.removeContentTitle ?? false;
-    const content = contentUntrimmed.trim();
-    const IMPORT_STATEMENT = /import\s+(?:[\w*{}\s\n,]+from\s+)?["'\s][@\w/_.-]+["'\s];?|\n/.source;
-    const REGULAR_TITLE = /(?<pattern>#\s*(?<title>[^#\n{]*)+[ \t]*(?<suffix>(?:{#*[\w-]+})|#)?\n*?)/
-        .source;
-    const ALTERNATE_TITLE = /(?<pattern>\s*(?<title>[^\n]*)\s*\n[=]+)/.source;
-    const regularTitleMatch = new RegExp(`^(?:${IMPORT_STATEMENT})*?${REGULAR_TITLE}`, 'g').exec(content);
-    const alternateTitleMatch = new RegExp(`^(?:${IMPORT_STATEMENT})*?${ALTERNATE_TITLE}`, 'g').exec(content);
-    const titleMatch = regularTitleMatch ?? alternateTitleMatch;
-    const { pattern, title } = titleMatch?.groups ?? {};
-    if (!pattern || !title) {
-        return { content, contentTitle: undefined };
-    }
-    const newContent = removeContentTitleOption
-        ? content.replace(pattern, '')
-        : content;
-    return {
-        content: newContent.trim(),
-        contentTitle: toTextContentTitle(title.trim()).trim(),
-    };
-}
-exports.parseMarkdownContentTitle = parseMarkdownContentTitle;
-function parseMarkdownString(markdownFileContent, options) {
-    try {
-        const { frontMatter, content: contentWithoutFrontMatter } = parseFrontMatter(markdownFileContent);
-        const { content, contentTitle } = parseMarkdownContentTitle(contentWithoutFrontMatter, options);
-        const excerpt = createExcerpt(content);
-        return {
-            frontMatter,
-            content,
-            contentTitle,
-            excerpt,
-        };
-    }
-    catch (err) {
-        logger_1.default.error(`Error while parsing Markdown front matter.
-This can happen if you use special characters in front matter values (try using double quotes around that value).`);
-        throw err;
-    }
-}
-exports.parseMarkdownString = parseMarkdownString;
-//# sourceMappingURL=markdownParser.js.map

package/lib/markdownParser.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"markdownParser.js","sourceRoot":"","sources":["../src/markdownParser.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;AAEH,wEAAwC;AACxC,sEAAiC;AAEjC,yCAAyC;AACzC,wDAAwD;AACxD,SAAgB,sBAAsB,CAAC,OAAe;IAIpD,MAAM,oBAAoB,GAAG,qCAAqC,CAAC;IACnE,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACnD,IAAI,OAAO,EAAE;QACX,OAAO;YACL,IAAI,EAAE,OAAO,CAAC,MAAO,CAAC,IAAI;YAC1B,EAAE,EAAE,OAAO,CAAC,MAAO,CAAC,EAAE;SACvB,CAAC;KACH;IACD,OAAO,EAAC,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAC,CAAC;AACxC,CAAC;AAbD,wDAaC;AAED,gEAAgE;AAChE,gFAAgF;AAChF,wDAAwD;AACxD,SAAgB,aAAa,CAAC,UAAkB;IAC9C,MAAM,SAAS,GAAG,UAAU;SACzB,QAAQ,EAAE;QACX,kCAAkC;SACjC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC;SAC7B,KAAK,CAAC,IAAI,CAAC,CAAC;IACf,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,aAAa,GAAG,EAAE,CAAC;IAEvB,gCAAgC;IAChC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;QAChC,mBAAmB;QACnB,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE;YACpB,SAAS;SACV;QAED,kCAAkC;QAClC,IAAI,wBAAwB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAC3C,SAAS;SACV;QAED,wBAAwB;QACxB,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;YACrC,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,GAAG,IAAI,CAAC;gBACd,CAAC,aAAa,CAAC,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAE,CAAC;gBAChD,wEAAwE;gBACxE,YAAY;aACb;iBAAM,IACL,QAAQ,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,aAAa,CAAC,MAAM,EAC/D;gBACA,MAAM,GAAG,KAAK,CAAC;aAChB;YACD,SAAS;SACV;aAAM,IAAI,MAAM,EAAE;YACjB,SAAS;SACV;QAED,MAAM,WAAW,GAAG,QAAQ;YAC1B,oBAAoB;aACnB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;YACxB,uBAAuB;aACtB,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC;YACjC,sCAAsC;aACrC,OAAO,CAAC,0CAA0C,EAAE,IAAI,CAAC;YAC1D,mBAAmB;aAClB,OAAO,CAAC,sCAAsC,EAAE,IAAI,CAAC;YACtD,yBAAyB;aACxB,OAAO,CAAC,sBAAsB,EAAE,IAAI,CAAC;YACtC,iBAAiB;aAChB,OAAO,CAAC,+BAA+B,EAAE,IAAI,CAAC;YAC/C,oBAAoB;aACnB,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC;YACrC,uBAAuB;aACtB,OAAO,CAAC,8BAA8B,EAAE,IAAI,CAAC;YAC9C,sBAAsB;aACrB,OAAO,CAAC,iBAAiB,EAAE,IAAI,CAAC;YACjC,sBAAsB;aACrB,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;YAC7B,gCAAgC;aAC/B,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YACrB,iEAAiE;aAChE,OAAO,CAAC,sBAAsB,EAAE,EAAE,CAAC;YACpC,qCAAqC;aACpC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;aACzB,IAAI,EAAE,CAAC;QAEV,IAAI,WAAW,EAAE;YACf,OAAO,WAAW,CAAC;SACpB;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAzED,sCAyEC;AAED,SAAgB,gBAAgB,CAAC,mBAA2B;IAI1D,MAAM,EAAC,IAAI,EAAE,OAAO,EAAC,GAAG,IAAA,qBAAM,EAAC,mBAAmB,CAAC,CAAC;IACpD,OAAO;QACL,WAAW,EAAE,IAAI;QACjB,OAAO,EAAE,OAAO,CAAC,IAAI,EAAE;KACxB,CAAC;AACJ,CAAC;AATD,4CASC;AAED;;;;GAIG;AACH,SAAS,kBAAkB,CAAC,YAAoB;IAC9C,IAAI,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAC9D,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;KAC3D;IACD,OAAO,YAAY,CAAC;AACtB,CAAC;AAED,SAAgB,yBAAyB,CACvC,gBAAwB,EACxB,OAAwC;IAExC,MAAM,wBAAwB,GAAG,OAAO,EAAE,kBAAkB,IAAI,KAAK,CAAC;IAEtE,MAAM,OAAO,GAAG,gBAAgB,CAAC,IAAI,EAAE,CAAC;IAExC,MAAM,gBAAgB,GACpB,+DAA+D,CAAC,MAAM,CAAC;IACzE,MAAM,aAAa,GACjB,2EAA2E;SACxE,MAAM,CAAC;IACZ,MAAM,eAAe,GAAG,0CAA0C,CAAC,MAAM,CAAC;IAE1E,MAAM,iBAAiB,GAAG,IAAI,MAAM,CAClC,OAAO,gBAAgB,MAAM,aAAa,EAAE,EAC5C,GAAG,CACJ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChB,MAAM,mBAAmB,GAAG,IAAI,MAAM,CACpC,OAAO,gBAAgB,MAAM,eAAe,EAAE,EAC9C,GAAG,CACJ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAEhB,MAAM,UAAU,GAAG,iBAAiB,IAAI,mBAAmB,CAAC;IAC5D,MAAM,EAAC,OAAO,EAAE,KAAK,EAAC,GAAG,UAAU,EAAE,MAAM,IAAI,EAAE,CAAC;IAElD,IAAI,CAAC,OAAO,IAAI,CAAC,KAAK,EAAE;QACtB,OAAO,EAAC,OAAO,EAAE,YAAY,EAAE,SAAS,EAAC,CAAC;KAC3C;IACD,MAAM,UAAU,GAAG,wBAAwB;QACzC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;QAC9B,CAAC,CAAC,OAAO,CAAC;IACZ,OAAO;QACL,OAAO,EAAE,UAAU,CAAC,IAAI,EAAE;QAC1B,YAAY,EAAE,kBAAkB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;KACtD,CAAC;AACJ,CAAC;AArCD,8DAqCC;AASD,SAAgB,mBAAmB,CACjC,mBAA2B,EAC3B,OAAwC;IAExC,IAAI;QACF,MAAM,EAAC,WAAW,EAAE,OAAO,EAAE,yBAAyB,EAAC,GACrD,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;QAExC,MAAM,EAAC,OAAO,EAAE,YAAY,EAAC,GAAG,yBAAyB,CACvD,yBAAyB,EACzB,OAAO,CACR,CAAC;QAEF,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QAEvC,OAAO;YACL,WAAW;YACX,OAAO;YACP,YAAY;YACZ,OAAO;SACR,CAAC;KACH;IAAC,OAAO,GAAG,EAAE;QACZ,gBAAM,CAAC,KAAK,CAAC;kHACiG,CAAC,CAAC;QAChH,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AA1BD,kDA0BC"}

package/src/markdownParser.ts

@@ -1,201 +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 logger from '@docusaurus/logger';
-import matter from 'gray-matter';
-
-// Input: ## Some heading {#some-heading}
-// Output: {text: "## Some heading", id: "some-heading"}
-export function parseMarkdownHeadingId(heading: string): {
-  text: string;
-  id?: string;
-} {
-  const customHeadingIdRegex = /^(?<text>.*?)\s*\{#(?<id>[\w-]+)\}$/;
-  const matches = customHeadingIdRegex.exec(heading);
-  if (matches) {
-    return {
-      text: matches.groups!.text,
-      id: matches.groups!.id,
-    };
-  }
-  return {text: heading, id: undefined};
-}
-
-// Hacky way of stripping out import statements from the excerpt
-// TODO: Find a better way to do so, possibly by compiling the Markdown content,
-// stripping out HTML tags and obtaining the first line.
-export function createExcerpt(fileString: string): string | undefined {
-  const fileLines = fileString
-    .trimLeft()
-    // Remove Markdown alternate title
-    .replace(/^[^\n]*\n[=]+/g, '')
-    .split('\n');
-  let inCode = false;
-  let lastCodeFence = '';
-
-  /* eslint-disable no-continue */
-  for (const fileLine of fileLines) {
-    // Skip empty line.
-    if (!fileLine.trim()) {
-      continue;
-    }
-
-    // Skip import/export declaration.
-    if (/^(?:import|export)\s.*/.test(fileLine)) {
-      continue;
-    }
-
-    // Skip code block line.
-    if (fileLine.trim().startsWith('```')) {
-      if (!inCode) {
-        inCode = true;
-        [lastCodeFence] = fileLine.trim().match(/^`+/)!;
-        // If we are in a ````-fenced block, all ``` would be plain text instead
-        // of fences
-      } else if (
-        fileLine.trim().match(/^`+/)![0].length >= lastCodeFence.length
-      ) {
-        inCode = false;
-      }
-      continue;
-    } else if (inCode) {
-      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*(?<text>[^#]*)\s*(?:#{1,6})?/gm, '$1')
-      // Remove emphasis.
-      .replace(/(?<opening>[*_]{1,3})(?<text>.*?)\1/g, '$2')
-      // Remove strikethroughs.
-      .replace(/~~(?<text>\S.*\S)~~/g, '$1')
-      // Remove images.
-      .replace(/!\[(?<alt>.*?)\][[(].*?[\])]/g, '$1')
-      // Remove footnotes.
-      .replace(/\[\^.+?\](?:: .*?$)?/g, '')
-      // Remove inline links.
-      .replace(/\[(?<alt>.*?)\][[(].*?[\])]/g, '$1')
-      // Remove inline code.
-      .replace(/`(?<text>.+?)`/g, '$1')
-      // Remove blockquotes.
-      .replace(/^\s{0,3}>\s?/g, '')
-      // Remove admonition definition.
-      .replace(/:::.*/, '')
-      // Remove Emoji names within colons include preceding whitespace.
-      .replace(/\s?:(?:::|[^:\n])+:/g, '')
-      // Remove custom Markdown heading id.
-      .replace(/{#*[\w-]+}/, '')
-      .trim();
-
-    if (cleanedLine) {
-      return cleanedLine;
-    }
-  }
-
-  return undefined;
-}
-
-export function parseFrontMatter(markdownFileContent: string): {
-  frontMatter: Record<string, unknown>;
-  content: string;
-} {
-  const {data, content} = matter(markdownFileContent);
-  return {
-    frontMatter: data,
-    content: content.trim(),
-  };
-}
-
-/**
- * Try to convert markdown heading to text. Does not need to be perfect, it is
- * only used as a fallback when frontMatter.title is not provided. For now, we
- * just unwrap possible inline code blocks (# `config.js`)
- */
-function toTextContentTitle(contentTitle: string): string {
-  if (contentTitle.startsWith('`') && contentTitle.endsWith('`')) {
-    return contentTitle.substring(1, contentTitle.length - 1);
-  }
-  return contentTitle;
-}
-
-export function parseMarkdownContentTitle(
-  contentUntrimmed: string,
-  options?: {removeContentTitle?: boolean},
-): {content: string; contentTitle: string | undefined} {
-  const removeContentTitleOption = options?.removeContentTitle ?? false;
-
-  const content = contentUntrimmed.trim();
-
-  const IMPORT_STATEMENT =
-    /import\s+(?:[\w*{}\s\n,]+from\s+)?["'\s][@\w/_.-]+["'\s];?|\n/.source;
-  const REGULAR_TITLE =
-    /(?<pattern>#\s*(?<title>[^#\n{]*)+[ \t]*(?<suffix>(?:{#*[\w-]+})|#)?\n*?)/
-      .source;
-  const ALTERNATE_TITLE = /(?<pattern>\s*(?<title>[^\n]*)\s*\n[=]+)/.source;
-
-  const regularTitleMatch = new RegExp(
-    `^(?:${IMPORT_STATEMENT})*?${REGULAR_TITLE}`,
-    'g',
-  ).exec(content);
-  const alternateTitleMatch = new RegExp(
-    `^(?:${IMPORT_STATEMENT})*?${ALTERNATE_TITLE}`,
-    'g',
-  ).exec(content);
-
-  const titleMatch = regularTitleMatch ?? alternateTitleMatch;
-  const {pattern, title} = titleMatch?.groups ?? {};
-
-  if (!pattern || !title) {
-    return {content, contentTitle: undefined};
-  }
-  const newContent = removeContentTitleOption
-    ? content.replace(pattern, '')
-    : content;
-  return {
-    content: newContent.trim(),
-    contentTitle: toTextContentTitle(title.trim()).trim(),
-  };
-}
-
-type ParsedMarkdown = {
-  frontMatter: Record<string, unknown>;
-  content: string;
-  contentTitle: string | undefined;
-  excerpt: string | undefined;
-};
-
-export function parseMarkdownString(
-  markdownFileContent: string,
-  options?: {removeContentTitle?: boolean},
-): ParsedMarkdown {
-  try {
-    const {frontMatter, content: contentWithoutFrontMatter} =
-      parseFrontMatter(markdownFileContent);
-
-    const {content, contentTitle} = parseMarkdownContentTitle(
-      contentWithoutFrontMatter,
-      options,
-    );
-
-    const excerpt = createExcerpt(content);
-
-    return {
-      frontMatter,
-      content,
-      contentTitle,
-      excerpt,
-    };
-  } catch (err) {
-    logger.error(`Error while parsing Markdown front matter.
-This can happen if you use special characters in front matter values (try using double quotes around that value).`);
-    throw err;
-  }
-}