@docusaurus/mdx-loader 2.0.0-beta.fc64c12e4 → 2.0.0

package/src/remark/toc/index.js

@@ -1,79 +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.
- */
-
-const {parse} = require('@babel/parser');
-const traverse = require('@babel/traverse').default;
-const stringifyObject = require('stringify-object');
-const search = require('./search');
-
-const parseOptions = {
-  plugins: ['jsx'],
-  sourceType: 'module',
-};
-const isImport = (child) => child.type === 'import';
-const hasImports = (index) => index > -1;
-const isExport = (child) => child.type === 'export';
-
-const isTarget = (child, name) => {
-  let found = false;
-  const ast = parse(child.value, parseOptions);
-  traverse(ast, {
-    VariableDeclarator: (path) => {
-      if (path.node.id.name === name) {
-        found = true;
-      }
-    },
-  });
-
-  return found;
-};
-
-const getOrCreateExistingTargetIndex = (children, name) => {
-  let importsIndex = -1;
-  let targetIndex = -1;
-
-  children.forEach((child, index) => {
-    if (isImport(child)) {
-      importsIndex = index;
-    } else if (isExport(child) && isTarget(child, name)) {
-      targetIndex = index;
-    }
-  });
-
-  if (targetIndex === -1) {
-    const target = {
-      default: false,
-      type: 'export',
-      value: `export const ${name} = [];`,
-    };
-
-    targetIndex = hasImports(importsIndex) ? importsIndex + 1 : 0;
-    children.splice(targetIndex, 0, target);
-  }
-
-  return targetIndex;
-};
-
-const plugin = (options = {}) => {
-  const name = options.name || 'toc';
-
-  const transformer = (node) => {
-    const headings = search(node);
-    const {children} = node;
-    const targetIndex = getOrCreateExistingTargetIndex(children, name);
-
-    if (headings && headings.length) {
-      children[targetIndex].value = `export const ${name} = ${stringifyObject(
-        headings,
-      )};`;
-    }
-  };
-
-  return transformer;
-};
-
-module.exports = plugin;

package/src/remark/toc/search.js

@@ -1,73 +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.
- */
-
-// @ts-check
-
-const toString = require('mdast-util-to-string');
-const visit = require('unist-util-visit');
-// Destructuring require tslib
-// eslint-disable-next-line prefer-destructuring
-const toValue = require('../utils').toValue;
-
-/** @typedef {import('@docusaurus/types').TOCItem} TOC */
-/** @typedef {import('unist').Node} Node */
-
-/**
- * @typedef {Object} StringValuedNode
- * @property {string} type
- * @property {string} value
- * @property {number} depth
- * @property {Object} data
- * @property {StringValuedNode[]} children
- */
-
-// Visit all headings. We `slug` all headings (to account for
-// duplicates), but only take h2 and h3 headings.
-/**
- * @param {StringValuedNode} node
- * @returns {TOC[]}
- */
-function search(node) {
-  /** @type {TOC[]} */
-  const headings = [];
-  let current = -1;
-  let currentDepth = 0;
-
-  /**
-   * @param {StringValuedNode} child
-   * @param {number} index
-   * @param {Node | undefined} parent
-   * @returns {void}
-   */
-  const onHeading = (child, index, parent) => {
-    const value = toString(child);
-
-    if (parent !== node || !value || child.depth > 3 || child.depth < 2) {
-      return;
-    }
-
-    const entry = {
-      value: toValue(child),
-      id: child.data.id,
-      children: [],
-    };
-
-    if (!headings.length || currentDepth >= child.depth) {
-      headings.push(entry);
-      current += 1;
-      currentDepth = child.depth;
-    } else {
-      headings[current].children.push(entry);
-    }
-  };
-
-  visit(node, 'heading', onHeading);
-
-  return headings;
-}
-
-module.exports = search;

package/src/remark/transformImage/__tests__/__snapshots__/index.test.js.snap

