@docusaurus/mdx-loader 0.0.0-4277 → 0.0.0-4285

package/src/remark/toc/__tests__/search.test.ts

@@ -1,182 +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 remark from 'remark';
-import mdx from 'remark-mdx';
-import search from '../search';
-import headings from '../../headings/index';
-
-const getHeadings = async (mdText: string) => {
-  const node = remark().parse(mdText);
-  const result = await remark().use(headings).use(mdx).run(node);
-  return search(result);
-};
-
-test('should process all heading levels', async () => {
-  const md = `
-# Alpha
-
-## Bravo
-
-### Charlie
-
-#### Delta
-
-##### Echo
-
-###### Foxtrot
-
-  `;
-
-  expect(await getHeadings(md)).toEqual([
-    {
-      children: [
-        {
-          children: [
-            {
-              children: [
-                {
-                  children: [
-                    {
-                      children: [],
-                      id: 'foxtrot',
-                      level: 6,
-                      value: 'Foxtrot',
-                    },
-                  ],
-                  id: 'echo',
-                  level: 5,
-                  value: 'Echo',
-                },
-              ],
-              id: 'delta',
-              level: 4,
-              value: 'Delta',
-            },
-          ],
-          id: 'charlie',
-          level: 3,
-          value: 'Charlie',
-        },
-      ],
-      id: 'bravo',
-      level: 2,
-      value: 'Bravo',
-    },
-  ]);
-});
-
-test('should process real-world well-formatted md', async () => {
-  const md = `
-# title
-
-some text
-
-## section 1
-
-some text
-
-### subsection 1-1
-
-some text
-
-#### subsection 1-1-1
-
-some text
-
-#### subsection 1-1-2
-
-some text
-
-### subsection 1-2
-
-some text
-
-### subsection 1-3
-
-some text
-
-## section 2
-
-some text
-
-### subsection 2-1
-
-some text
-
-### subsection 2-1
-
-some text
-
-## section 3
-
-some text
-
-### subsection 3-1
-
-some text
-
-### subsection 3-2
-
-some text
-
-  `;
-
-  expect(await getHeadings(md)).toEqual([
-    {
-      children: [
-        {
-          children: [
-            {
-              children: [],
-              id: 'subsection-1-1-1',
-              level: 4,
-              value: 'subsection 1-1-1',
-            },
-            {
-              children: [],
-              id: 'subsection-1-1-2',
-              level: 4,
-              value: 'subsection 1-1-2',
-            },
-          ],
-          id: 'subsection-1-1',
-          level: 3,
-          value: 'subsection 1-1',
-        },
-        {children: [], id: 'subsection-1-2', level: 3, value: 'subsection 1-2'},
-        {children: [], id: 'subsection-1-3', level: 3, value: 'subsection 1-3'},
-      ],
-      id: 'section-1',
-      level: 2,
-      value: 'section 1',
-    },
-    {
-      children: [
-        {children: [], id: 'subsection-2-1', level: 3, value: 'subsection 2-1'},
-        {
-          children: [],
-          id: 'subsection-2-1-1',
-          level: 3,
-          value: 'subsection 2-1',
-        },
-      ],
-      id: 'section-2',
-      level: 2,
-      value: 'section 2',
-    },
-    {
-      children: [
-        {children: [], id: 'subsection-3-1', level: 3, value: 'subsection 3-1'},
-        {children: [], id: 'subsection-3-2', level: 3, value: 'subsection 3-2'},
-      ],
-      id: 'section-3',
-      level: 2,
-      value: 'section 3',
-    },
-  ]);
-});

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

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

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

