renovate/lib/util/emoji.spec.ts

import { fromCodepointToUnicode, fromHexcodeToCodepoint } from 'emojibase';
import { emojify, setEmojiConfig, stripEmojis, unemojify } from './emoji.ts';

describe('util/emoji', () => {
  beforeEach(() => {
    setEmojiConfig({ unicodeEmoji: true });
  });

  describe('emojify', () => {
    it('encodes known shortcodes', () => {
      expect(emojify('Let it :bee:')).toBe('Let it 🐝');
    });

    it('encodes aliases', () => {
      const bee = emojify(':bee:');
      const honeyBee = emojify(':honeybee:');
      expect(bee).toEqual(honeyBee);
    });

    it('omits unknown shortcodes', () => {
      expect(emojify(':foo: :bar: :bee:')).toBe(':foo: :bar: 🐝');
    });

    it('convert warning shortcode to emoji', () => {
      const warning = emojify(':warning:');
      expect(warning).toBe('⚠️');
    });

    it('does not encode when config option is disabled', () => {
      setEmojiConfig({ unicodeEmoji: false });
      expect(emojify('Let it :bee:')).toBe('Let it :bee:');
    });
  });

  describe('unemojify', () => {
    it('strips emojis when the config has been set accordingly', () => {
      const emoji = '🚀💎';
      const otherText = 'regular text';
      const text = `${emoji} ${otherText}`;
      setEmojiConfig({ unicodeEmoji: false });
      const result = unemojify(text);
      expect(result).not.toContain(emoji);
    });

    it('does not strip emojis when the config demands it', () => {
      const emoji = '🚀💎';
      const otherText = 'regular text';
      const text = `${emoji} ${otherText}`;
      setEmojiConfig({ unicodeEmoji: true });
      const result = unemojify(text);
      expect(result).toEqual(text);
    });

    it('converts warning emoji to shortcode', () => {
      setEmojiConfig({ unicodeEmoji: false });
      const emoji = '⚠️';
      const result = unemojify(emoji);
      expect(result).toBe(':warning:');
    });
  });

  describe('problematic characters', () => {
    it.each(['🚀', '💎', '🧹', '📦', '⚠️'])(
      'converts %s forth and back',
      (char) => {
        setEmojiConfig({ unicodeEmoji: false });
        const codified = unemojify(char);
        expect(codified).not.toEqual(char);

        setEmojiConfig({ unicodeEmoji: true });
        const emojified = emojify(codified);
        expect(emojified).toEqual(char);
      },
    );
  });

  describe('stripEmojis', () => {
    function makeEmoji(hexCode: string): string {
      return fromCodepointToUnicode(fromHexcodeToCodepoint(hexCode));
    }

    it('is independent of config option', () => {
      const x: string = makeEmoji('26A0-FE0F');
      const y: string = makeEmoji('26A0');

      setEmojiConfig({ unicodeEmoji: true });
      expect(stripEmojis(`foo ${x} bar`)).toBe(`foo ${y} bar`);

      setEmojiConfig({ unicodeEmoji: false });
      expect(stripEmojis(`foo ${x} bar`)).toBe(`foo ${y} bar`);
    });

    it('does not throw on standalone modifiers', () => {
      // This is based on a string from an actual PR description.
      expect(stripEmojis("foo '🏻' bar")).toBe("foo '' bar");
    });
  });
});