Skip to content

Commit 3cafe2d

Browse files
committed
Update README with simple configuration section
1 parent c3d037d commit 3cafe2d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,26 @@ module.exports = {
2121
};
2222
```
2323

24+
## Simple Configuration
25+
26+
If you just want to get started quickly without too much configuration, you can use the following simple setup in your Jest configuration file:
27+
28+
```javascript
29+
module.exports = {
30+
// ... other Jest configuration options
31+
reporters: [
32+
"default",
33+
["jest-angular-test-verifier", {
34+
failOnMissingTests: true
35+
}]
36+
]
37+
};
38+
```
39+
40+
With this simple configuration, the reporter will start checking for test files in the default directory `'src/app'` and it will display an error and fail the tests if any of the specified file types (components, services, guards, directives, and pipes) are missing their corresponding test files.
41+
42+
Feel free to customize the configuration further by adding more options as needed, but this simple setup should get you started quickly.
43+
2444
## Configuration Options
2545

2646
You can configure the reporter by providing a second argument with options in your configuration file:

0 commit comments

Comments
 (0)