@@ -1,19 +0,0 @@
-![img](https://example.com/img.png)
-
-![](./static/img.png)
-
-![img](./static/img.png)
-
-![img from second static folder](/img2.png)
-
-![img from second static folder](./static2/img2.png)
-
-![img](./static/img.png 'Title') ![img](/img.png)
-
-![img with "quotes"](./static/img.png ''Quoted' title')
-
-## Heading
-
-```md
-![img](./static/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__/__snapshots__/index.test.ts.snap

@@ -1,33 +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__/static/img/doesNotExist.png or packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/__fixtures__/static2/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(\\"![CWD]/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=[CWD]/node_modules/file-loader/dist/cjs.js!./static/img.png\\").default} />
-
-<img alt={\\"img\\"} src={require(\\"![CWD]/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=[CWD]/node_modules/file-loader/dist/cjs.js!./static/img.png\\").default} />
-
-<img alt={\\"img from second static folder\\"} src={require(\\"![CWD]/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=[CWD]/node_modules/file-loader/dist/cjs.js!packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/__fixtures__/static2/img2.png\\").default} />
-
-<img alt={\\"img from second static folder\\"} src={require(\\"![CWD]/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=[CWD]/node_modules/file-loader/dist/cjs.js!./static2/img2.png\\").default} />
-
-<img alt={\\"img\\"} src={require(\\"![CWD]/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=[CWD]/node_modules/file-loader/dist/cjs.js!./static/img.png\\").default} title=\\"Title\\" /> <img alt={\\"img\\"} src={require(\\"![CWD]/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=[CWD]/node_modules/file-loader/dist/cjs.js!packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/__fixtures__/static/img.png\\").default} />
-
-<img alt={\\"img with &quot;quotes&quot;\\"} src={require(\\"![CWD]/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=[CWD]/node_modules/file-loader/dist/cjs.js!./static/img.png\\").default} title=\\"&#39;Quoted&#39; title\\" />
-
-## Heading
-
-\`\`\`md
-![img](./static/img.png)
-\`\`\`
-"
-`;

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

@@ -1,63 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import path from 'path';
-import remark from 'remark';
-import mdx from 'remark-mdx';
-import vfile from 'to-vfile';
-import plugin from '../index';
-import headings from '../../headings/index';
-import {posixPath} from '@docusaurus/utils';
-
-const processFixture = async (name, options) => {
-  const filePath = path.join(__dirname, `__fixtures__/${name}.md`);
-  const file = await vfile.read(filePath);
-  const result = await remark()
-    .use(headings)
-    .use(mdx)
-    .use(plugin, {...options, filePath})
-    .process(file);
-
-  return result
-    .toString()
-    .replace(new RegExp(posixPath(process.cwd()), 'g'), '[CWD]');
-};
-
-const staticDirs = [
-  // avoid hardcoding absolute in the snapshot
-  `./${path.relative(
-    process.cwd(),
-    path.join(__dirname, '__fixtures__/static'),
-  )}`,
-  `./${path.relative(
-    process.cwd(),
-    path.join(__dirname, '__fixtures__/static2'),
-  )}`,
-];
-
-describe('transformImage plugin', () => {
-  test('fail if image does not exist', async () => {
-    await expect(
-      processFixture('fail', {staticDirs}),
-    ).rejects.toThrowErrorMatchingSnapshot();
-  });
-  test('fail if image url is absent', async () => {
-    await expect(
-      processFixture('noUrl', {staticDirs}),
-    ).rejects.toThrowErrorMatchingSnapshot();
-  });
-
-  test('transform md images to <img />', async () => {
-    const result = await processFixture('img', {staticDirs});
-    expect(result).toMatchSnapshot();
-  });
-
-  test('pathname protocol', async () => {
-    const result = await processFixture('pathname', {staticDirs});
-    expect(result).toMatchSnapshot();
-  });
-});

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

@@ -1,35 +0,0 @@
-[asset](https://example.com/asset.pdf)
-
-[](./asset.pdf)
-
-[asset](./asset.pdf)
-
-[asset with hash](./asset.pdf#page=2)
-
-[asset](asset.pdf 'Title')
-
-## Heading
-
-```md
-[asset](./asset.pdf)
-```
-
-[assets](!file-loader!./asset.pdf)
-
-[assets](/github/!file-loader!/assets.pdf)
-
-[asset](asset.pdf)
-
-[asset2](/asset2.pdf)
-
-[staticAsset.pdf](/staticAsset.pdf)
-
-[@site/static/staticAsset.pdf](@site/static/staticAsset.pdf)
-
-[@site/static/staticAsset.pdf](@site/static/staticAsset.pdf#page=2 'Title')
-
-[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__/__snapshots__/index.test.ts.snap

@@ -1,47 +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('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default}></a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default}>asset</a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default + '#page=2'}>asset with hash</a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?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('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./asset.pdf').default}>asset</a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./static2/asset2.pdf').default}>asset2</a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}>staticAsset.pdf</a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}>@site/static/staticAsset.pdf</a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default + '#page=2'} title=\\"Title\\">@site/static/staticAsset.pdf</a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}>Just staticAsset.pdf</a>, and <a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?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('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./static/staticAsset.pdf').default}>coded <code>staticAsset 3.pdf</code></a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?name=assets/files/[name]-[hash].[ext]!./static/staticAssetImage.png').default}><img alt={\\"Clickable Docusaurus logo\\"} src={require(\\"![CWD]/node_modules/url-loader/dist/cjs.js?limit=10000&name=assets/images/[name]-[hash].[ext]&fallback=[CWD]/node_modules/file-loader/dist/cjs.js!./static/staticAssetImage.png\\").default} /></a>
-
-<a target=\\"_blank\\" href={require('![CWD]/node_modules/file-loader/dist/cjs.js?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__/index.test.ts

@@ -1,55 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import path from 'path';
-import remark from 'remark';
-import mdx from 'remark-mdx';
-import vfile from 'to-vfile';
-import plugin from '..';
-import transformImage from '../../transformImage';
-import {posixPath} from '@docusaurus/utils';
-
-const processFixture = async (name: string, options?) => {
-  const filePath = path.join(__dirname, `__fixtures__/${name}.md`);
-  const staticDirs = [
-    path.join(__dirname, '__fixtures__/static'),
-    path.join(__dirname, '__fixtures__/static2'),
-  ];
-  const file = await vfile.read(filePath);
-  const result = await remark()
-    .use(mdx)
-    .use(transformImage, {...options, filePath, staticDirs})
-    .use(plugin, {
-      ...options,
-      filePath,
-      staticDirs,
-      siteDir: path.join(__dirname, '__fixtures__'),
-    })
-    .process(file);
-
-  return result
-    .toString()
-    .replace(new RegExp(posixPath(process.cwd()), 'g'), '[CWD]');
-};
-
-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();
-  });
-});