https://github.com/mathiasbynens/emoji-test-regex-pattern
A regular expression pattern for Java/JavaScript to match all emoji in the emoji-test.txt file provided by UTS#51.
https://github.com/mathiasbynens/emoji-test-regex-pattern
Last synced: 9 months ago
JSON representation
A regular expression pattern for Java/JavaScript to match all emoji in the emoji-test.txt file provided by UTS#51.
- Host: GitHub
- URL: https://github.com/mathiasbynens/emoji-test-regex-pattern
- Owner: mathiasbynens
- License: mit
- Created: 2021-03-02T09:21:12.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T12:38:34.000Z (over 1 year ago)
- Last Synced: 2025-04-02T09:06:32.108Z (9 months ago)
- Language: JavaScript
- Size: 266 KB
- Stars: 106
- Watchers: 6
- Forks: 17
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# emoji-test-regex-pattern [](https://www.npmjs.com/package/emoji-test-regex-pattern)
_emoji-test-regex-pattern_ offers Java- and JavaScript-compatible regular expression patterns to match all emoji symbols and sequences listed in the `emoji-test.txt` file provided as part of [Unicode® Technical Standard #51](https://www.unicode.org/reports/tr51/).
These patterns can then be embedded into source code as part of projects such as [emoji-regex](https://github.com/mathiasbynens/emoji-regex).
This repository contains a script that generates this regular expression pattern based on [Unicode data](https://github.com/node-unicode/node-unicode-data). Because of this, the pattern can easily be updated whenever new emoji are added to the Unicode standard.
_emoji-test-regex-pattern_ also includes other useful assets! For every supported version of the Emoji standard, _emoji-test-regex-pattern_ generates the following files:
- `index.txt` — a list of all the emoji matched by the other files in that folder alongside their code points in U+XXXX notation.
- `index-strings.txt` — a list of all the emoji matched by the other files in that folder.
- `cpp-re2.txt` — a regular expression pattern matching all the emoji in `index.txt` compatible with [the C++ RE2 library](https://github.com/google/re2).
- `css.txt` — a CSS `unicode-range` value matching each code point in any of the emoji sequences in `index.txt`.
- `java.txt` — a Java-compatible regular expression pattern matching all the emoji in `index.txt`.
- `javascript.txt` — a JavaScript-compatible regular expression pattern matching all the emoji in `index.txt`, for use in regular expressions without the `u` flag.
- `javascript-u.txt` — a JavaScript-compatible regular expression pattern matching all the emoji in `index.txt`, for use in regular expressions with the `u` flag.
- `javascript-v.txt` — a JavaScript-compatible regular expression pattern matching all the emoji in `index.txt`, for use in regular expressions with [the `v` flag](https://v8.dev/features/regexp-v-flag).
Note that although Unicode Emoji UTS#51 follows the versioning system used by the Unicode Standard, [the version numbers can be different](https://www.unicode.org/reports/tr51/#EmojiVersions). 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/index-strings.txt
dist/emoji-13.0/cpp-re2.txt
dist/emoji-13.0/css.txt
dist/emoji-13.0/java.txt
dist/emoji-13.0/javascript.txt
dist/emoji-13.0/javascript-u.txt
dist/emoji-13.0/javascript-v.txt
dist/emoji-13.1/*.txt
dist/emoji-14.0/*.txt
dist/emoji-15.0/*.txt
dist/emoji-15.1/*.txt
dist/emoji-16.0/*.txt
dist/latest/*.txt
```
See [the `dist/` folder](https://github.com/mathiasbynens/emoji-test-regex-pattern/tree/main/dist).
## For maintainers
### How to update _emoji-test-regex-pattern_ after new UTS#51 releases
1. Update the Unicode data dependency in `package.json` by running the following commands:
```sh
# Example: Emoji 17.0 (UTS#51) is released, and its data is included in the @unicode/unicode-17.0.0 package.
npm install unicode-emoji-17.0@npm:@unicode/unicode-17.0.0@latest --save-dev
````
1. Generate the new output:
```sh
npm run build
```
1. Verify that `dist` contains the new file.
1. Send a pull request with the changes, and get it reviewed & merged.
1. On the `main` branch, bump the version number in `package.json`:
```sh
npm version patch -m 'Release v%s'
```
Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/).
Note that this produces a Git commit + tag.
1. Push the release commit and tag:
```sh
git push && git push --tags
```
Our CI then automatically publishes the new release to npm.
## Author
| [](https://twitter.com/mathias "Follow @mathias on Twitter") |
|---|
| [Mathias Bynens](https://mathiasbynens.be/) |
## License
This project is a fork of [_emoji-regex_](https://github.com/mathiasbynens/emoji-regex), with a different goal. _emoji-test-regex-pattern_ is available under the same [MIT](https://mths.be/mit) license as the original project.