Skip to content

Commit d46cf02

Browse files
committed
build(js-testing):v2.0.0
1 parent d8cfc43 commit d46cf02

File tree

4 files changed

+40
-105
lines changed

4 files changed

+40
-105
lines changed

libs/javascript/testing/README.md

Lines changed: 13 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,25 @@
1-
# Utilities (`@studiohyperdrive/utils`)
1+
# Javascript Tools: Testing (`@studiohyperdrive/testing`)
2+
3+
`@studiohyperdrive/testing` is a set of common testing utils.
4+
5+
## Installation
26

37
Install the package first:
48

59
```shell
610
npm install @studiohyperdrive/testing
711
```
812

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
3114

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:
3316

34-
## Team
17+
- `major`: Introduces new features or breaking changes
18+
- `minor`: Introduces minor non-breaking changes
19+
- `patch`: Introduces bugfixes
3520

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.
3722

38-
Contributors:
23+
## Documentation
3924

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).

libs/javascript/testing/docs/factories/early-return-empty-array-value/early-return-empty-array-value.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

libs/javascript/testing/docs/factories/early-return-on-falsy-value/early-return-on-falsy-value.md

Lines changed: 0 additions & 39 deletions
This file was deleted.
Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,33 @@
11
{
2-
"name": "@studiohyperdrive/testing",
3-
"license": "MIT",
4-
"version": "1.0.0",
5-
"homepage": "https://github.com/studiohyperdrive/tools/tree/main/packages/testing/README.md",
6-
"repository": "https://github.com/studiohyperdrive/tools/tree/main/packages/testing",
7-
"devDependencies": {
8-
"vite": "~4.3.9",
9-
"@nx/vite": "16.6.0",
10-
"vite-plugin-dts": "~2.3.0",
11-
"vite-plugin-static-copy": "0.17.0"
12-
},
13-
"main": "./index.js",
14-
"module": "./index.mjs",
15-
"typings": "./index.d.ts",
2+
"name": "@studiohyperdrive/testing",
3+
"version": "2.0.0",
4+
"description": "A package containing common testing use-cases.",
5+
"keywords": [
6+
"testing"
7+
],
8+
"homepage": "https://open-source.studiohyperdrive.be/docs/javascript/testing/introduction",
9+
"author": {
10+
"name": "Studio Hyperdrive",
11+
"url": "https://studiohyperdrive.be/"
12+
},
13+
"repository": {
14+
"type": "git",
15+
"url": "https://github.com/studiohyperdrive/hyperdrive-opensource",
16+
"directory": "libs/javascript/testing/src"
17+
},
18+
"license": "MIT",
19+
"devDependencies": {
20+
"vite": "~4.3.9",
21+
"@nx/vite": "16.6.0",
22+
"vite-plugin-dts": "~2.3.0",
23+
"vite-plugin-static-copy": "0.17.0"
24+
},
25+
"main": "./index.js",
26+
"module": "./index.mjs",
27+
"typings": "./index.d.ts",
1628
"dependencies": {
1729
"@nx/vite": "20.2.1",
1830
"vite": "5.4.11",
1931
"vite-plugin-dts": "4.3.0"
2032
}
21-
}
33+
}

0 commit comments

Comments
 (0)