@@ -1,31 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`transformImage plugin fail if image does not exist 1`] = `"Image packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/fixtures/img/doesNotExist.png used in packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/fixtures/fail.md not found."`;
-
-exports[`transformImage plugin fail if image url is absent 1`] = `"Markdown image URL is mandatory in \\"packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/fixtures/noUrl.md\\" file"`;
-
-exports[`transformImage plugin pathname protocol 1`] = `
-"![img](/img/unchecked.png)
-"
-`;
-
-exports[`transformImage plugin transform md images to <img /> 1`] = `
-"![img](https://example.com/img.png)
-
-<img src={require(\\"!url-loader?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=file-loader!./img.png\\").default} />
-
-<img alt={\\"img\\"} src={require(\\"!url-loader?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=file-loader!./img.png\\").default} />
-
-<img alt={\\"img\\"} src={require(\\"!url-loader?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=file-loader!./img.png\\").default} title=\\"Title\\" /> <img alt={\\"img\\"} src={require(\\"!url-loader?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=file-loader!packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/fixtures/img.png\\").default} />
-
-<img alt={\\"img with &quot;quotes&quot;\\"} src={require(\\"!url-loader?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=file-loader!./img.png\\").default} title=\\"&#39;Quoted&#39; title\\" />
-
-## Heading
-
-\`\`\`md
-![img](./img.png)
-\`\`\`
-
-<img alt={\\"img\\"} src={require(\\"!url-loader?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=file-loader!./img.png\\").default} />
-"
-`;

package/src/remark/transformImage/__tests__/fixtures/fail.md

@@ -1 +0,0 @@
-![img](/img/doesNotExist.png)

package/src/remark/transformImage/__tests__/fixtures/img.md

