🏷️ Add TypeScript type declarations to gitmojis package (#1247)

* 🏷️ Add `gitmojis.d.ts` TypeScript module declaration
* 🔧 Add `types` field to `package.json`

packages/gitmojis/package.json

@@ -6,6 +6,7 @@
   "files": [
     "src/gitmojis.json"
   ],
+  "types": "src/gitmojis.d.ts",
   "scripts": {
     "lint": "jsonlint ./src/gitmojis.json -V ./src/schema.json",
     "publishPackage": "npm publish"

packages/gitmojis/src/gitmojis.d.ts

@@ -0,0 +1,34 @@
+declare module 'gitmojis' {
+  type Gitmoji = {
+    /**
+     * Gitmoji unicode character
+     * @example '🎨', '⚡️', '🔥', '🐛'
+     */
+    readonly emoji: string;
+    /**
+     * Gitmoji hexadecimal entity.
+     * @example '🎨', '⚡', '🔥', '🐛'
+     */
+    readonly entity: `&#${string};`;
+    /**
+     * Gitmoji use-case description.
+     */
+    readonly description: string;
+    /**
+     * Gitmoji name.
+     * @example 'art', 'zap', 'fire', 'bug'
+     */
+    readonly name: string;
+    /**
+     * Gitmoji semver range. Can be `null` if not specified.
+     */
+    readonly semver: 'patch' | 'minor' | 'major' | null;
+    /**
+     * Gitmoji character formatted as a shortcode.
+     * @example ':art:', ':zap:', ':fire:', ':bug:'
+     */
+    readonly code: `:${string}:`;
+  }
+
+  export const gitmojis: readonly Gitmoji[];
+}