https://github.com/danr/proptest
Property-based testing a'la QuickCheck for TypeScript and JavaScript
https://github.com/danr/proptest
Last synced: 11 months ago
JSON representation
Property-based testing a'la QuickCheck for TypeScript and JavaScript
- Host: GitHub
- URL: https://github.com/danr/proptest
- Owner: danr
- License: mit
- Created: 2018-01-23T23:04:57.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T22:51:37.000Z (almost 5 years ago)
- Last Synced: 2024-11-14T00:12:52.769Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 163 KB
- Stars: 20
- Watchers: 5
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Property-based testing for TypeScript and JavaScript
This is an implementation of property-based testing a'la QuickCheck for TypeScript.
It works with plain JavaScript and languages like CoffeeScript too.
Shrinking is done by generating lazy rose trees of values directly.
This means that you can map and chain generators and get correct
shrinking functions "for free". This is a deviation from the original
Haskell library but works well in languages without typeclasses.
(The same approach is taken in other implementations
such as Hedgehog for Haskell, Hypothesis for Python and test.check for Clojure)
#### Usage with mocha and jest
```typescript
import * as QC from 'proptest'
const property = QC.createProperty(it)
describe('f', () => {
property(
'is commutative',
QC.nat.two(),
([x, y]) => (expect(f(x, y)).toEqual(f(y, x)), true)
)
})
```
(to be improved; remove returning a boolean: [discussion](https://github.com/danr/proptest/pull/6#issuecomment-370249397))
#### Usage with tape
```typescript
import * as QC from 'proptest'
const check = QC.adaptTape(test)
check('f commutative', QC.nat.two(), ([x, y]) => f(x, y) === f(y, x))
```
#### Usage with AVA
```typescript
import * as QC from 'proptest'
test('f commutative', t => {
t.true(QC.stdoutForall(QC.nat.two(), ([x, y]) => f(x, y) === f(y, x)))
})
```
(to be improved, also see [ava#1692](https://github.com/avajs/ava/issues/1692))
#### Usage without a library as an assertion
```typescript
import * as QC from 'proptest'
QC.assertForall(QC.nat.two(), ([x, y]) => f(x, y) === f(y, x))
```
The API exports a function `search` which returns `{'ok': true}` if the property
passed or `{'ok': false}` and the counterexample (or other information) if it did not.
### Installation
You can grab it from npm:
```
npm i -D proptest
```
You may use yarn:
```
yarn add --dev proptest
```
### Contributors
* Simon Friis Vindum [@paldepind](https://github.com/paldepind) ([commits](https://github.com/danr/proptest/commits?author=paldepind))
### Ongoing discussions
* Should properties return a boolean of success or just not throw an assertion? [#6](https://github.com/danr/proptest/pull/6) [#5](https://github.com/danr/proptest/issues/5)
### License
MIT