@docusaurus/mdx-loader 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17

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

@@ -1,315 +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.
- */
-
-/* Based on remark-slug (https://github.com/remarkjs/remark-slug) and gatsby-remark-autolink-headers (https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-remark-autolink-headers) */
-
-/* eslint-disable no-param-reassign */
-
-import remark from 'remark';
-import u from 'unist-builder';
-import removePosition from 'unist-util-remove-position';
-import toString from 'mdast-util-to-string';
-import visit from 'unist-util-visit';
-import slug from '../index';
-
-function process(doc, plugins = []) {
-  const processor = remark().use({plugins: [...plugins, slug]});
-  return removePosition(processor.runSync(processor.parse(doc)), true);
-}
-
-function heading(label, id) {
-  return u(
-    'heading',
-    {depth: 2, data: {id, hProperties: {id}}},
-    label ? [u('text', label)] : [],
-  );
-}
-
-describe('headings plugin', () => {
-  test('should patch `id`s and `data.hProperties.id', () => {
-    const result = process('# Normal\n\n## Table of Contents\n\n# Baz\n');
-    const expected = u('root', [
-      u(
-        'heading',
-        {depth: 1, data: {hProperties: {id: 'normal'}, id: 'normal'}},
-        [u('text', 'Normal')],
-      ),
-      u(
-        'heading',
-        {
-          depth: 2,
-          data: {
-            hProperties: {id: 'table-of-contents'},
-            id: 'table-of-contents',
-          },
-        },
-        [u('text', 'Table of Contents')],
-      ),
-      u('heading', {depth: 1, data: {hProperties: {id: 'baz'}, id: 'baz'}}, [
-        u('text', 'Baz'),
-      ]),
-    ]);
-
-    expect(result).toEqual(expected);
-  });
-
-  test('should not overwrite `data` on headings', () => {
-    const result = process('# Normal\n', [
-      function () {
-        function transform(tree) {
-          tree.children[0].data = {foo: 'bar'};
-        }
-        return transform;
-      },
-    ]);
-    const expected = u('root', [
-      u(
-        'heading',
-        {
-          depth: 1,
-          data: {foo: 'bar', hProperties: {id: 'normal'}, id: 'normal'},
-        },
-        [u('text', 'Normal')],
-      ),
-    ]);
-
-    expect(result).toEqual(expected);
-  });
-
-  test('should not overwrite `data.hProperties` on headings', () => {
-    const result = process('# Normal\n', [
-      function () {
-        function transform(tree) {
-          tree.children[0].data = {hProperties: {className: ['foo']}};
-        }
-        return transform;
-      },
-    ]);
-    const expected = u('root', [
-      u(
-        'heading',
-        {
-          depth: 1,
-          data: {hProperties: {className: ['foo'], id: 'normal'}, id: 'normal'},
-        },
-        [u('text', 'Normal')],
-      ),
-    ]);
-
-    expect(result).toEqual(expected);
-  });
-
-  test('should generate `id`s and `hProperties.id`s, based on `hProperties.id` if they exist', () => {
-    const result = process(
-      [
-        '## Something',
-        '## Something here',
-        '## Something there',
-        '## Something also',
-      ].join('\n\n'),
-      [
-        function () {
-          function transform(tree) {
-            tree.children[1].data = {hProperties: {id: 'here'}};
-            tree.children[3].data = {hProperties: {id: 'something'}};
-          }
-          return transform;
-        },
-      ],
-    );
-    const expected = u('root', [
-      u(
-        'heading',
-        {
-          depth: 2,
-          data: {hProperties: {id: 'something'}, id: 'something'},
-        },
-        [u('text', 'Something')],
-      ),
-      u(
-        'heading',
-        {
-          depth: 2,
-          data: {hProperties: {id: 'here'}, id: 'here'},
-        },
-        [u('text', 'Something here')],
-      ),
-      u(
-        'heading',
-        {
-          depth: 2,
-          data: {hProperties: {id: 'something-there'}, id: 'something-there'},
-        },
-        [u('text', 'Something there')],
-      ),
-      u(
-        'heading',
-        {
-          depth: 2,
-          data: {hProperties: {id: 'something-1'}, id: 'something-1'},
-        },
-        [u('text', 'Something also')],
-      ),
-    ]);
-
-    expect(result).toEqual(expected);
-  });
-
-  test('should create GitHub-style headings ids', () => {
-    const result = process(
-      [
-        '## I ♥ unicode',
-        '',
-        '## Dash-dash',
-        '',
-        '## en–dash',
-        '',
-        '## em–dash',
-        '',
-        '## 😄 unicode emoji',
-        '',
-        '## 😄-😄 unicode emoji',
-        '',
-        '## 😄_😄 unicode emoji',
-        '',
-        '##',
-        '',
-        '## ',
-        '',
-        '##     Initial spaces',
-        '',
-        '## Final spaces   ',
-        '',
-        '## Duplicate',
-        '',
-        '## Duplicate',
-        '',
-        '## :ok: No underscore',
-        '',
-        '## :ok_hand: Single',
-        '',
-        '## :ok_hand::hatched_chick: Two in a row with no spaces',
-        '',
-        '## :ok_hand: :hatched_chick: Two in a row',
-        '',
-      ].join('\n'),
-    );
-    const expected = u('root', [
-      heading('I ♥ unicode', 'i--unicode'),
-      heading('Dash-dash', 'dash-dash'),
-      heading('en–dash', 'endash'),
-      heading('em–dash', 'emdash'),
-      heading('😄 unicode emoji', '-unicode-emoji'),
-      heading('😄-😄 unicode emoji', '--unicode-emoji'),
-      heading('😄_😄 unicode emoji', '_-unicode-emoji'),
-      heading(null, ''),
-      heading(null, '-1'),
-      heading('Initial spaces', 'initial-spaces'),
-      heading('Final spaces', 'final-spaces'),
-      heading('Duplicate', 'duplicate'),
-      heading('Duplicate', 'duplicate-1'),
-      heading(':ok: No underscore', 'ok-no-underscore'),
-      heading(':ok_hand: Single', 'ok_hand-single'),
-      heading(
-        ':ok_hand::hatched_chick: Two in a row with no spaces',
-        'ok_handhatched_chick-two-in-a-row-with-no-spaces',
-      ),
-      heading(
-        ':ok_hand: :hatched_chick: Two in a row',
-        'ok_hand-hatched_chick-two-in-a-row',
-      ),
-    ]);
-
-    expect(result).toEqual(expected);
-  });
-
-  test('should generate id from only text contents of headings if they contains HTML tags', () => {
-    const result = process('# <span class="normal-header">Normal</span>\n');
-    const expected = u('root', [
-      u(
-        'heading',
-        {
-          depth: 1,
-          data: {hProperties: {id: 'normal'}, id: 'normal'},
-        },
-        [
-          u('html', '<span class="normal-header">'),
-          u('text', 'Normal'),
-          u('html', '</span>'),
-        ],
-      ),
-    ]);
-
-    expect(result).toEqual(expected);
-  });
-
-  test('should create custom headings ids', () => {
-    const result = process(`
-# Heading One {#custom_h1}
-
-## Heading Two {#custom-heading-two}
-
-# With *Bold* {#custom-withbold}
-
-# With *Bold* hello{#custom-withbold-hello}
-
-# With *Bold* hello2 {#custom-withbold-hello2}
-
-# Snake-cased ID {#this_is_custom_id}
-
-# No custom ID
-
-# {#id-only}
-
-# {#text-after} custom ID
-  `);
-
-    const headers = [];
-    visit(result, 'heading', (node) => {
-      headers.push({text: toString(node), id: node.data.id});
-    });
-
-    expect(headers).toEqual([
-      {
-        id: 'custom_h1',
-        text: 'Heading One',
-      },
-      {
-        id: 'custom-heading-two',
-        text: 'Heading Two',
-      },
-      {
-        id: 'custom-withbold',
-        text: 'With Bold',
-      },
-      {
-        id: 'custom-withbold-hello',
-        text: 'With Bold hello',
-      },
-      {
-        id: 'custom-withbold-hello2',
-        text: 'With Bold hello2',
-      },
-      {
-        id: 'this_is_custom_id',
-        text: 'Snake-cased ID',
-      },
-      {
-        id: 'no-custom-id',
-        text: 'No custom ID',
-      },
-      {
-        id: 'id-only',
-        text: '',
-      },
-      {
-        id: 'text-after-custom-id',
-        text: '{#text-after} custom ID',
-      },
-    ]);
-  });
-});

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

