Add gemoji alias/tag data

Author: fileformat

.github/workflows/ghpages-deploy.yaml

@@ -36,6 +36,11 @@ jobs:
           ./bin/ucd_download.sh
           ./bin/ucd_to_json.mts
 
+      - name: Add gemoji data to JSON
+        run: |
+          ./bin/gemoji_download.sh
+          ./bin/gemoji_add.mts
+
       - name: Set Status Info
         run: |
           ./bin/set_status.sh

README.md

@@ -25,6 +25,8 @@ See it in action: [emojisearch.org](https://www.emojisearch.org/)
 [![VectorLogoZone](https://www.vectorlogo.zone/logos/vectorlogozone/vectorlogozone-ar21.svg)](https://www.vectorlogo.zone/ "Logos")
 [![Vite](https://www.vectorlogo.zone/logos/vitejsdev/vitejsdev-ar21.svg)](https://vitejs.dev/ "Bundler")
 
+* [Gemoji](https://github.com/github/gemoji)
+
 ## To Do
 
 - [ ] images

bin/gemoji_add.mts

@@ -0,0 +1,97 @@
+#!/usr/bin/env node
+
+import fs from 'fs/promises';
+import path from 'path';
+import { XMLParser } from 'fast-xml-parser';
+import { fileURLToPath } from "url";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+type SearchEntry = {
+	codepoints: string;
+	qualification: string;
+	version: string;
+	emoji: string;
+	description: string;
+	group: string;
+	subgroup: string;
+	keywords?: string[];
+}
+
+type SearchData = {
+	success: boolean;
+	lastmod: string;
+	data: SearchEntry[];
+}
+
+type GemojiEntry = {
+	emoji: string;
+	description: string;
+	aliases: string[];
+	tags: string[];
+};
+
+async function main() {
+	console.log(`INFO: starting at ${new Date().toISOString()}`);
+
+	const gemojiPath = path.join( __dirname, '..', 'tmp', 'gemoji.json' );
+	const jsonPath = path.join( __dirname, '..', 'public', 'emoji.json' );
+
+	try {
+		await fs.access(gemojiPath);
+	} catch (err) {
+		console.log(`INFO: gemoji file does not exist in ${gemojiPath}`);
+		process.exit(1);
+	}
+
+	// Read and parse the Gemoji file
+	console.log(`INFO: reading file from ${gemojiPath}`);
+	const gemojiData = await fs.readFile(gemojiPath, "utf-8");
+	console.log(`INFO: parsing gemoji data`);
+	const gemoji = JSON.parse(gemojiData) as GemojiEntry[];
+
+	const gemojiMap: Map<string, GemojiEntry> = new Map();
+	for (const entry of gemoji) {
+		gemojiMap.set(entry.emoji, entry);
+	}
+
+	try {
+		await fs.access(jsonPath);
+	} catch (err) {
+		console.log(`INFO: data file does not exist in ${jsonPath}`);
+		process.exit(1);
+	}
+
+	// read and parse the emoji.json file
+	console.log(`INFO: reading file from ${jsonPath}`);
+	const rawData = await fs.readFile(jsonPath, "utf-8");
+	console.log(`INFO: parsing emoji data`);
+	const data = JSON.parse(rawData) as SearchData;
+
+	for (const row of data.data) {
+		const gemojiEntry = gemojiMap.get(row.emoji);
+		if (!gemojiEntry) {
+			console.log(`WARN: no gemoji entry found for emoji ${row.emoji} (${row.description})`);
+			continue;
+		}
+
+		// merge tags and aliases
+		const newTags = new Set<string>([...gemojiEntry.tags, ...gemojiEntry.aliases]);
+		if (newTags.size === 0) {
+			continue;
+		}
+		row.keywords = Array.from(newTags);
+	}
+
+	// save the updated json data
+	console.log(`INFO: writing emoji data to ${jsonPath}`);
+	await fs.writeFile(jsonPath, JSON.stringify(data, null, 2), 'utf-8');
+	console.log(`INFO: wrote JSON data to ${jsonPath}`);
+}
+
+
+
+main().then( () => {
+	console.log(`INFO: complete at ${new Date().toISOString()}`);
+});

bin/gemoji_download.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+#
+# Download gemoji data from Github
+#
+
+set -o nounset
+set -o errexit
+set -o pipefail
+
+SCRIPT_HOME="$( cd "$( dirname "$0" )" && pwd )"
+BASE_DIR=$(realpath "${SCRIPT_HOME}/..")
+
+echo "INFO: starting gemoji download at $(date -u +"%Y-%m-%dT%H:%M:%SZ")"
+
+TMP_DIR="${BASE_DIR}/tmp"
+if [ ! -d "${TMP_DIR}" ]; then
+	echo "INFO: creating temp dir ${TMP_DIR}"
+	mkdir -p "${TMP_DIR}"
+else
+	echo "INFO: using existing temp dir ${TMP_DIR}"
+fi
+
+curl \
+	--location \
+	--output "${TMP_DIR}/gemoji.json" \
+	--show-error \
+	--silent \
+	https://raw.githubusercontent.com/github/gemoji/refs/heads/master/db/emoji.json
+
+echo "INFO: completed gemoji download at $(date -u +"%Y-%m-%dT%H:%M:%SZ")"

src/index.ts

@@ -26,6 +26,7 @@ type SearchEntry = {
 	version: string;
 	group: string;
 	subgroup: string;
+	keywords?: string[];
 };
 
 type SearchData = {
@@ -38,6 +39,7 @@ type EmojiData = {
 	emoji: string;
 	description: string;
 	tags: string[];
+	keywords?: string[];
 }
 
 const dataUrl = "/emoji.json";
@@ -50,12 +52,17 @@ function filterDescription(
 ) {
 	if (!headerValue) return true;
 
-	const rowValue = rowData.description as string;
+	const rowValues = [rowData.description, ...(rowData.keywords || [])];
 
 	if (headerValue.length == 1 && headerValue != "^" && headerValue != "/") {
 		// single character, do starts with
 		const search = headerValue.toLowerCase();
-		return rowValue.toLowerCase().startsWith(search);
+		for (const rowValue of rowValues) {
+			if (rowValue.toLowerCase().startsWith(search)) {
+				return true;
+			}
+		}
+		return false;
 	}
 
 	if (headerValue.startsWith("^")) {
@@ -64,15 +71,25 @@ function filterDescription(
 			return true;
 		}
 		const search = headerValue.substring(1).toLowerCase();
-		return rowValue.toLowerCase().startsWith(search);
+		for (const rowValue of rowValues) {
+			if (rowValue.toLowerCase().startsWith(search)) {
+				return true;
+			}
+		}
+		return false;
 	}
 
 	if (headerValue.startsWith("/") && headerValue.endsWith("/")) {
 		// regex
 		const pattern = headerValue.substring(1, headerValue.length - 1);
 		try {
 			const re = new RegExp(pattern, "i");
-			return re.test(rowValue);
+			for (const rowValue of rowValues) {
+				if (re.test(rowValue)) {
+					return true;
+				}
+			}
+			return false;
 		} catch (e) {
 			// bad regex
 			return false;
@@ -81,7 +98,12 @@ function filterDescription(
 
 	// contains
 	const search = headerValue.toLowerCase();
-	return rowValue.toLowerCase().includes(search);
+	for (const rowValue of rowValues) {
+		if (rowValue.toLowerCase().includes(search)) {
+			return true;
+		}
+	}
+	return false;
 }
 
 function filterTags(
@@ -235,6 +257,7 @@ async function main() {
 			emoji: row.emoji,
 			description: row.description,
 			tags,
+			keywords: row.keywords,
 		} );
 	}