Simplecov Tailwindcss

Generates a HTML Tailwind Design report generated from Simplecov using ruby 2.5 or greater.

Get startedView on GitHub

Introduction

Getting Started

Learn how to get Simplecov Tailwindcss set up in your project.

Installation

Step-by-step guides to setting up your system and installing the library.

Usage

Understand how to use it in your project.

Simplecov

See configuration details about simplecov at there repo.

Roadmap

See what is planned or being worked

Quick start

Simplecov Tailwindcss is a replacement formatter to the out of the box one that comes with Simplecov.

Installing dependencies

Be sure to add simplecov to your gem file to start before installing simplecov-tailwindcss

# ./Gemfile

group :test do
  gem 'simplecov', require: false
end

SimpleCov is a code coverage analysis tool for Ruby. It uses Ruby's built-in Coverage library to gather code coverage data, but makes processing its results much easier by providing a clean API to filter, group, merge, format, and display those results, giving you a complete code coverage suite that can be set up with just a couple lines of code. SimpleCov/Coverage track covered ruby code, gathering coverage for common templating solutions like erb, slim and haml is not supported. In most cases, you'll want overall coverage results for your projects, including all types of tests, Cucumber features, etc. SimpleCov automatically takes care of this by caching and merging results when generating reports, so your report actually includes coverage across your test suites and thereby gives you a better picture of blank spots.

Basic usage

To use Simplecov Tailwindcss you will need to ensure your Formatter is set to use Simplecov Tailwindcss.

Features

Features available with HTML Formatter for simplecov

  • Tabular view for Groupings
  • File name searches
  • Modal view of File Coverage from Click of Row
  • Tile views for Stats in a group
  • Clean Title of project
  • Branches Coverage
  • Support of Dark Mode
  • Support sort, search, and file open on page refresh
  • File Details for slideover view

Adding to formatters

In your helper ensure your line about formatter usage is one of the following.

Ensure to add the require tag at the top of your helper class where Simplecov is configured

require 'simplecov-tailwindcss'

Single Formatter Usage:

SimpleCov.formatter = SimpleCov::Formatter::TailwindFormatter

Multi Formatter Usage:

SimpleCov.formatters =
  SimpleCov::Formatter::MultiFormatter.new(
    [SimpleCov::Formatter::HTMLFormatter, SimpleCov::Formatter::TailwindFormatter],
  )

Resources

License

Simplecov Tailwind is available as open source under the terms of the MIT License.

Change Log

Latest release details

Version 2.1.0

Features
  • Touch up Color contrast on file views (#22)
  • Add File Details for slideover view of File (#27)
Updates
  • Updated view of File list to show Percent covered better (#29)
Bug Fixes
  • Fixed View not changing per row (#26)
  • Fix bottom of small file views (#23)

Getting help

There are many ways to get assistance via Issues, Discussions, Pull Requests and Discord Community.

Contributing

Bug Reports, Feature Requests, and Pull Requests are welcome on GitHub at https://github.com/chiefpansancolt/simplecov-tailwindcss. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

To see more about Contributing check out this document.

  • Fork Repo and create new branch
  • Once all is changed and committed create a pull request.

Ensure all merge conflicts are fixed and CI is passing.

Join the community

Join the community buy posting in our discussions on GitHub or joining the community on discord!

Next
Installation