@@ -1,85 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`inline code should be escaped 1`] = `
-"export const toc = [
-	{
-		value: '<code>&lt;Head /&gt;</code>',
-		id: 'head-',
-		children: [
-			{
-				value: '<code>&lt;Head&gt;Test&lt;/Head&gt;</code>',
-				id: 'headtesthead',
-				children: []
-			}
-		]
-	},
-	{
-		value: '<code>&lt;div /&gt;</code>',
-		id: 'div-',
-		children: []
-	},
-	{
-		value: '<code>&lt;div&gt; Test &lt;/div&gt;</code>',
-		id: 'div-test-div',
-		children: []
-	},
-	{
-		value: '<code>&lt;div&gt;&lt;i&gt;Test&lt;/i&gt;&lt;/div&gt;</code>',
-		id: 'divitestidiv',
-		children: []
-	}
-];
-
-## \`<Head />\`
-
-### \`<Head>Test</Head>\`
-
-## \`<div />\`
-
-## \`<div> Test </div>\`
-
-## \`<div><i>Test</i></div>\`
-"
-`;
-
-exports[`non text phrasing content 1`] = `
-"export const toc = [
-	{
-		value: '<em>Emphasis</em>',
-		id: 'emphasis',
-		children: [
-			{
-				value: '<strong>Importance</strong>',
-				id: 'importance',
-				children: []
-			}
-		]
-	},
-	{
-		value: '<del>Strikethrough</del>',
-		id: 'strikethrough',
-		children: []
-	},
-	{
-		value: '<i>HTML</i>',
-		id: 'html',
-		children: []
-	},
-	{
-		value: '<code>inline.code()</code>',
-		id: 'inlinecode',
-		children: []
-	}
-];
-
-## _Emphasis_
-
-### **Importance**
-
-## ~~Strikethrough~~
-
-## <i>HTML</i>
-
-## \`inline.code()\`
-"
-`;

