Skip to content

Commit

Permalink
Readme refinements
Browse files Browse the repository at this point in the history
  • Loading branch information
chgeo committed Feb 20, 2025
1 parent 7713c2d commit 643dd8b
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## About this project

A library with utilities to write tests for CAP Node.js applications, like
- Starting and stopping a CAP server before and after the test
This is a library with test utilities for CAP Node.js applications, like
- Starting and stopping a CAP server before and after tests
- A bound HTTP client for the server
- `chai` assertion helpers
- `chai`-like assertion helpers

## Requirements and Setup

Expand All @@ -14,6 +14,8 @@ In your application project, just install the package as dev dependency:
npm add -D @cap-js/cds-test
```

## Usage

Add a simple test file `test/bookshop.test.js ` with this content:
```js
import cds from '@sap/cds'
Expand All @@ -28,13 +30,17 @@ describe('Sample tests', () => {
})
```
and run it with Jest, for example:
Run it with Jest, for example:
```sh
npx jest
```
`node --test` and `mocha` runners are supported, too, though with less coverage in real-life projects.
## Documentation
See the [CAP documentation on `cds.test`](https://cap.cloud.sap/docs/node.js/cds-test) for more.
## Support, Feedback, Contributing
Expand Down

0 comments on commit 643dd8b

Please sign in to comment.