README.md in solargraph_test_coverage-0.3.1 vs README.md in solargraph_test_coverage-0.3.1.1
- old
+ new
@@ -1,16 +1,19 @@
# SolargraphTestCoverage
Solargraph Plugin that provides a diagnostic reporter for unit-test coverage.
-Currently there are four different diagnostics:
+Currently there are four different diagnostics when viewing an app/unit file:
- Line is not covered
- Branch is not covered (With a note if it's the 'THEN' or 'ELSE' branch)
- Spec is failing (Error message will be on line 1)
- Spec cannot be found (Error message will be on line 1)
+There's one diagnostic if you're viewing a spec file:
+- Example Status. Reports if an `it` block is currently failing (rspec only for now)
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -22,10 +25,11 @@
```yaml
plugins:
- solargraph_test_coverage
reporters:
- test_coverage
+ - example_status
```
Additionally, a `test_coverage` key can be added to `.solargraph.yml`. The default values are shown below:
```yaml
@@ -35,9 +39,10 @@
coverage:
- line
- branch
- test_failing
- test_missing
+ - example_failing
exclude_paths:
- 'app/controller'
- 'concerns'
```