@@ -1,17 +0,0 @@
-![img](https://example.com/img.png)
-
-![](./img.png)
-
-![img](./img.png)
-
-![img](./img.png 'Title') ![img](/img.png)
-
-![img with "quotes"](./img.png ''Quoted' title')
-
-## Heading
-
-```md
-![img](./img.png)
-```
-
-![img](img.png)

package/src/remark/transformImage/__tests__/fixtures/noUrl.md

@@ -1 +0,0 @@
-![img]()

package/src/remark/transformImage/__tests__/fixtures/pathname.md

@@ -1 +0,0 @@
-![img](pathname:///img/unchecked.png)

package/src/remark/transformImage/__tests__/index.test.js

@@ -1,59 +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 {join, relative} from 'path';
-import remark from 'remark';
-import mdx from 'remark-mdx';
-import vfile from 'to-vfile';
-import plugin from '../index';
-import headings from '../../headings/index';
-
-const processFixture = async (name, options) => {
-  const path = join(__dirname, 'fixtures', `${name}.md`);
-  const file = await vfile.read(path);
-  const result = await remark()
-    .use(headings)
-    .use(mdx)
-    .use(plugin, {...options, filePath: path})
-    .process(file);
-
-  return result.toString();
-};
-
-// avoid hardcoding absolute
-const staticDir = `./${relative(process.cwd(), join(__dirname, 'fixtures'))}`;
-
-describe('transformImage plugin', () => {
-  test('fail if image does not exist', async () => {
-    await expect(
-      processFixture('fail', {
-        staticDir,
-      }),
-    ).rejects.toThrowErrorMatchingSnapshot();
-  });
-  test('fail if image url is absent', async () => {
-    await expect(
-      processFixture('noUrl', {
-        staticDir,
-      }),
-    ).rejects.toThrowErrorMatchingSnapshot();
-  });
-
-  test('transform md images to <img />', async () => {
-    const result = await processFixture('img', {
-      staticDir,
-    });
-    expect(result).toMatchSnapshot();
-  });
-
-  test('pathname protocol', async () => {
-    const result = await processFixture('pathname', {
-      staticDir,
-    });
-    expect(result).toMatchSnapshot();
-  });
-});

package/src/remark/transformImage/index.js

@@ -1,106 +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.
- */
-
-const visit = require('unist-util-visit');
-const path = require('path');
-const url = require('url');
-const fs = require('fs-extra');
-const escapeHtml = require('escape-html');
-const {getFileLoaderUtils} = require('@docusaurus/core/lib/webpack/utils');
-const {
-  posixPath,
-  escapePath,
-  toMessageRelativeFilePath,
-} = require('@docusaurus/utils');
-
-const {
-  loaders: {inlineMarkdownImageFileLoader},
-} = getFileLoaderUtils();
-
-const createJSX = (node, pathUrl) => {
-  const jsxNode = node;
-  jsxNode.type = 'jsx';
-  jsxNode.value = `<img ${node.alt ? `alt={"${escapeHtml(node.alt)}"} ` : ''}${
-    node.url
-      ? `src={require("${inlineMarkdownImageFileLoader}${escapePath(
-          pathUrl,
-        )}").default}`
-      : ''
-  }${node.title ? ` title="${escapeHtml(node.title)}"` : ''} />`;
-
-  if (jsxNode.url) {
-    delete jsxNode.url;
-  }
-  if (jsxNode.alt) {
-    delete jsxNode.alt;
-  }
-  if (jsxNode.title) {
-    delete jsxNode.title;
-  }
-};
-
-async function ensureImageFileExist(imagePath, sourceFilePath) {
-  const imageExists = await fs.pathExists(imagePath);
-  if (!imageExists) {
-    throw new Error(
-      `Image ${toMessageRelativeFilePath(
-        imagePath,
-      )} used in ${toMessageRelativeFilePath(sourceFilePath)} not found.`,
-    );
-  }
-}
-
-async function processImageNode(node, {filePath, staticDir}) {
-  if (!node.url) {
-    throw new Error(
-      `Markdown image URL is mandatory in "${toMessageRelativeFilePath(
-        filePath,
-      )}" file`,
-    );
-  }
-
-  const parsedUrl = url.parse(node.url);
-  if (parsedUrl.protocol) {
-    // pathname:// is an escape hatch,
-    // in case user does not want his images to be converted to require calls going through webpack loader
-    // we don't have to document this for now,
-    // it's mostly to make next release less risky (2.0.0-alpha.59)
-    if (parsedUrl.protocol === 'pathname:') {
-      node.url = node.url.replace('pathname://', '');
-    } else {
-      // noop
-    }
-  }
-  // images without protocol
-  else if (path.isAbsolute(node.url)) {
-    // absolute paths are expected to exist in the static folder
-    const expectedImagePath = path.join(staticDir, node.url);
-    await ensureImageFileExist(expectedImagePath, filePath);
-    createJSX(node, posixPath(expectedImagePath));
-  }
-  // We try to convert image urls without protocol to images with require calls
-  // going through webpack ensures that image assets exist at build time
-  else {
-    // relative paths are resolved against the source file's folder
-    const expectedImagePath = path.join(path.dirname(filePath), node.url);
-    await ensureImageFileExist(expectedImagePath, filePath);
-    createJSX(node, node.url.startsWith('./') ? node.url : `./${node.url}`);
-  }
-}
-
-const plugin = (options) => {
-  const transformer = async (root) => {
-    const promises = [];
-    visit(root, 'image', (node) => {
-      promises.push(processImageNode(node, options));
-    });
-    await Promise.all(promises);
-  };
-  return transformer;
-};
-
-module.exports = plugin;

package/src/remark/transformLinks/__tests__/__snapshots__/index.test.js.snap

@@ -1,41 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`transformAsset plugin fail if asset url is absent 1`] = `"Markdown link URL is mandatory in \\"packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/fixtures/noUrl.md\\" file (title: asset, line: 1)."`;
-
-exports[`transformAsset plugin pathname protocol 1`] = `
-"[asset](pathname:///asset/unchecked.pdf)
-"
-`;
-
-exports[`transformAsset plugin transform md links to <a /> 1`] = `
-"[asset](https://example.com/asset.pdf)
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default}></a>
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default}>asset</a>
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default}title=\\"Title\\">asset</a>
-
-## Heading
-
-\`\`\`md
-[asset](./asset.pdf)
-\`\`\`
-
-[assets](!file-loader!./asset.pdf)
-
-[assets](/github/!file-loader!/assets.pdf)
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default}>asset</a>
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}>staticAsset.pdf</a>
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}>@site/static/staticAsset.pdf</a>
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}>Just staticAsset.pdf</a>, and <a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}><strong>awesome</strong> staticAsset 2.pdf &#39;It is really &quot;AWESOME&quot;&#39;</a>, but also <a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}>coded <code>staticAsset 3.pdf</code></a>
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./static/staticAssetImage.png').default}><img alt={\\"Clickable Docusaurus logo\\"} src={require(\\"!url-loader?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=file-loader!./static/staticAssetImage.png\\").default} /></a>
-
-<a target=\\"_blank\\" href={require('!file-loader?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default}><span style={{color: \\"red\\"}}>Stylized link to asset file</span></a>
-"
-`;

