renovate/lib/util/markdown.spec.ts

import { codeBlock } from 'common-tags';
import { linkify, sanitizeMarkdown } from './markdown.ts';

describe('util/markdown', () => {
  describe('.linkify', () => {
    const before = codeBlock`
      Some references:

      *   Commit: f8083175fe890cbf14f41d0a06e7aa35d4989587
      *   Commit (fork): foo@f8083175fe890cbf14f41d0a06e7aa35d4989587
      *   Commit (repo): remarkjs/remark@e1aa9f6c02de18b9459b7d269712bcb50183ce89
      *   Issue or PR (\`#\`): #1
      *   Issue or PR (\`GH-\`): GH-1
      *   Issue or PR (fork): foo#1
      *   Issue or PR (project): remarkjs/remark#1
      *   Mention: @wooorm
    `;

    const after = `${codeBlock`
        Some references:

        - Commit: [\`f808317\`](https://github.com/some/repo/commit/f8083175fe890cbf14f41d0a06e7aa35d4989587)
        - Commit (fork): [foo@\`f808317\`](https://github.com/foo/repo/commit/f8083175fe890cbf14f41d0a06e7aa35d4989587)
        - Commit (repo): [remarkjs/remark@\`e1aa9f6\`](https://github.com/remarkjs/remark/commit/e1aa9f6c02de18b9459b7d269712bcb50183ce89)
        - Issue or PR (\`#\`): [#1](https://github.com/some/repo/issues/1)
        - Issue or PR (\`GH-\`): [GH-1](https://github.com/some/repo/issues/1)
        - Issue or PR (fork): [foo#1](https://github.com/foo/repo/issues/1)
        - Issue or PR (project): [remarkjs/remark#1](https://github.com/remarkjs/remark/issues/1)
        - Mention: [@wooorm](https://github.com/wooorm)
    `}\n`;

    it('works', async () => {
      const res = await linkify(before, { repository: 'some/repo' });
      expect(res).toEqual(after);
    });

    it('works with gitlab', async () => {
      const res = await linkify(
        `(https://company.gitlab.local/shared/scanner/-/merge_requests/1177)`,
        { repository: 'some/repo' },
      );
      expect(res.toString()).toEqual(
        `(<https://company.gitlab.local/shared/scanner/-/merge_requests/1177>)\n`,
      );
    });

    it('sanitizeMarkdown check massaged release notes', () => {
      const input = codeBlock`
          #### Our Gold Sponsors

          <table>
          </table>

          #### Our Silver Sponsors

          <table>
          </table>

          #### What's Changed
          * pnpm rebuild accepts --store-dir by @user in https://github.com/foo/foo/pull/1

          #### New Contributors
          * @user made their first contribution in https://github.com/foo/foo/pull/2

          #### [Heading With Markdown Link](https://github.com/foo/foo/blob/HEAD/CHANGELOG.md#1234-2023-07-03)
          * link to GH issue [#1234](https://github.com/some/repo/issues/1234)
        `;

      expect(sanitizeMarkdown(input)).toEqual(codeBlock`
        #### Our Gold Sponsors

        <table>
        </table>

        #### Our Silver Sponsors

        <table>
        </table>

        #### What's Changed
        * pnpm rebuild accepts --store-dir by @&#8203;user in https://github.com/foo/foo/pull/1

        #### New Contributors
        * @&#8203;user made their first contribution in https://github.com/foo/foo/pull/2

        #### [Heading With Markdown Link](https://github.com/foo/foo/blob/HEAD/CHANGELOG.md#1234-2023-07-03)
        * link to GH issue [#&#8203;1234](https://github.com/some/repo/issues/1234)
      `);
    });
  });

  describe('.sanitizeMarkdown', () => {
    it('should not add zero-width space to @ inside triple-backtick code blocks', () => {
      const input = codeBlock`
        \`\`\`
          import foo from '@atlaskit/tokens';
        \`\`\`
      `;

      expect(sanitizeMarkdown(input)).toEqual(input);
    });

    it('should not add zero-width space to @ inside inline code spans', () => {
      const input = 'Use `@atlaskit/tokens` here';
      expect(sanitizeMarkdown(input)).toEqual(input);
    });

    it('should add zero-width space to @ in regular text', () => {
      expect(sanitizeMarkdown('mention @user here')).toEqual(
        'mention @&#8203;user here',
      );
    });

    it('should not add zero-width space to @ inside URLs', async () => {
      const input =
        'Read more at https://medium.com/@fastifyjs/fastify-v4-ga-59f2103b5f0e by @user';
      const linkified = await linkify(input, { repository: 'some/repo' });

      expect(sanitizeMarkdown(linkified)).toEqual(
        'Read more at <https://medium.com/@fastifyjs/fastify-v4-ga-59f2103b5f0e> by [@&#8203;user](https://github.com/user)\n',
      );
    });
  });
});