feat: allow RegExp objects to be passed to search that are evaluated for each emoji

Author: ikelax

src/search.test.ts

@@ -7,6 +7,10 @@ describe('search', () => {
     expect(search('100')).toEqual([{ emoji: '💯', name: '100' }])
   })
 
+  it('returns a single pair when given one-of emoji name as regular expression', () => {
+    expect(search(/100/)).toEqual([{ emoji: '💯', name: '100' }])
+  })
+
   it('returns multiple emojis when given a common substring', () => {
     expect(search('cartwheel')).toEqual([
       {
@@ -20,6 +24,19 @@ describe('search', () => {
     ])
   })
 
+  it('returns multiple emojis when given a common regular expression', () => {
+    expect(search(/cartwheel/)).toEqual([
+      {
+        emoji: '🤸‍♀️',
+        name: 'woman_cartwheeling',
+      },
+      {
+        emoji: '🤸‍♂️',
+        name: 'man_cartwheeling',
+      },
+    ])
+  })
+
   it('should match when you include the colon', () => {
     expect(search(':cartwheel:')).toEqual([
       {
@@ -33,7 +50,24 @@ describe('search', () => {
     ])
   })
 
-  it('returns an empty array when no matching emojis are found', () => {
+  it('should match when you include the colon in the regular expression', () => {
+    expect(search(/:cartwheel:/)).toEqual([
+      {
+        emoji: '🤸‍♀️',
+        name: 'woman_cartwheeling',
+      },
+      {
+        emoji: '🤸‍♂️',
+        name: 'man_cartwheeling',
+      },
+    ])
+  })
+
+  it('returns an empty array when no matching emojis are found for a string search', () => {
     expect(search('notAnEmoji')).toEqual([])
   })
+
+  it('returns an empty array when no matching emojis are found for a regular expression search', () => {
+    expect(search(/notAnEmoji/)).toEqual([])
+  })
 })

src/search.ts

@@ -1,14 +1,21 @@
-import { assert } from '@sindresorhus/is'
+import is, { assert } from '@sindresorhus/is'
 
 import { emojiData } from './data.js'
 import { normalizeName } from './utils.js'
 
-export const search = (keyword: string) => {
-  assert.string(keyword)
+export const search = (keyword: RegExp | string) => {
+  assert.any([is.default.string, is.default.regExp], keyword)
 
-  keyword = normalizeName(keyword)
+  if (is.default.string(keyword)) {
+    keyword = normalizeName(keyword)
+  }
+
+  if (is.default.regExp(keyword)) {
+    const normalizedPattern = normalizeName(keyword.source)
+    keyword = new RegExp(normalizedPattern)
+  }
 
   return emojiData
-    .filter(([name]) => name.includes(keyword))
+    .filter(([name]) => name.match(keyword))
     .map(([name, emoji]) => ({ emoji, name }))
 }