7d0aeeefe5
* Improve format and clarity of the docs [ci skip] While this change produces a lot of git noise by enacting what seems like an arbitrary linewrap on most of the files in the documentation it will result in better version control and tracking of the changes in the documentation. For example, as it currently stands, if one was to make a PR to move a comma in a sentence because each paragraph in most of the files is on a single line, that small change would look in the git history like the author had modified the entire paragraph. In reality, this author just moved a comma. This change also includes a significant number of modifications to the more article-esque docs. Many of these docs were written in a sort of stream-of-conciousness and aren't as easy to read as they could be. Hopefully this is the first of several readability changes. If we could get these docs to a more accessible reading level, we would probably see an increase in contributions. :) * Delegate markdown wrapping to Prettier * Add linewrapping explanation in the docs [ci skip]
61 lines
1.1 KiB
Markdown
61 lines
1.1 KiB
Markdown
---
|
|
title: Code Coverage
|
|
---
|
|
|
|
# Code coverage
|
|
|
|
## Rails
|
|
|
|
Rspec will generate code coverage at the end of the tests.
|
|
|
|
To get the code coverage of the entire Rails codebase, you must run the full
|
|
Ruby test suite. You can run the full test suite with the `rspec` command:
|
|
|
|
```shell
|
|
bundle exec rspec
|
|
```
|
|
|
|
or
|
|
|
|
```shell
|
|
bin/rspec
|
|
```
|
|
|
|
To get the code coverage of a single file, you can run:
|
|
|
|
```shell
|
|
bundle exec rspec spec/models/user_spec.rb
|
|
```
|
|
|
|
or
|
|
|
|
```shell
|
|
bin/rspec spec/models/user_spec.rb
|
|
```
|
|
|
|
Once your tests have completed, the `coverage/index.html` will be regenerated
|
|
with some stats concerning the overall health of our test suite including a code
|
|
coverage metric.
|
|
|
|
To turn off coverage report generation please set environment variable
|
|
`COVERAGE` value to `false`.
|
|
|
|
## Preact
|
|
|
|
Preact tests will generate code coverage at the end of the tests.
|
|
|
|
To get the code coverage of the Preact codebase, you must run the full JS test
|
|
suite. You can run the full test suite with the npm task `test`:
|
|
|
|
```shell
|
|
npm run test
|
|
```
|
|
|
|
or
|
|
|
|
```shell
|
|
yarn test
|
|
```
|
|
|
|
Once the tests have completed, the test coverage metric will be visible in the
|
|
terminal window.
|