package/src/remark/toc/__tests__/fixtures/empty-headings.md

@@ -1,5 +0,0 @@
-# Ignore this
-
-##
-
-## ![](an-image.svg)

package/src/remark/toc/__tests__/fixtures/inline-code.md

@@ -1,9 +0,0 @@
-## `<Head />`
-
-### `<Head>Test</Head>`
-
-## `<div />`
-
-## `<div> Test </div>`
-
-## `<div><i>Test</i></div>`

package/src/remark/toc/__tests__/fixtures/insert-below-imports.md

@@ -1,11 +0,0 @@
-import something from 'something';
-
-import somethingElse from 'something-else';
-
-## Title
-
-## Test
-
-### Again
-
-Content.

package/src/remark/toc/__tests__/fixtures/just-content.md

@@ -1,15 +0,0 @@
-### Endi
-
-```md
-## This is ignored
-```
-
-## Endi
-
-Lorem ipsum
-
-### Yangshun
-
-Some content here
-
-## I ♥ unicode.

package/src/remark/toc/__tests__/fixtures/name-exist.md

@@ -1,7 +0,0 @@
-export const toc = ['replaceMe'];
-
-## Thanos
-
-## Tony Stark
-
-### Avengers

package/src/remark/toc/__tests__/fixtures/non-text-content.md

