{"id":17680328,"url":"https://github.com/docelic/specreporter-spec","last_synced_at":"2025-03-30T18:48:42.213Z","repository":{"id":66956527,"uuid":"96046276","full_name":"docelic/specreporter-spec","owner":"docelic","description":"SpecReporter spec formatter for Crystal, similar to Ruby minitest-reporters' SpecReporter","archived":false,"fork":false,"pushed_at":"2018-08-30T08:51:54.000Z","size":556,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-05T21:33:32.797Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/docelic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-02T20:06:52.000Z","updated_at":"2022-09-25T07:52:37.000Z","dependencies_parsed_at":"2023-02-28T02:31:18.448Z","dependency_job_id":null,"html_url":"https://github.com/docelic/specreporter-spec","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docelic%2Fspecreporter-spec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docelic%2Fspecreporter-spec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docelic%2Fspecreporter-spec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/docelic%2Fspecreporter-spec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/docelic","download_url":"https://codeload.github.com/docelic/specreporter-spec/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246365640,"owners_count":20765546,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-24T09:06:33.531Z","updated_at":"2025-03-30T18:48:41.759Z","avatar_url":"https://github.com/docelic.png","language":"Crystal","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Introduction\nSpecReporter is a spec output formatter for Crystal, similar to Ruby minitest-reporters' SpecReporter.\n\n![SpecReporter Demo Video](https://raw.githubusercontent.com/docelic/specreporter-spec/master/doc/specreporter-spec.gif)\n\n## Description\n\nSpecreporter-spec looks and works similar to Ruby's \"SpecReporter\"\nmodule from the minitest-reporters gem.\n\nThe changes/improvements compared to the default Crystal formatter include:\n\n- Nicer and more informative output\n- Info on elapsed time for each test\n- Short and informative backtrace summaries\n- Info on total number of assertions ran\n- Configurable field widths\n- Configurable terminal width\n- Configurable elapsed time precision\n- Ability to enable/disable sections from default formatter\n\n## Usage\n\nAdd this to your application's `shard.yml`:\n\n```yaml\ndevelopment_dependencies:\n  specreporter-spec:\n    github: docelic/specreporter-spec\n```\n\nSimply add the following content to your `spec/spec_helper.cr`:\n\n```crystal\nrequire \"spec\"\n\nrequire \"specreporter-spec\"\nSpec.override_default_formatter(\n Spec::SpecReporterFormatter.new(\n  #indent_string: \"    \",        # Indent string. Default \"  \"\n  #width: (ENV[\"COLUMNS\"]? || 80).to_i-2, # Terminal width. Default 78\n  ## ^-- You may need to run \"eval `resize`\" in term to get COLUMNS variable\n  #elapsed_width: 8,     # Number of decimals for \"elapsed\" time. Default 3\n  #status_width: 10,     # Width of the status field. Default 5\n  #trim_exceptions: false,     # Hide callstack from exceptions? Default true\n  #skip_errors_report: false,  # Skip default backtraces. Default true\n  #skip_slowest_report: false, # Skip default \"slowest\" report. Default true\n  #skip_failed_report: false,  # Skip default failed reports summary. Default true\n))\n```\n\nConfigure the options to your liking.\n\nAnd run tests in the usual way (`crystal s[pec]`).\n\nEnjoy!\n\n## TODO\n\nThe formatter certainly works, but the implementation must be\nimproved before it could be added to Crystal as built-in formatter.\n\nCode improvements and further feature ideas welcome! Thanks!\n\n## Other / Unrelated Formatters\n\nOther / unrelated spec formatters for Crystal in existence:\n\n- [Rainbow](https://github.com/veelenga/rainbow-spec) - formats the\n  standard formatter dots in rainbow colors.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocelic%2Fspecreporter-spec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocelic%2Fspecreporter-spec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocelic%2Fspecreporter-spec/lists"}