https://github.com/docelic/specreporter-spec
SpecReporter spec formatter for Crystal, similar to Ruby minitest-reporters' SpecReporter
https://github.com/docelic/specreporter-spec
Last synced: 3 months ago
JSON representation
SpecReporter spec formatter for Crystal, similar to Ruby minitest-reporters' SpecReporter
- Host: GitHub
- URL: https://github.com/docelic/specreporter-spec
- Owner: docelic
- License: apache-2.0
- Created: 2017-07-02T20:06:52.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-30T08:51:54.000Z (almost 7 years ago)
- Last Synced: 2025-02-05T21:33:32.797Z (4 months ago)
- Language: Crystal
- Size: 543 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
SpecReporter is a spec output formatter for Crystal, similar to Ruby minitest-reporters' SpecReporter.
## Description
Specreporter-spec looks and works similar to Ruby's "SpecReporter"
module from the minitest-reporters gem.
The changes/improvements compared to the default Crystal formatter include:
- Nicer and more informative output
- Info on elapsed time for each test
- Short and informative backtrace summaries
- Info on total number of assertions ran
- Configurable field widths
- Configurable terminal width
- Configurable elapsed time precision
- Ability to enable/disable sections from default formatter
## Usage
Add this to your application's `shard.yml`:
```yaml
development_dependencies:
specreporter-spec:
github: docelic/specreporter-spec
```
Simply add the following content to your `spec/spec_helper.cr`:
```crystal
require "spec"
require "specreporter-spec"
Spec.override_default_formatter(
Spec::SpecReporterFormatter.new(
#indent_string: " ", # Indent string. Default " "
#width: (ENV["COLUMNS"]? || 80).to_i-2, # Terminal width. Default 78
## ^-- You may need to run "eval `resize`" in term to get COLUMNS variable
#elapsed_width: 8, # Number of decimals for "elapsed" time. Default 3
#status_width: 10, # Width of the status field. Default 5
#trim_exceptions: false, # Hide callstack from exceptions? Default true
#skip_errors_report: false, # Skip default backtraces. Default true
#skip_slowest_report: false, # Skip default "slowest" report. Default true
#skip_failed_report: false, # Skip default failed reports summary. Default true
))
```
Configure the options to your liking.
And run tests in the usual way (`crystal s[pec]`).
Enjoy!
## TODO
The formatter certainly works, but the implementation must be
improved before it could be added to Crystal as built-in formatter.
Code improvements and further feature ideas welcome! Thanks!
## Other / Unrelated Formatters
Other / unrelated spec formatters for Crystal in existence:
- [Rainbow](https://github.com/veelenga/rainbow-spec) - formats the
standard formatter dots in rainbow colors.