gitmoji-regex

😜 Gitmoji::Regex

If ☝️ ci_badges.map(&:color).detect { it != "green" } let me know, as I may have missed the discord notification.

OTOH, if ci_badges.map(&:color).all? { it == "green" } 👇️ send money so I can do more of this. FLOSS is now my full-time job.

🌻 Synopsis

This gem provides a regex that allows Ruby code to test a string for a Gitmoji character. Gitmoji is a subset of the Unicode Emoji character set. This gem is not a fork of, but was inspired by, the wonderful emoji_regex gem.

You can use this regular expression to validate commit messages or extract leading gitmoji from strings.

# character at position 0 is a Gitmoji!
"🔥" =~ Gitmoji::Regex::REGEX # => 0

# (0 is the index of the match, so it means valid!)
(Gitmoji::Regex::REGEX =~ "✨ Add feature").zero? #=> true

# Scan for Gitmoji
"✨ Fix bug 🐛".scan(Gitmoji::Regex::REGEX) #=> ["✨", "🐛"]

🚚 Amazing test matrix was brought to you by	🔎 appraisal2 🔎
👟 Check it out!	✨ github.com/appraisal-rb/appraisal2 ✨

💡 Info you can shake a stick at

Federated DVCS

Find this repo on other forges (Coming soon!)

Federated DVCS Repository	Status	Issues	PRs	Wiki	CI	Discussions
🧪 galtzo-floss/gitmoji-regex on GitLab	The Truth	💚	💚	💚	🏀 Tiny Matrix	➖
🧊 galtzo-floss/gitmoji-regex on CodeBerg	An Ethical Mirror (Donate)	💚	💚	➖	⭕️ No Matrix	➖
🐙 galtzo-floss/gitmoji-regex on GitHub	A Dirty Mirror	💚	💚	➖	💯 Full Matrix	💚
🎮️ Discord Server		Let's	talk	about	this	library!

Enterprise Support

Need enterprise-level guarantees?

• 💡Subscribe for support guarantees covering all FLOSS dependencies
• 💡Tidelift is part of Sonar
• 💡Tidelift pays maintainers to maintain the software you depend on!
  📊@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers

Alternatively:

• 
• 
• 

Tokens to Remember
Works with JRuby
Works with Truffle Ruby
Works with MRI Ruby 3
Works with MRI Ruby 2
Source
Documentation
Compliance
Style
Support
Maintainer 🎖️
... 💖	🧊 🐙 🛖 🧪

✨ Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add gitmoji-regex

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install gitmoji-regex

🔒 Secure Installation

For Medium or High Security Installations

This gem is cryptographically signed, and has verifiable SHA-256 and SHA-512 checksums by stone_checksums. Be sure the gem you install hasn’t been tampered with by following the instructions below.

Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:

gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)

You only need to do that once. Then proceed to install with:

gem install gitmoji-regex -P HighSecurity

The HighSecurity trust profile will verify signed gems, and not allow the installation of unsigned dependencies.

If you want to up your security game full-time:

bundle config set --global trust-policy MediumSecurity

MediumSecurity instead of HighSecurity is necessary if not all the gems you use are signed.

NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.

⚙️ Configuration

Not needed.

🔧 Basic Usage

Usage

"🔥" =~ Gitmoji::Regex::REGEX
# => 0 # character at position 0 is a Gitmoji!

"fire" =~ Gitmoji::Regex::REGEX
# => nil

(Gitmoji::Regex::REGEX =~ "✨ Add feature")
# => 0

"✨ Fix bug 🐛".scan(Gitmoji::Regex::REGEX)
# => ["✨", "🐛"]

I use this gem to validate gitmoji at the first character of each commit message in a git pre-commit-hook. I blogged about the pattern I follow. Although that post was before I adopted Gitmoji for commits, it should be obvious how to integrate it. I'll write a new blog post soon with my current commit hooks. If you can't wait, you can find what I currently use in this repo: .git-hooks.

🦷 FLOSS Funding

How wonderful it is that nobody need wait a single moment before starting to improve the world.
—Anne Frank

I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions — totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈‍ cats).

If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.

I’m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.

Floss-Funding.dev: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags

🔐 Security

See SECURITY.md.

🤝 Contributing

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check reek, issues, or PRs, or use the gem and think about how it could be better.

We so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

🚀 Release Instructions

See CONTRIBUTING.md.

Code Coverage

🪇 Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the .

🌈 Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/galtzo-floss/gitmoji-regex/-/graphs/main

⭐️ Star History

📌 Versioning

This Library adheres to . Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

dropping support for a platform is both obviously and objectively a breaking change
—Jordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716

I understand that policy doesn't work universally ("exceptions to every rule!"), but it is the policy here. As such, in many cases it is good to specify a dependency on this library using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("gitmoji-regex", "~> 1.0")

📌 Is "Platform Support" part of the public API? More details inside.

SemVer should, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

• "Major Version Numbers are Not Sacred"

See CHANGELOG.md for a list of releases.

📄 License

The gem is available as open source under the terms of the MIT License . See LICENSE.txt for the official Copyright Notice.

© Copyright

• Copyright (c) 2025 Peter H. Boling, of Galtzo.com , and gitmoji-regex contributors.
• Copyright (c) 2014-2017 Zach Taylor & Avant

🤑 A request for help

Maintainers have teeth, and need to pay their dentists. After getting laid off in an RIF in March, and filled with many dozens of rejections, I'm now spending ~80 hours a week building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, please help. I need your support. Please consider sponsoring me.

💌 💌

To say "thanks for maintaining such a great tool" 👇️ Join the Discord or ☝️ send money.

To join the community or get help 👇️ Join the Discord.

Thanks for RTFM. ☺️