https://github.com/manicmaniac/mailmap
Pure Ruby implementation of Git mailmap.
https://github.com/manicmaniac/mailmap
git mailmap ruby
Last synced: 9 months ago
JSON representation
Pure Ruby implementation of Git mailmap.
- Host: GitHub
- URL: https://github.com/manicmaniac/mailmap
- Owner: manicmaniac
- License: mit
- Created: 2022-09-19T21:00:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-20T16:50:05.000Z (over 1 year ago)
- Last Synced: 2025-03-25T06:24:13.062Z (about 1 year ago)
- Topics: git, mailmap, ruby
- Language: Ruby
- Homepage: https://www.rubydoc.info/gems/mailmap
- Size: 228 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# mailmap
[](https://github.com/manicmaniac/mailmap/actions/workflows/main.yml)
[](https://codeclimate.com/github/manicmaniac/mailmap/maintainability)
[](https://codeclimate.com/github/manicmaniac/mailmap/test_coverage)
[](https://rubygems.org/gems/mailmap)
Pure Ruby implementation of [Git mailmap](https://git-scm.com/docs/gitmailmap).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'mailmap'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install mailmap
## Usage
```ruby
require 'mailmap'
# Load .mailmap file
mailmap = Mailmap::Map.load('.mailmap')
# Parse string
mailmap = Mailmap::Map.parse('Proper Name ')
# Parse string with optional filename
mailmap = Mailmap::Map.parse('Proper Name ', '.mailmap')
# Equivalent to git check-mailmap 'Commit Name' 'commit@example.com'
mailmap.resolve('Commit Name', 'commit@example.com') # => ['Proper Name', 'proper@example.com']
# Equivalent to git check-mailmap 'commit@example.com'
mailmap.resolve(nil, 'commit@example.com') # => [nil, 'proper@example.com']
# Similar to `Map#resolve` but returns nil if not found
mailmap.lookup('Nonexistent Name', 'nonexistent@example.com') #=> nil
```
See [API reference](https://www.rubydoc.info/gems/mailmap) for more information.
## Command Line
This gem includes command-line tool named `check-mailmap`.
It is pure Ruby implementation of [`git check-mailmap`](https://git-scm.com/docs/git-check-mailmap) and is intended to be a drop-in replacement for `git check-mailmap`.
```sh
$ bundle exec check-mailmap --help
usage: check-mailmap [] ...
-f, --file=FILE path to the .mailmap file (default: ./.mailmap)
--stdin also read contacts from stdin
```
## Development
After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/manicmaniac/mailmap.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).