twemoji-parser's Introduction

Twemoji Parser

A simple library for identifying emoji entities within a string in order to render them as Twemoji.

For example, this parser is used within the rendering flow for Tweets and other text on mobile.twitter.com

Setup

Important

The twemoji-parser package is now being published as @twemoji/parser

Add @twemoji/parser as a dependency to your project:

yarn add @twemoji/parser

Or, to work directly in this repo, clone it and run yarn install from the repo root.

Usage

The tests are intended to serve as a more exhaustive source of documentation, but the general idea is that the parser takes a string and returns an array of the emoji entities it finds:

import { parse } from '@twemoji/parser';
const entities = parse('I 🧡 Twemoji! 🥳');
/*
entities = [
  {
    url: 'https://cdn.jsdelivr.net/gh/jdecked/twemoji@latest/assets/svg/1f9e1.svg',
    indices: [ 2, 4 ],
    text: '🧡',
    type: 'emoji'
  },
  {
    url: 'https://cdn.jsdelivr.net/gh/jdecked/twemoji@latest/assets/svg/1f973.svg',
    indices: [ 12, 14 ],
    text: '🥳',
    type: 'emoji'
  }
]
*/

Authors

Nathan Downs (ex-Twitter)
Justine De Caires (ex-Twitter)

Contributing

We feel that a welcoming community is important and we ask that you follow our Open Source Code of Conduct in all interactions with the community.

Support

Create a new issue on GitHub.

License

MIT https://github.com/jdecked/twemoji-parser/blob/master/LICENSE.md

twemoji-parser's People

Contributors

Stargazers

Watchers

twemoji-parser's Issues

Feature request: Export the regex

Could the regular expression used internally to match Twemoji be exported? I think it could be very useful to find supported Unicode emojis within a string. Over 85% of this package's source code is the regex, and it's not even directly usable, which just seems a bit odd to me. It's really the most important part of the whole package.

You can currently import it directly with the full path (import twemojiRegexp from "@twemoji/parser/dist/lib/regex.js";), but it'd be preferable if it was explicitly exported.

Ensure all emoji which require VS16 to be fully qualified are marked as such in emoji.yml

Some currently aren't, e.g. 1f9ce-200d-2642-fe0f ("Man kneeling")

Unicode 15 support

Support for Unicode 15.0.0 for jdecked/twemoji#43

Migrate to TypeScript?

Currently, twemoji-parser is written in JS + Flow, with the regex generator / build step written in Scala and using the Pants build system. While this may have fit in well with other Twitter projects (Twitter seems to do a lot in Scala; not sure about Flow), twemoji is no longer a Twitter project. It may make more sense to migrate twemoji-parser and the regex-generation build step completely to TypeScript, which the Node ecosystem seems to be coalescing around.

Currently, building twemoji-parser (or at least regenerating the regex) requires installing the JVM, Scala, and Python, despite this being a Node package. I believe it would be more friendly to new contributors to rewrite the regex generator in JavaScript or TypeScript, so that developers more used to the Node ecosystem would have an easier time contributing and wouldn't have to worry about so many non-Node language setups.

I believe that migrating the parser from Flow to TypeScript would also be beneficial. There's a lot more tooling built up around TypeScript than Flow, easing the development process, and the unofficial definitely-typed TS definitions could be replaced with official type definitions.

I would be more than willing to take on this work, provided that you think it'd be beneficial.

Recommend Projects

jdecked / twemoji-parser Goto Github PK