@@ -1,9 +0,0 @@
-## _Emphasis_
-
-### **Importance**
-
-## ~~Strikethrough~~
-
-## <i>HTML</i>
-
-## `inline.code()`

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

@@ -1,212 +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 '../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)
-    .process(file);
-
-  return result.toString();
-};
-
-test('non text phrasing content', async () => {
-  const result = await processFixture('non-text-content');
-  expect(result).toMatchSnapshot();
-});
-
-test('inline code should be escaped', async () => {
-  const result = await processFixture('inline-code');
-  expect(result).toMatchSnapshot();
-});
-
-test('text content', async () => {
-  const result = await processFixture('just-content');
-  expect(result).toMatchInlineSnapshot(`
-    "export const toc = [
-    	{
-    		value: 'Endi',
-    		id: 'endi',
-    		children: []
-    	},
-    	{
-    		value: 'Endi',
-    		id: 'endi-1',
-    		children: [
-    			{
-    				value: 'Yangshun',
-    				id: 'yangshun',
-    				children: []
-    			}
-    		]
-    	},
-    	{
-    		value: 'I ♥ unicode.',
-    		id: 'i--unicode',
-    		children: []
-    	}
-    ];
-
-    ### Endi
-
-    \`\`\`md
-    ## This is ignored
-    \`\`\`
-
-    ## Endi
-
-    Lorem ipsum
-
-    ### Yangshun
-
-    Some content here
-
-    ## I ♥ unicode.
-    "
-  `);
-});
-
-test('should export even with existing name', async () => {
-  const result = await processFixture('name-exist');
-  expect(result).toMatchInlineSnapshot(`
-    "export const toc = [
-    	{
-    		value: 'Thanos',
-    		id: 'thanos',
-    		children: []
-    	},
-    	{
-    		value: 'Tony Stark',
-    		id: 'tony-stark',
-    		children: [
-    			{
-    				value: 'Avengers',
-    				id: 'avengers',
-    				children: []
-    			}
-    		]
-    	}
-    ];
-
-    ## Thanos
-
-    ## Tony Stark
-
-    ### Avengers
-    "
-  `);
-});
-
-test('should export with custom name', async () => {
-  const options = {
-    name: 'customName',
-  };
-  const result = await processFixture('just-content', options);
-  expect(result).toMatchInlineSnapshot(`
-    "export const customName = [
-    	{
-    		value: 'Endi',
-    		id: 'endi',
-    		children: []
-    	},
-    	{
-    		value: 'Endi',
-    		id: 'endi-1',
-    		children: [
-    			{
-    				value: 'Yangshun',
-    				id: 'yangshun',
-    				children: []
-    			}
-    		]
-    	},
-    	{
-    		value: 'I ♥ unicode.',
-    		id: 'i--unicode',
-    		children: []
-    	}
-    ];
-
-    ### Endi
-
-    \`\`\`md
-    ## This is ignored
-    \`\`\`
-
-    ## Endi
-
-    Lorem ipsum
-
-    ### Yangshun
-
-    Some content here
-
-    ## I ♥ unicode.
-    "
-  `);
-});
-
-test('should insert below imports', async () => {
-  const result = await processFixture('insert-below-imports');
-  expect(result).toMatchInlineSnapshot(`
-    "import something from 'something';
-
-    import somethingElse from 'something-else';
-
-    export const toc = [
-    	{
-    		value: 'Title',
-    		id: 'title',
-    		children: []
-    	},
-    	{
-    		value: 'Test',
-    		id: 'test',
-    		children: [
-    			{
-    				value: 'Again',
-    				id: 'again',
-    				children: []
-    			}
-    		]
-    	}
-    ];
-
-    ## Title
-
-    ## Test
-
-    ### Again
-
-    Content.
-    "
-  `);
-});
-
-test('empty headings', async () => {
-  const result = await processFixture('empty-headings');
-  expect(result).toMatchInlineSnapshot(`
-    "export const toc = [];
-
-    # Ignore this
-
-    ## 
-
-    ## ![](an-image.svg)
-    "
-  `);
-});