An open API service indexing awesome lists of open source software.

https://github.com/fxfactorial/ocaml-emoji

Emojis in OCaml, use them in your CLIs or whatever
https://github.com/fxfactorial/ocaml-emoji

cli cute emoji ocaml

Last synced: 9 months ago
JSON representation

Emojis in OCaml, use them in your CLIs or whatever

Awesome Lists containing this project

README

          

# Emoji

OCaml library providing byte sequences of all the Unicode (v17.0) emoji
characters and sequences

```
$ opam install emoji
```

You can see them by printing to the screen:
```ocaml
# Emoji.distorted_face;;
- : string = "🫪"
# Emoji.hairy_creature;;
- : string = "🫈"
# Emoji.orca;;
- : string = "🫍"
```

You can also get all emojis from the same category or subcategory:
```ocaml
# let best_animals = Emoji.sub_category_animal_reptile;;
val best_animals : string array =
[|"🐊"; "🐉"; "🐲"; "🦎"; "🦕"; "🐍"; "🦖"; "🐢"|]
```

Using `ocp-browser` shows the emoji

![ocp-browser screenshot](./ocp-browser-emoji.png)

# Development

To generate `emoji.ml`, first update the source html files:
```
$ wget "https://www.unicode.org/emoji/charts/full-emoji-list.html"
$ wget "https://www.unicode.org/emoji/charts/full-emoji-modifiers.html"
```

then run:
```
$ dune exec gencode/gencode.exe > src/emoji.ml
```
test with `dune runtest`, you can then `dune promote` to apply [mdx](https://github.com/realworldocaml/mdx) changes to keep this file up to date.