https://github.com/marcoroth/minitest-difftastic
Minitest Plugin to use difftastic for failed assertions.
https://github.com/marcoroth/minitest-difftastic
difftastic minitest minitest-plugin minitest-plugins
Last synced: 6 months ago
JSON representation
Minitest Plugin to use difftastic for failed assertions.
- Host: GitHub
- URL: https://github.com/marcoroth/minitest-difftastic
- Owner: marcoroth
- Created: 2025-01-21T22:05:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-28T13:49:05.000Z (over 1 year ago)
- Last Synced: 2025-10-20T19:57:34.458Z (8 months ago)
- Topics: difftastic, minitest, minitest-plugin, minitest-plugins
- Language: Ruby
- Homepage:
- Size: 394 KB
- Stars: 105
- Watchers: 1
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Minitest::Difftastic
A Minitest Plugin which uses [`difftastic`](https://github.com/Wilfred/difftastic) (via [`difftastic-ruby`](https://github.com/joeldrapper/difftastic-ruby)) to show the diffs for failing assertions.
Also works for Rails tests using `ActiveSupport::TestCase`.
## Try it yourself
Clone this repo, run `bundle install` and then `rake examples` in your terminal.
```ruby
rake examples
```
You will get a few failing assertions printed to your terminal.
```
Failure:
Examples::AssertEqual#test_assert_equal [examples/assert_equal.rb:8]:
Expected Actual
1 "Hello World" 1 "Hello Difftastic"
```
You can also look at the source code for the examples in the [`examples/`](https://github.com/marcoroth/minitest-difftastic/tree/main/examples) folder.
## Screenshots
### Integers
### Strings
### Objects
### Nested Objects
## Installation
Install the gem and add to the application's Gemfile `test` group by executing:
```shell
bundle add minitest-difftastic --group=test
```
If bundler is not being used to manage dependencies, install the gem by executing:
```shell
gem install minitest-difftastic
```
## Usage
The plugin will be automatically detected and picked up by Minitest if you have it added to the Gemfile of your application.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
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/marcoroth/minitest-difftastic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcoroth/minitest-difftastic/blob/main/CODE_OF_CONDUCT.md).
## Code of Conduct
Everyone interacting in the `Minitest::Difftastic` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/minitest-difftastic/blob/main/CODE_OF_CONDUCT.md).