♻️ refactor(plugin): refactor gitmoji regex into a new repo for reuse

Author: arvinxx

packages/commitlint-plugin/package.json

@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "@commitlint/types": "^17",
-    "emoji-regex": "^10",
+    "@gitmoji/gitmoji-regex": "0.0.0",
     "gitmojis": "^3"
   },
   "publishConfig": {

packages/commitlint-plugin/src/rule.ts

@@ -1,20 +1,16 @@
 import type { Rule } from '@commitlint/types';
-import emojiRegex from 'emoji-regex';
+import { emojiRegex, gitmojiUnicodeRegex, gitmojiCodeRegex } from '@gitmoji/gitmoji-regex';
 
 import { gitmojiCodes, gitmojiUnicode } from './gitmojiCode';
 
-const gitjimojiCodeStr = `:\\w*:`;
-const gitmojiUnicodeStr = gitmojiUnicode.filter((i) => i).join('|');
-const emojiStr = emojiRegex().source;
-
 const emoji: Rule = (parsed) => {
   const { raw } = parsed;
 
   // code regex test url: https://regex101.com/r/fSdOvB/1
-  const gitmojiCodeResult = new RegExp(`(${gitjimojiCodeStr})\\s.*`, 'gm').exec(raw);
+  const gitmojiCodeResult = new RegExp(`(${gitmojiCodeRegex.source})\\s.*`, 'gm').exec(raw);
   // unicode regex test url: https://regex101.com/r/shBTBg/2
-  const gitmojiUnicodeResult = new RegExp(`(${gitmojiUnicodeStr})\\s.*`, 'gm').exec(raw);
-  const emojiResult = new RegExp(`(${emojiStr})\\s.*`, 'gm').exec(raw);
+  const gitmojiUnicodeResult = new RegExp(`(${gitmojiUnicodeRegex.source})\\s.*`, 'gm').exec(raw);
+  const emojiResult = new RegExp(`(${emojiRegex.source})\\s.*`, 'gm').exec(raw);
 
   let pass;
   let errorMsg = 'passed';

packages/commitlint-plugin/test/rule.test.ts

@@ -69,7 +69,7 @@ describe('commit start with gitmoji code', () => {
     expect(value).toEqual([true, 'passed']);
   });
 
-  it('every emoji in list past', () => {
+  it('every emoji in gitmoji list should pass', () => {
     const gitmojiUnicode: string[] = gitmojis.map((gitmoji) => gitmoji.emoji);
 
     gitmojiUnicode.forEach((unicode) => {

packages/gitmoji-regex/.changelogrc.js

@@ -0,0 +1,6 @@
+const base = require('../../.changelogrc');
+
+module.exports = {
+  ...base,
+  displayScopes: ['gitmoji-regex'],
+};

packages/gitmoji-regex/.fatherrc.ts

@@ -0,0 +1,3 @@
+import config from '../../.fatherrc';
+
+export default config;

packages/gitmoji-regex/CHANGELOG.md

@@ -0,0 +1,34 @@
+# @gitmoji/gitmoji-regex
+
+[![NPM version][version-image]][version-url] [![NPM downloads][download-image]][download-url]
+
+a gitmoji regex to for both gitmoji code and gitmoji unicode
+
+this package is used in both [@gitmoji/parser-opts](../parser-opts) and [commitlint-plugin-gitmoji](../commitlint-plugin)
+
+## emojiRegex
+
+## gitmojiCodeRegex
+
+## gitmojiUnicodeRegex
+
+Header regex pattern test here : [Regex101](https://regex101.com/r/gYkG99/1)
+
+```js
+module.exports = {
+  headerPattern:
+    /^(?::\w*:|(?:\ud83c[\udf00-\udfff])|(?:\ud83d[\udc00-\ude4f\ude80-\udeff])|[\u2600-\u2B55])\s(?<type>\w*)(?:\((?<scope>.*)\))?!?:\s(?<subject>(?:(?!#).)*(?:(?!\s).))(?:\s\(?(?<ticket>#\d*)\)?)?$/,
+  headerCorrespondence: ['type', 'scope', 'subject', 'ticket'],
+};
+```
+
+## License
+
+[MIT](../../LICENSE) ® Arvin Xu
+
+<!-- npm url -->
+
+[version-image]: http://img.shields.io/npm/v/@gitmoji/gitmoji-regex.svg?color=deepgreen&label=latest
+[version-url]: http://npmjs.org/package/@gitmoji/gitmoji-regex
+[download-image]: https://img.shields.io/npm/dm/@gitmoji/gitmoji-regex.svg
+[download-url]: https://npmjs.org/package/@gitmoji/gitmoji-regex

packages/gitmoji-regex/README.md

@@ -0,0 +1,15 @@
+import base from '../../jest.config.base';
+import { Config } from '@umijs/test';
+
+const packageName = '@gitmoji/gitmoji-regex';
+
+const root = '<rootDir>/packages/gitmoji-regex';
+
+const config: Config.InitialOptions = {
+  ...base,
+  rootDir: '../..',
+  roots: [root],
+  displayName: packageName,
+};
+
+export default config;

packages/gitmoji-regex/jest.config.ts

@@ -0,0 +1,33 @@
+{
+  "name": "@gitmoji/gitmoji-regex",
+  "version": "0.0.0",
+  "description": "a gitmoji regex to for both gitmoji code and gitmoji unicode",
+  "homepage": "https://github.com/arvinxx/gitmoji-commit-workflow/tree/master/packages/gitmoji-regex",
+  "bugs": {
+    "url": "https://github.com/arvinxx/gitmoji-commit-workflow/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/arvinxx/gitmoji-commit-workflow.git"
+  },
+  "license": "ISC",
+  "author": "arvinxx <[email protected]>",
+  "main": "lib/index.js",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "build": "father build",
+    "clean": "rm -rf es lib dist build coverage .eslintcache",
+    "cov": "jest --coverage",
+    "test": "jest"
+  },
+  "dependencies": {
+    "emoji-regex": "^10",
+    "gitmojis": "^3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

packages/gitmoji-regex/package.json

@@ -0,0 +1,10 @@
+import { gitmojis } from 'gitmojis';
+import _emojiRegex from 'emoji-regex';
+
+const gitmojiUnicode: string[] = gitmojis.map((gitmoji) => gitmoji.emoji);
+
+export const gitmojiCodeRegex = new RegExp(/:\w*:/);
+
+export const gitmojiUnicodeRegex = new RegExp(gitmojiUnicode.filter((i) => i).join('|'));
+
+export const emojiRegex = _emojiRegex();