|
1 |
| -# Utilities (`@studiohyperdrive/utils`) |
| 1 | +# Javascript Tools: Testing (`@studiohyperdrive/testing`) |
| 2 | + |
| 3 | +`@studiohyperdrive/testing` is a set of common testing utils. |
| 4 | + |
| 5 | +## Installation |
2 | 6 |
|
3 | 7 | Install the package first:
|
4 | 8 |
|
5 | 9 | ```shell
|
6 | 10 | npm install @studiohyperdrive/testing
|
7 | 11 | ```
|
8 | 12 |
|
9 |
| -## 1. Factories |
10 |
| - |
11 |
| -A set of functions that will generate test cases. |
12 |
| - |
13 |
| -### earlyReturnOnFalsyValue |
14 |
| - |
15 |
| -Test clause factory that will check if a provided falsy argument returns in an early return (undefined). |
16 |
| - |
17 |
| -[Full documentation.](./docs/factories/early-return-on-falsy-value/early-return-on-falsy-value.md) |
18 |
| - |
19 |
| -### earlyReturnEmptyArrayValue |
20 |
| - |
21 |
| -Test clause factory that will check if a provided non-array or empty array argument returns in an early return with empty array. |
22 |
| - |
23 |
| -[Full documentation.](./docs/factories/early-return-empty-array-value/early-return-empty-array-value.md) |
24 |
| - |
25 |
| -## build information |
26 |
| - |
27 |
| -This project has been build with: |
28 |
| - |
29 |
| -- nodejs: `18.17.0` |
30 |
| -- npm: `9.6.7` |
| 13 | +## Versioning and build information |
31 | 14 |
|
32 |
| -For a complete list of packages and version check out the `package.json` file. |
| 15 | +This package will follow a semver-like format, `major.minor.patch`, in which: |
33 | 16 |
|
34 |
| -## Team |
| 17 | +- `major`: Introduces new features or breaking changes |
| 18 | +- `minor`: Introduces minor non-breaking changes |
| 19 | +- `patch`: Introduces bugfixes |
35 | 20 |
|
36 |
| -This bundle of tools has been created and is maintained by [Studio Hyperdrive](https://studiohyperdrive.be). |
| 21 | +For more information about the build process, authors, contributions and issues, we refer to the [hyperdrive-opensource](https://github.com/studiohyperdrive/hyperdrive-opensource) repository. |
37 | 22 |
|
38 |
| -Contributors: |
| 23 | +## Documentation |
39 | 24 |
|
40 |
| -- [Denis Valcke](https://github.com/DenisValcke) |
| 25 | +To find more information regarding this package, we refer to [our documentation platform](https://open-source.studiohyperdrive.be/docs/javascript/testing/introduction). |
0 commit comments