/rgi-emoji-regex-pattern

A JavaScript-compatible regular expression pattern to match all RGI emoji symbols and sequences as per the Unicode Standard and UTS#51.

Primary LanguageJavaScriptMIT LicenseMIT

rgi-emoji-regex-pattern rgi-emoji-regex-pattern on npm

rgi-emoji-regex-pattern offers a JavaScript-compatible regular expression pattern to match all RGI emoji symbols and sequences as per the Unicode Standard and UTS#51. (RGI stands for “recommended for general interchange”.)

These patterns can then be embedded into source code as part of projects such as emoji-regex.

This repository contains a script that generates this regular expression pattern based on Unicode data. Because of this, the pattern can easily be updated whenever new emoji are added to the Unicode standard.

Note that although Unicode Emoji UTS#51 follows the versioning system used by the Unicode Standard, the version numbers can be different. For example, when Unicode 13.0 was released, so was Emoji 13.0. But later, Emoji 13.1 was published while the Unicode version number remained at 13.0. Therefore, we use the Emoji version as specified in UTS#51 (and not the version of the Unicode Standard itself) to version the different patterns:

dist/emoji-13.0/index.txt
dist/emoji-13.0/java.txt
dist/emoji-13.0/javascript.txt
dist/emoji-13.1/index.txt
dist/emoji-13.1/java.txt
dist/emoji-13.1/javascript.txt
dist/latest/index.txt
dist/latest/java.txt
dist/latest/javascript.txt

See the dist/ folder.

For maintainers

How to update rgi-emoji-regex-pattern after new UTS#51 releases

  1. Update the Unicode data dependency in package.json by running the following commands:

    # Example: Emoji 14.0 (UTS#51) is released, and its data is included in the @unicode/unicode-14.0.0 package.
npm install unicode-emoji-14.0@npm:@unicode/unicode-14.0.0@latest --save-dev

  2. Generate the new output:

    npm run build

  3. Verify that dist contains the new file.

  4. Send a pull request with the changes, and get it reviewed & merged.

  5. On the main branch, bump the version number in package.json:

    npm version patch -m 'Release v%s'

    Instead of patch, use minor or major as needed.

    Note that this produces a Git commit + tag.

  6. Push the release commit and tag:

    git push

    Our CI then automatically publishes the new release to npm.

Author

twitter/mathias
Mathias Bynens

License

This project is a fork of emoji-regex, with a different goal. rgi-emoji-regex-pattern is available under the same MIT license as the original project.