refactor: add undefined return for getShortcode function

FlorianWoelki · Oct 22, 2023 · de9fca7 · de9fca7
1 parent ad08f06
commit de9fca7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 8 deletions.
diff --git a/src/editor/icons-suggestion.ts b/src/editor/icons-suggestion.ts
@@ -66,8 +66,8 @@ export default class SuggestionIcon extends EditorSuggest<string> {
 
     // Store all emojis correspoding to the current query - parsing whitespaces and
     // colons for shortcodes compatibility.
-    const emojisNameArray = Object.keys(emoji.shortNames).filter((e) =>
-      emoji.getShortcode(e).includes(queryLowerCase),
+    const emojisNameArray = Object.keys(emoji.shortNames).filter(
+      (e) => emoji.getShortcode(e)?.includes(queryLowerCase),
     );
 
     return [...iconsNameArray, ...emojisNameArray];
@@ -83,9 +83,10 @@ export default class SuggestionIcon extends EditorSuggest<string> {
       el.innerHTML = `${iconObject.svgElement} <span>${value}</span>`;
     } else {
       // Suggest an emoji - display its shortcode version.
-      el.innerHTML = `<span>${value}</span> <span>${emoji.getShortcode(
-        value,
-      )}</span>`;
+      const shortcode = emoji.getShortcode(value);
+      if (shortcode) {
+        el.innerHTML = `<span>${value}</span> <span>${shortcode}</span>`;
+      }
     }
   }
 

diff --git a/src/emoji.test.ts b/src/emoji.test.ts
@@ -28,4 +28,9 @@ describe('getShortcode', () => {
     expect(emoji.getShortcode('🇺🇸')).toBe('flag_united_states');
     expect(emoji.getShortcode('🏴󠁧󠁢󠁥󠁮󠁧󠁿')).toBe('flag_england');
   });
+
+  it('should return `undefined` for invalid emojis', () => {
+    expect(emoji.getShortcode('hello')).toBe(undefined);
+    expect(emoji.getShortcode('123')).toBe(undefined);
+  });
 });
diff --git a/src/emoji.ts b/src/emoji.ts
@@ -1870,11 +1870,11 @@ const isEmoji = (str: string): boolean => {
  * Gets the shortcode for a given emoji by the name of the emoji. This function replaces
  * spaces with underscores and removes colons.
  * @param key String to replace with shortcode.
- * @returns String with shortcode.
+ * @returns String with shortcode, or `undefined` if no shortcode exists.
  */
-const getShortcode = (key: string): string => {
+const getShortcode = (key: string): string | undefined => {
   // Removable of colons is necessary for the flag shortcodes.
-  return shortNames[key].replace(/\s/g, '_').replace(/:/g, '').toLowerCase();
+  return shortNames[key]?.replace(/\s/g, '_').replace(/:/g, '').toLowerCase();
 };
 
 export default {