discord.js/packages/discord.js/test/escapeMarkdown.test.js

'use strict';

/* eslint-env jest */
/* eslint-disable max-len */

const Util = require('../src/util/Util');
const testString = "`_Behold!_`\n||___~~***```js\n`use strict`;\nrequire('discord.js');```***~~___||";
const testStringForums =
  '# Title\n## Subtitle\n### Subsubtitle\n- Bullet list\n - # Title with bullet\n * Subbullet\n1. Number list\n 1. Sub number list';

describe('escapeCodeblock', () => {
  test('shared', () => {
    expect(Util.escapeCodeBlock(testString)).toEqual(
      "`_Behold!_`\n||___~~***\\`\\`\\`js\n`use strict`;\nrequire('discord.js');\\`\\`\\`***~~___||",
    );
  });

  test('basic', () => {
    expect(Util.escapeCodeBlock('```test```')).toEqual('\\`\\`\\`test\\`\\`\\`');
  });
});

describe('escapeInlineCode', () => {
  test('shared', () => {
    expect(Util.escapeInlineCode(testString)).toEqual(
      "\\`_Behold!_\\`\n||___~~***```js\n\\`use strict\\`;\nrequire('discord.js');```***~~___||",
    );
  });

  test('basic', () => {
    expect(Util.escapeInlineCode('`test`')).toEqual('\\`test\\`');
  });
});

describe('escapeBold', () => {
  test('shared', () => {
    expect(Util.escapeBold(testString)).toEqual(
      "`_Behold!_`\n||___~~*\\*\\*```js\n`use strict`;\nrequire('discord.js');```\\*\\**~~___||",
    );
  });

  test('basic', () => {
    expect(Util.escapeBold('**test**')).toEqual('\\*\\*test\\*\\*');
  });
});

describe('escapeItalic', () => {
  test('shared', () => {
    expect(Util.escapeItalic(testString)).toEqual(
      "`\\_Behold!\\_`\n||\\___~~\\***```js\n`use strict`;\nrequire('discord.js');```**\\*~~__\\_||",
    );
  });

  test('basic (_)', () => {
    expect(Util.escapeItalic('_test_')).toEqual('\\_test\\_');
  });

  test('basic (*)', () => {
    expect(Util.escapeItalic('*test*')).toEqual('\\*test\\*');
  });
});

describe('escapeUnderline', () => {
  test('shared', () => {
    expect(Util.escapeUnderline(testString)).toEqual(
      "`_Behold!_`\n||_\\_\\_~~***```js\n`use strict`;\nrequire('discord.js');```***~~\\_\\__||",
    );
  });

  test('basic', () => {
    expect(Util.escapeUnderline('__test__')).toEqual('\\_\\_test\\_\\_');
  });
});

describe('escapeStrikethrough', () => {
  test('shared', () => {
    expect(Util.escapeStrikethrough(testString)).toEqual(
      "`_Behold!_`\n||___\\~\\~***```js\n`use strict`;\nrequire('discord.js');```***\\~\\~___||",
    );
  });

  test('basic', () => {
    expect(Util.escapeStrikethrough('~~test~~')).toEqual('\\~\\~test\\~\\~');
  });
});

describe('escapeSpoiler', () => {
  test('shared', () => {
    expect(Util.escapeSpoiler(testString)).toEqual(
      "`_Behold!_`\n\\|\\|___~~***```js\n`use strict`;\nrequire('discord.js');```***~~___\\|\\|",
    );
  });

  test('basic', () => {
    expect(Util.escapeSpoiler('||test||')).toEqual('\\|\\|test\\|\\|');
  });
});

describe('escapeHeading', () => {
  test('shared', () => {
    expect(Util.escapeHeading(testStringForums)).toEqual(
      '\\# Title\n\\## Subtitle\n\\### Subsubtitle\n- Bullet list\n - \\# Title with bullet\n * Subbullet\n1. Number list\n 1. Sub number list',
    );
  });

  test('basic', () => {
    expect(Util.escapeHeading('# test')).toEqual('\\# test');
  });
});

describe('escapeBulletedList', () => {
  test('shared', () => {
    expect(Util.escapeBulletedList(testStringForums)).toEqual(
      '# Title\n## Subtitle\n### Subsubtitle\n\\- Bullet list\n \\- # Title with bullet\n \\* Subbullet\n1. Number list\n 1. Sub number list',
    );
  });

  test('basic', () => {
    expect(Util.escapeBulletedList('- test')).toEqual('\\- test');
  });
});

describe('escapeNumberedList', () => {
  test('shared', () => {
    expect(Util.escapeNumberedList(testStringForums)).toEqual(
      '# Title\n## Subtitle\n### Subsubtitle\n- Bullet list\n - # Title with bullet\n * Subbullet\n1\\. Number list\n 1\\. Sub number list',
    );
  });

  test('basic', () => {
    expect(Util.escapeNumberedList('1. test')).toEqual('1\\. test');
  });
});

describe('escapeMaskedLink', () => {
  test('basic', () => {
    expect(Util.escapeMaskedLink('[test](https://discord.js.org)')).toEqual('\\[test](https://discord.js.org)');
  });
});