package/src/remark/transformLinks/__tests__/fixtures/asset.md

@@ -1,29 +0,0 @@
-[asset](https://example.com/asset.pdf)
-
-[](./asset.pdf)
-
-[asset](./asset.pdf)
-
-[asset](asset.pdf 'Title')
-
-## Heading
-
-```md
-[asset](./asset.pdf)
-```
-
-[assets](!file-loader!./asset.pdf)
-
-[assets](/github/!file-loader!/assets.pdf)
-
-[asset](asset.pdf)
-
-[staticAsset.pdf](/staticAsset.pdf)
-
-[@site/static/staticAsset.pdf](@site/static/staticAsset.pdf)
-
-[Just staticAsset.pdf](/staticAsset.pdf), and [**awesome** staticAsset 2.pdf 'It is really "AWESOME"'](/staticAsset.pdf), but also [coded `staticAsset 3.pdf`](/staticAsset.pdf)
-
-[![Clickable Docusaurus logo](./static/staticAssetImage.png)](/staticAssetImage.png)
-
-[<span style={{color: "red"}}>Stylized link to asset file</span>](./asset.pdf)

package/src/remark/transformLinks/__tests__/fixtures/noUrl.md

@@ -1 +0,0 @@
-[asset]()

package/src/remark/transformLinks/__tests__/fixtures/pathname.md

@@ -1 +0,0 @@
-[asset](pathname:///asset/unchecked.pdf)

package/src/remark/transformLinks/__tests__/index.test.js

@@ -1,44 +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 {join} from 'path';
-import remark from 'remark';
-import mdx from 'remark-mdx';
-import vfile from 'to-vfile';
-import plugin from '..';
-import transformImage from '../../transformImage';
-
-const processFixture = async (name, options) => {
-  const path = join(__dirname, 'fixtures', `${name}.md`);
-  const staticDir = join(__dirname, 'fixtures', 'static');
-  const file = await vfile.read(path);
-  const result = await remark()
-    .use(mdx)
-    .use(transformImage, {...options, filePath: path, staticDir})
-    .use(plugin, {...options, filePath: path, staticDir})
-    .process(file);
-
-  return result.toString();
-};
-
-describe('transformAsset plugin', () => {
-  test('fail if asset url is absent', async () => {
-    await expect(
-      processFixture('noUrl'),
-    ).rejects.toThrowErrorMatchingSnapshot();
-  });
-
-  test('transform md links to <a />', async () => {
-    const result = await processFixture('asset');
-    expect(result).toMatchSnapshot();
-  });
-
-  test('pathname protocol', async () => {
-    const result = await processFixture('pathname');
-    expect(result).toMatchSnapshot();
-  });
-});

package/src/remark/transformLinks/index.js

@@ -1,143 +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.
- */
-
-const {
-  toMessageRelativeFilePath,
-  posixPath,
-  escapePath,
-} = require('@docusaurus/utils');
-
-const visit = require('unist-util-visit');
-const path = require('path');
-const url = require('url');
-const fs = require('fs-extra');
-const escapeHtml = require('escape-html');
-const {toValue} = require('../utils');
-const {getFileLoaderUtils} = require('@docusaurus/core/lib/webpack/utils');
-
-const {
-  loaders: {inlineMarkdownLinkFileLoader},
-} = getFileLoaderUtils();
-
-async function ensureAssetFileExist(fileSystemAssetPath, sourceFilePath) {
-  const assetExists = await fs.pathExists(fileSystemAssetPath);
-  if (!assetExists) {
-    throw new Error(
-      `Asset ${toMessageRelativeFilePath(
-        fileSystemAssetPath,
-      )} used in ${toMessageRelativeFilePath(sourceFilePath)} not found.`,
-    );
-  }
-}
-
-// transform the link node to a jsx link with a require() call
-function toAssetRequireNode({node, filePath, requireAssetPath}) {
-  /* eslint-disable no-param-reassign */
-
-  let relativeRequireAssetPath = posixPath(
-    path.relative(path.dirname(filePath), requireAssetPath),
-  );
-
-  // nodejs does not like require("assets/file.pdf")
-  relativeRequireAssetPath = relativeRequireAssetPath.startsWith('.')
-    ? relativeRequireAssetPath
-    : `./${relativeRequireAssetPath}`;
-
-  const href = `require('${inlineMarkdownLinkFileLoader}${escapePath(
-    relativeRequireAssetPath,
-  )}').default`;
-  const children = (node.children || []).map((n) => toValue(n)).join('');
-  const title = node.title ? `title="${escapeHtml(node.title)}"` : '';
-
-  node.type = 'jsx';
-  node.value = `<a target="_blank" href={${href}}${title}>${children}</a>`;
-}
-
-// If the link looks like an asset link, we'll link to the asset,
-// and use a require("assetUrl") (using webpack url-loader/file-loader)
-// instead of navigating to such link
-async function convertToAssetLinkIfNeeded({node, staticDir, filePath}) {
-  const assetPath = node.url;
-
-  const hasSiteAlias = assetPath.startsWith('@site/');
-  const hasAssetLikeExtension =
-    path.extname(assetPath) && !assetPath.match(/#|.md|.mdx|.html/);
-
-  const looksLikeAssetLink = hasSiteAlias || hasAssetLikeExtension;
-
-  if (!looksLikeAssetLink) {
-    return;
-  }
-
-  function toAssetLinkNode(requireAssetPath) {
-    toAssetRequireNode({
-      node,
-      filePath,
-      requireAssetPath,
-    });
-  }
-
-  if (assetPath.startsWith('@site/')) {
-    const siteDir = path.join(staticDir, '..');
-    const fileSystemAssetPath = path.join(
-      siteDir,
-      assetPath.replace('@site/', ''),
-    );
-    await ensureAssetFileExist(fileSystemAssetPath, filePath);
-    toAssetLinkNode(fileSystemAssetPath);
-  } else if (path.isAbsolute(assetPath)) {
-    const fileSystemAssetPath = path.join(staticDir, assetPath);
-    if (await fs.pathExists(fileSystemAssetPath)) {
-      toAssetLinkNode(fileSystemAssetPath);
-    }
-  } else {
-    const fileSystemAssetPath = path.join(path.dirname(filePath), assetPath);
-    if (await fs.pathExists(fileSystemAssetPath)) {
-      toAssetLinkNode(fileSystemAssetPath);
-    }
-  }
-}
-
-async function processLinkNode({node, _index, _parent, filePath, staticDir}) {
-  if (!node.url) {
-    // try to improve error feedback
-    // see https://github.com/facebook/docusaurus/issues/3309#issuecomment-690371675
-    const title =
-      node.title || (node.children[0] && node.children[0].value) || '?';
-    const line =
-      (node.position && node.position.start && node.position.start.line) || '?';
-    throw new Error(
-      `Markdown link URL is mandatory in "${toMessageRelativeFilePath(
-        filePath,
-      )}" file (title: ${title}, line: ${line}).`,
-    );
-  }
-
-  const parsedUrl = url.parse(node.url);
-  if (parsedUrl.protocol) {
-    return;
-  }
-
-  await convertToAssetLinkIfNeeded({
-    node,
-    staticDir,
-    filePath,
-  });
-}
-
-const plugin = (options) => {
-  const transformer = async (root) => {
-    const promises = [];
-    visit(root, 'link', (node, index, parent) => {
-      promises.push(processLinkNode({node, index, parent, ...options}));
-    });
-    await Promise.all(promises);
-  };
-  return transformer;
-};
-
-module.exports = plugin;