rossmacarthur / emojis

✨ Lookup emoji in O(1) time, access metadata and GitHub shortcodes, iterate over all emoji

I'm Ross 👋

• ✨ Python by day, Rust by night
• 📚 Slowly reading https://craftinginterpreters.com
• ❤️ Passionate about Open Source software
• ♟️ When I'm not coding you can find me losing on https://lichess.org

🌱 My projects

TOOLS

• aq - Extend jq for any data format
• cargo-onedoc - 📝 Generate your README.md from Rust doc comments
• dotfiles - 🔧 Install packages and my dotfiles on a new system
• install - Install a Rust crate from a GitHub release
• kb-remap - ⌨️ Tool to remap macOS keyboard keys
• sheldon - Fast, configurable, shell plugin manager

RUST LIBRARIES

• casual - Simple Rust crate for parsing user input
• complexity - Calculate cognitive complexity of Rust code
• constcat - 🐱 concat! with support for const variables and expressions
• emojis - ✨ Lookup and iterate over emoji names, shortcodes, and groups
• fmutex - Provides mutual exclusion on a file using flock(2)
• goldie - 🌟 Simple golden file testing for Rust
• itermore - 🤸 More iterator adaptors
• pulldown-cmark-toc - Generate a table of contents from a Markdown document
• radiotap - A parser for the radiotap capture format
• regex-macro - Only compile a regex once, abstracted
• upon - 📌 A lightweight and powerful template engine for Rust
• vectrix - 🏹 Stack-allocated, constant-size, matrix type implemented with const generics

PYTHON LIBRARIES

• pycases - 💼 A case conversion library with Unicode support

GO LIBRARIES

• cases - 💼 A case conversion library for Go with Unicode support
• fudge - 🍦 Oh Fudge! A straight-forward error library for Go

ALFRED WORKFLOWS

• powerpack - ⚡ Supercharge your Alfred workflows by building them in Rust!
• crates.alfredworkflow - 📦 Alfred workflow to search Rust crates
• github.alfredworkflow - Alfred workflow to search GitHub repositories
• gitlab.alfredworkflow - 🦊 Alfred workflow to search GitLab issues and merge requests

GITHUB ACTIONS

• setup-crate - 📦 GitHub Action to install a Rust binary
• setup-just - 🤖 GitHub Action to install the just command runner

FUN

• advent - 🎄 My Advent of Code solutions
• intcode - 🎁 Assembler and runner for the Intcode computer from 🎄 Advent of Code 2019

emojis's Issues

`get` with HashMap

Thanks for creating this up to date library. I want to use this to check if a str is an Emoji. I am currently calling the get method and check if it returns Some.

I noticed there is a loop to determine if the unicode is an emoji. I was wondering if it wouldn't be a lot quicker if there is another static (generated) HashMap<Unicode, Emoji> to reach O(1) lookup time. I am not sure how Emoji's are encoded, so I am not sure if this is possible.

emojis/src/lib.rs

Line 351 in c5bf098

pub fn get(s: &str) -> Option<&'static Emoji> {

Valid emoji isn't in the unicode map

👪🏻 this is a family, it isn't in the map (emojis::get). Maybe more emojis are not in the map which are valid emojis.

Skin tone and gendered emojis

Skin tone emojis can be looked up but it will still return the generic version of the emoji. It would be nice to be able to be able to specify which skin tone is wanted.

Unqualified and minimally qualified emojis

At the moment these are not supported. emojis::lookup() should return the fully qualified version for these.

Handle emojis with multiple skin tones better

At the moment we currently just add these emojis to the variations but we should return them from .skin_tones().

Most emojis with skin tones have 6 variations but there are some with 26, for example 👩🏿‍❤️‍👨🏼 kinds of emojis.

Questions:

• What should .skin_tone() return?
• What should with_skin_tone() do in this case?
• Is there a way to make the above ones use multiple skin tones?

Question: Support for "banned" or unsupported emoji's per OS.

Different systems have more or less emoji based on intentional business-political decisions (like removing a gun emoji etc). Particularly on windows a vast majority of emojis do not render. Is it currently possible to obtain a OS "supported" list of emoji within the crate and if not, would this be something I could help get added if you think it'd be useful? For us it seems more logical than maintaining a list of unsupported emojis outside of the crate.

Upgrade to emoji spec 14.0

Currently we generate from 13.1

emojis/generate/src/unicode.rs

Line 10 in 399bf03

const URL: &str = "https://unicode.org/Public/emoji/13.1/emoji-test.txt";

Feature request: expose emoji aliases in public API

Right now, the Emoji::shortcode function returns the first alias. I'd like a way to iterate all the aliases, but that doesn't seem to exist.

I'll submit a PR soon I've submitted a PR 🚀

Expose emoji versions

This would make it easy to filter out unsupported emojis. Example API:

use emojis::Version;

let year2020 = Version::new(13, 1);

emojis::iter().filter(|emoji| emoji.version() <= year2020)

Lookup emoji only by unicode codepoint, not by shorthand

Currently lookup will try both, shorthand and unicode codepoint . It'd be helpful if there'd be an additional way to do one or the other.

The workaround to manually lookup by unicode codepoint is emojis::iter().find(..).

Publish emoji fields

Hello, and thank you for this crate; I've found it very useful. I would find it rather helpful to have some of the fields in the Emoji struct to be public, such as the variations and skin tones, either by making the fields themselves public or adding getter methods for them. Sorry if I've missed an obvious way of doing this, or if there's a reason why these fields are private.

Thanks for your time