describe('escapeMarkdown', () => {
  test('shared', () => {
    expect(Util.escapeMarkdown(testString)).toEqual(
      "\\`\\_Behold!\\_\\`\n\\|\\|\\_\\_\\_\\~\\~\\*\\*\\*\\`\\`\\`js\n\\`use strict\\`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*\\~\\~\\_\\_\\_\\|\\|",
    );
  });

  test('no codeBlock', () => {
    expect(Util.escapeMarkdown(testString, { codeBlock: false })).toEqual(
      "\\`\\_Behold!\\_\\`\n\\|\\|\\_\\_\\_\\~\\~\\*\\*\\*```js\n\\`use strict\\`;\nrequire('discord.js');```\\*\\*\\*\\~\\~\\_\\_\\_\\|\\|",
    );
  });

  test('no inlineCode', () => {
    expect(Util.escapeMarkdown(testString, { inlineCode: false })).toEqual(
      "`\\_Behold!\\_`\n\\|\\|\\_\\_\\_\\~\\~\\*\\*\\*\\`\\`\\`js\n`use strict`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*\\~\\~\\_\\_\\_\\|\\|",
    );
  });

  test('no bold', () => {
    expect(Util.escapeMarkdown(testString, { bold: false })).toEqual(
      "\\`\\_Behold!\\_\\`\n\\|\\|\\_\\_\\_\\~\\~\\***\\`\\`\\`js\n\\`use strict\\`;\nrequire('discord.js');\\`\\`\\`**\\*\\~\\~\\_\\_\\_\\|\\|",
    );
  });

  test('no italic', () => {
    expect(Util.escapeMarkdown(testString, { italic: false })).toEqual(
      "\\`_Behold!_\\`\n\\|\\|_\\_\\_\\~\\~*\\*\\*\\`\\`\\`js\n\\`use strict\\`;\nrequire('discord.js');\\`\\`\\`\\*\\**\\~\\~\\_\\__\\|\\|",
    );
  });

  test('no underline', () => {
    expect(Util.escapeMarkdown(testString, { underline: false })).toEqual(
      "\\`\\_Behold!\\_\\`\n\\|\\|\\___\\~\\~\\*\\*\\*\\`\\`\\`js\n\\`use strict\\`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*\\~\\~__\\_\\|\\|",
    );
  });

  test('no strikethrough', () => {
    expect(Util.escapeMarkdown(testString, { strikethrough: false })).toEqual(
      "\\`\\_Behold!\\_\\`\n\\|\\|\\_\\_\\_~~\\*\\*\\*\\`\\`\\`js\n\\`use strict\\`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*~~\\_\\_\\_\\|\\|",
    );
  });

  test('no spoiler', () => {
    expect(Util.escapeMarkdown(testString, { spoiler: false })).toEqual(
      "\\`\\_Behold!\\_\\`\n||\\_\\_\\_\\~\\~\\*\\*\\*\\`\\`\\`js\n\\`use strict\\`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*\\~\\~\\_\\_\\_||",
    );
  });

  describe('code content', () => {
    test('no code block content', () => {
      expect(Util.escapeMarkdown(testString, { codeBlockContent: false })).toEqual(
        "\\`\\_Behold!\\_\\`\n\\|\\|\\_\\_\\_\\~\\~\\*\\*\\*\\`\\`\\`js\n`use strict`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*\\~\\~\\_\\_\\_\\|\\|",
      );
    });

    test('no inline code content', () => {
      expect(Util.escapeMarkdown(testString, { inlineCodeContent: false })).toEqual(
        "\\`_Behold!_\\`\n\\|\\|\\_\\_\\_\\~\\~\\*\\*\\*\\`\\`\\`js\n\\`use strict\\`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*\\~\\~\\_\\_\\_\\|\\|",
      );
    });

    test('neither inline code or code block content', () => {
      expect(Util.escapeMarkdown(testString, { inlineCodeContent: false, codeBlockContent: false }))
        // eslint-disable-next-line max-len
        .toEqual(
          "\\`_Behold!_\\`\n\\|\\|\\_\\_\\_\\~\\~\\*\\*\\*\\`\\`\\`js\n`use strict`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*\\~\\~\\_\\_\\_\\|\\|",
        );
    });

    test('neither code blocks or code block content', () => {
      expect(Util.escapeMarkdown(testString, { codeBlock: false, codeBlockContent: false })).toEqual(
        "\\`\\_Behold!\\_\\`\n\\|\\|\\_\\_\\_\\~\\~\\*\\*\\*```js\n`use strict`;\nrequire('discord.js');```\\*\\*\\*\\~\\~\\_\\_\\_\\|\\|",
      );
    });

    test('neither inline code or inline code content', () => {
      expect(Util.escapeMarkdown(testString, { inlineCode: false, inlineCodeContent: false })).toEqual(
        "`_Behold!_`\n\\|\\|\\_\\_\\_\\~\\~\\*\\*\\*\\`\\`\\`js\n`use strict`;\nrequire('discord.js');\\`\\`\\`\\*\\*\\*\\~\\~\\_\\_\\_\\|\\|",
      );
    });

    test('edge-case odd number of fences with no code block content', () => {
      expect(
        Util.escapeMarkdown('**foo** ```**bar**``` **fizz** ``` **buzz**', {
          codeBlock: false,
          codeBlockContent: false,
        }),
      ).toEqual('\\*\\*foo\\*\\* ```**bar**``` \\*\\*fizz\\*\\* ``` \\*\\*buzz\\*\\*');
    });

    test('edge-case odd number of backticks with no inline code content', () => {
      expect(
        Util.escapeMarkdown('**foo** `**bar**` **fizz** ` **buzz**', { inlineCode: false, inlineCodeContent: false }),
      ).toEqual('\\*\\*foo\\*\\* `**bar**` \\*\\*fizz\\*\\* ` \\*\\*buzz\\*\\*');
    });
  });
});

/* eslint-enable max-len, no-undef */