✨ feat: support gitmoji unicode

Author: arvinxx

packages/plugin/.changelogrc.js

@@ -2,5 +2,4 @@ const base = require('../../.changelogrc');
 
 module.exports = {
   ...base,
-  displayScopes: ['plugin'],
 };

packages/plugin/package.json

@@ -36,5 +36,8 @@
   "license": "MIT",
   "peerDependencies": {
     "commitlint": "^11.0.0"
+  },
+  "dependencies": {
+    "emoji-unicode": "^2.0.1"
   }
 }

packages/plugin/src/gitmojiCode.ts

@@ -27,6 +27,8 @@ if (!existsSync(filePath)) {
 }
 // eslint-disable-next-line import/no-dynamic-require
 const { gitmojis } = require(filePath);
-const gitmojiCodes: string[] = gitmojis.map((gitmoji) => gitmoji.code);
+export const gitmojiCodes: string[] = gitmojis.map((gitmoji) => gitmoji.code);
 
-export default gitmojiCodes;
+export const gitmojiUnicode: string[] = gitmojis.map((gitmoji) =>
+  gitmoji.entity.replace('&#', '').replace(';', '').replace('x', ''),
+);

packages/plugin/src/rule.ts

@@ -1,27 +1,43 @@
 import type { Rule } from '@commitlint/types';
-import gitmojiCodes from './gitmojiCode';
+import { gitmojiCodes, gitmojiUnicode } from './gitmojiCode';
+import emojiUnicode from 'emoji-unicode';
 
 const emoji: Rule = (parsed) => {
   const { raw } = parsed;
 
-  const regex = /^(:\w*:)\s.*/gm; // regex test url: https://regex101.com/r/fSdOvB/1
+  // code regex test url: https://regex101.com/r/fSdOvB/1
+  const regex = /^(:\w*:)\s.*/gm;
+  // unicode regex test url: https://regex101.com/r/OTMgWL/2
+  const unicodeRegex = /(\ud83c[\udf00-\udfff]|\ud83d[\udc00-\ude4f\ude80-\udeff]|[\u2600-\u2B55])\s.*/gm;
+
   const result = regex.exec(raw);
+  const unicodeResult = unicodeRegex.exec(raw);
 
   let pass;
   let errorMsg = 'passed';
 
-  // if don't has emoji
-  if (!result) {
-    pass = false;
-    errorMsg =
-      'Your commit should start with gitmoji code,please check the emoji code on https://gitmoji.dev/.';
-  } else {
+  // if gitmoji code is valid
+  if (result) {
     const emojiCode = result[1];
-
     pass = gitmojiCodes.includes(emojiCode);
     if (!pass) {
       errorMsg = `${emojiCode} is not in the correct gitmoji list, please check the emoji code on https://gitmoji.dev/.`;
     }
+  } else if (unicodeResult) {
+    const unicode = unicodeResult[1];
+
+    const hasRaw = gitmojiUnicode.includes(emojiUnicode.raw(unicode));
+    const hasHex = gitmojiUnicode.includes(emojiUnicode(unicode));
+    pass = hasHex || hasRaw;
+
+    if (!pass) {
+      errorMsg = `${unicode} is not in the correct gitmoji list, please check the emoji code on https://gitmoji.dev/.`;
+    }
+  } else {
+    // if don't has gitmoji code or emoji unicode
+    pass = false;
+    errorMsg =
+      'Your commit should start with gitmoji code,please check the emoji code on https://gitmoji.dev/.';
   }
 
   return [pass, errorMsg];

packages/plugin/test/gitmojiCode.test.ts

@@ -10,14 +10,14 @@ describe('gitmojiCodes work well', () => {
 
     const gitmojiCodes = await import('../src/gitmojiCode');
 
-    expect(gitmojiCodes.default).toBeInstanceOf(Array);
+    expect(gitmojiCodes.gitmojiCodes).toBeInstanceOf(Array);
   });
 
   it('will download gitmoji json and write to file without gitmoji json', async () => {
     // 如果存在 gitmoji 直接删除
     if (existsSync(targetPath)) unlinkSync(targetPath);
     const gitmojiCodes = await import('../src/gitmojiCode');
-    expect(gitmojiCodes.default).toBeInstanceOf(Array);
+    expect(gitmojiCodes.gitmojiCodes).toBeInstanceOf(Array);
   });
 });
 
@@ -36,7 +36,7 @@ describe('gitmojiCodes throw Error', () => {
     if (existsSync(targetPath)) unlinkSync(targetPath);
     try {
       const gitmojiCodes = await import('../src/gitmojiCode');
-      expect(gitmojiCodes.default).toBeInstanceOf(Array);
+      expect(gitmojiCodes.gitmojiCodes).toBeInstanceOf(Array);
     } catch (e) {
       expect(e).toEqual(
         Error(

packages/plugin/test/rule.test.ts

@@ -21,8 +21,34 @@ describe('commit start with gitmoji code', () => {
     ]);
   });
 
-  it('should pass when return right commit message code', () => {
+  it('should failed if commit start with unrecognized gitmoji unicode', () => {
+    const value = emojiRule({ raw: '🤔 chore(scope): test' } as Commit, when);
+    expect(value).toEqual([
+      false,
+      'Your commit should start with gitmoji code,please check the emoji code on https://gitmoji.dev/.',
+    ]);
+  });
+
+  it('should failed if commit start with wrong gitmoji unicode', () => {
+    const value = emojiRule({ raw: '🌙 chore(scope): test' } as Commit, when);
+    expect(value).toEqual([
+      false,
+      '🌙 is not in the correct gitmoji list, please check the emoji code on https://gitmoji.dev/.',
+    ]);
+  });
+
+  it('should pass when return correct commit message code', () => {
     const value = emojiRule({ raw: ':tada: test' } as Commit, when);
     expect(value).toEqual([true, 'passed']);
   });
+
+  it('should pass when with correct gitmoji unicode', () => {
+    const value = emojiRule({ raw: '🎉 test' } as Commit, when);
+    expect(value).toEqual([true, 'passed']);
+  });
+
+  it('should pass when with correct test gitmoji unicode', () => {
+    const value = emojiRule({ raw: '✅ test' } as Commit, when);
+    expect(value).toEqual([true, 'passed']);
+  });
 });

yarn.lock

@@ -5757,6 +5757,11 @@ emoji-regex@^9.0.0:
   resolved "https://registry.npm.taobao.org/emoji-regex/download/emoji-regex-9.2.0.tgz?cache=0&sync_timestamp=1603212288390&other_urls=https%3A%2F%2Fregistry.npm.taobao.org%2Femoji-regex%2Fdownload%2Femoji-regex-9.2.0.tgz#a26da8e832b16a9753309f25e35e3c0efb9a066a"
   integrity sha1-om2o6DKxapdTMJ8l4148DvuaBmo=
 
+emoji-unicode@^2.0.1:
+  version "2.0.1"
+  resolved "https://registry.npm.taobao.org/emoji-unicode/download/emoji-unicode-2.0.1.tgz#37b05f0cd20254fd366d1df4442b5c613a3a021a"
+  integrity sha1-N7BfDNICVP02bR30RCtcYTo6Aho=
+
 emojis-list@^3.0.0:
   version "3.0.0"
   resolved "https://registry.npm.taobao.org/emojis-list/download/emojis-list-3.0.0.tgz#5570662046ad29e2e916e71aae260abdff4f6a78"