Skip to content
This repository has been archived by the owner on Aug 4, 2020. It is now read-only.

Commit

Permalink
chore(project): add release 1.2.8
Browse files Browse the repository at this point in the history
  • Loading branch information
Olavo Parno committed Mar 21, 2019
1 parent 55da68c commit dd2e671
Show file tree
Hide file tree
Showing 4 changed files with 279 additions and 124 deletions.
22 changes: 21 additions & 1 deletion README-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@
]
```
- Have a _*README-template.md*_ file created.
- You are able to change your coverageDir if you wish. You can either use your `jest.config.js` or `jestconfig.json`, via the jest config node in your `package.json` or even passing in as an argument, see below:

- `jestconfig.json` or `package.json` (this inside jest config node) example:
```json
"coverageDirectory": "./my-custom-coverage-folder"
```

- When calling it from one of your project scripts inside your `package.json`:
```bash
jest-badges-readme --coverageDir='./my-custom-coverage-folder'"
```
### Let's all get back to what Jest covers for us.
Expand Down Expand Up @@ -84,4 +95,13 @@ Which results in in the report above!
```json
"make-readme": "npm run test:coverage && jest-badges-readme"
```
```
- Using a different coverage folder passed as arguments
```json
"make-readme": "npm run test:coverage && jest-badges-readme --coverageDir='./my-custom-coverage-folder'"
```
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

| Statements | Branches | Functions | Lines | Build Status | Built By | We Love |
| -----------|----------|-----------|-------| ------------ | -------- | ------- |
| ![Statements](https://img.shields.io/badge/Coverage-97.37%25-brightgreen.svg "Make me better!") | ![Branches](https://img.shields.io/badge/Coverage-90.91%25-brightgreen.svg "Make me better!") | ![Functions](https://img.shields.io/badge/Coverage-100%25-brightgreen.svg "Make me better!") | ![Lines](https://img.shields.io/badge/Coverage-97.37%25-brightgreen.svg "Make me better!") | ![BuildStatus](https://img.shields.io/badge/Build-Passing-brightgreen.svg "Building Status") | ![BuiltBy](https://img.shields.io/badge/TypeScript-Lovers-black.svg "img.shields.io") | ![ForTheBadge](https://img.shields.io/badge/Using-Badges-red.svg "ForTheBadge")
| ![Statements](https://img.shields.io/badge/Coverage-75.95%25-red.svg "Make me better!") | ![Branches](https://img.shields.io/badge/Coverage-71.74%25-red.svg "Make me better!") | ![Functions](https://img.shields.io/badge/Coverage-80%25-yellow.svg "Make me better!") | ![Lines](https://img.shields.io/badge/Coverage-75.95%25-red.svg "Make me better!") | ![BuildStatus](https://img.shields.io/badge/Build-Passing-brightgreen.svg "Building Status") | ![BuiltBy](https://img.shields.io/badge/TypeScript-Lovers-black.svg "img.shields.io") | ![ForTheBadge](https://img.shields.io/badge/Using-Badges-red.svg "ForTheBadge")

### TL;DR

Expand Down Expand Up @@ -33,6 +33,17 @@
]
```
- Have a _*README-template.md*_ file created.
- You are able to change your coverageDir if you wish. You can either use your `jest.config.js` or `jestconfig.json`, via the jest config node in your `package.json` or even passing in as an argument, see below:

- `jestconfig.json` or `package.json` (this inside jest config node) example:
```json
"coverageDirectory": "./my-custom-coverage-folder"
```

- When calling it from one of your project scripts inside your `package.json`:
```bash
jest-badges-readme --coverageDir='./my-custom-coverage-folder'"
```
### Let's all get back to what Jest covers for us.
Expand Down Expand Up @@ -84,4 +95,13 @@ Which results in in the report above!
```json
"make-readme": "npm run test:coverage && jest-badges-readme"
```
```
- Using a different coverage folder passed as arguments
```json
"make-readme": "npm run test:coverage && jest-badges-readme --coverageDir='./my-custom-coverage-folder'"
```

0 comments on commit dd2e671

Please sign in to comment.