@involvex/emoji-cli 2.2.2

package/src/utils.ts

@@ -0,0 +1,38 @@
+import charRegex from 'char-regex'
+
+export const charRegexMatcher = charRegex()
+
+export function asFunction<T extends PropertyKey, Args extends unknown[]>(
+  input: ((...args: Args) => T) | T,
+): (...args: Args) => T {
+  return typeof input === 'function' ? input : () => input
+}
+
+/**
+ * Non spacing mark contained by some emoticons (65039 - '️' - 0xFE0F).
+ *
+ * It's the 'Variant Form', which provides more information so that emoticons
+ * can be rendered as more colorful graphics. FE0E is a unicode text version
+ * whereas FE0F should be rendered as a graphical version.
+ * The code gracefully degrades.
+ */
+const NON_SPACING_MARK = String.fromCharCode(65039)
+
+const nonSpacingRegex = new RegExp(NON_SPACING_MARK, 'g')
+
+/**
+ * Removes the non-spacing-mark from the emoji code.
+ *
+ * Never send a stripped version to clients, as it kills graphical emoticons.
+ */
+export function normalizeCode(code: string) {
+  return code.replace(nonSpacingRegex, '')
+}
+
+export function normalizeName(name: string) {
+  return /:.+:/.test(name) ? name.slice(1, -1) : name
+}
+
+export function randomItem<T>(array: T[]) {
+  return array[Math.floor(Math.random() * array.length)]
+}

package/src/which.test.ts

@@ -0,0 +1,27 @@
+import { describe, expect, it } from 'vitest'
+
+import { which } from './which.js'
+
+describe('which', () => {
+  it('returns a simple emoji name when given an emoji', () => {
+    expect(which('☕')).toBe('coffee')
+  })
+
+  it('returns a simple emoji name as markdown when specified as markdown', () => {
+    expect(which('☕', { markdown: true })).toBe(':coffee:')
+  })
+
+  it('returns a skin toned emoji name when given a skin toned emoji', () => {
+    expect(which('👍🏾')).toBe('+1')
+  })
+
+  it('returns a skin toned emoji name as markdown when specified as markdown', () => {
+    expect(which('👍🏾', { markdown: true })).toBe(':+1:')
+  })
+
+  // see issue #21
+  it('should work for flags', () => {
+    expect(which('🇲🇽')).toBe('mexico')
+    expect(which('🇲🇦')).toBe('morocco')
+  })
+})

package/src/which.ts

@@ -0,0 +1,26 @@
+import { assert } from '@sindresorhus/is'
+import skinTone from 'skin-tone'
+
+import { findByCode } from './findByCode.js'
+
+export interface WhichOptions {
+  markdown?: boolean
+}
+
+/**
+ * Get an emoji name from an emoji.
+ */
+export const which = (
+  emoji: string,
+  { markdown = false }: WhichOptions = {},
+) => {
+  assert.string(emoji)
+  assert.boolean(markdown)
+
+  const result = findByCode(skinTone(emoji, 'none'))
+  if (result === undefined) {
+    return undefined
+  }
+
+  return markdown ? `:${result.key}:` : result.key
+}