unrift 0.4.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# UNRIFT
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/unrift)
|
|
4
|
+
[](https://www.npmjs.com/package/unrift)
|
|
5
|
+
[](https://github.com/ElijahKotyluk/unrift/actions/workflows/ci.yml)
|
|
6
|
+
[](https://github.com/ElijahKotyluk/unrift/blob/main/LICENSE)
|
|
7
|
+
[](https://nodejs.org)
|
|
8
|
+
[](https://unrift.pages.dev)
|
|
9
|
+
|
|
10
|
+
A lightweight, fast TypeScript test framework with ESM-first design.
|
|
11
|
+
|
|
12
|
+
**[Documentation](https://unrift.pages.dev)** · [Getting Started](https://unrift.pages.dev/getting-started/installation) · [API Reference](https://unrift.pages.dev/reference/matchers)
|
|
13
|
+
|
|
14
|
+
## Features
|
|
15
|
+
|
|
16
|
+
- **ESM-first** with CJS fallback
|
|
17
|
+
- **TypeScript native** — esbuild-powered transforms, no separate compile step
|
|
18
|
+
- **Familiar API** — `describe` / `it` / `expect` (Jest/Vitest compatible)
|
|
19
|
+
- **Rich matcher set** — deep equality, `toMatchObject`, `toHaveProperty`, numeric, async, and more
|
|
20
|
+
- **Extensible matchers** via `expect.extend()`
|
|
21
|
+
- **Async assertions** — `resolves` / `rejects` with full `.not` support
|
|
22
|
+
- **Test modifiers** — `.only`, `.skip`, `.todo`
|
|
23
|
+
- **Bail mode** and configurable timeouts
|
|
24
|
+
- **JSON output** for CI integration
|
|
25
|
+
- **Programmatic API** — `runEngine` for use in custom tooling
|
|
26
|
+
- **Zero config** — works out of the box
|
|
27
|
+
|
|
28
|
+
## Install
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npm install -D unrift
|
|
32
|
+
# or
|
|
33
|
+
pnpm add -D unrift
|
|
34
|
+
# or
|
|
35
|
+
yarn add -D unrift
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Quick Start
|
|
39
|
+
|
|
40
|
+
```ts
|
|
41
|
+
// math.spec.ts
|
|
42
|
+
import { describe, it, expect } from "unrift";
|
|
43
|
+
|
|
44
|
+
describe("math", () => {
|
|
45
|
+
it("adds numbers", () => {
|
|
46
|
+
expect(1 + 2).toBe(3);
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
it("compares objects", () => {
|
|
50
|
+
expect({ a: 1 }).toEqual({ a: 1 });
|
|
51
|
+
});
|
|
52
|
+
});
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npx unrift
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
For more examples, see the [Quick Start guide](https://unrift.pages.dev/getting-started/quick-start).
|
|
60
|
+
|
|
61
|
+
## Documentation
|
|
62
|
+
|
|
63
|
+
Visit **[unrift.pages.dev](https://unrift.pages.dev)** for the full documentation:
|
|
64
|
+
|
|
65
|
+
- [Installation](https://unrift.pages.dev/getting-started/installation)
|
|
66
|
+
- [Configuration](https://unrift.pages.dev/guide/configuration)
|
|
67
|
+
- [CLI](https://unrift.pages.dev/guide/cli)
|
|
68
|
+
- [Matchers](https://unrift.pages.dev/reference/matchers)
|
|
69
|
+
- [Hooks](https://unrift.pages.dev/reference/hooks)
|
|
70
|
+
- [Custom Matchers](https://unrift.pages.dev/guide/custom-matchers)
|
|
71
|
+
- [Async Testing](https://unrift.pages.dev/guide/async-testing)
|
|
72
|
+
- [Migrating from Jest](https://unrift.pages.dev/guide/migrating-from-jest)
|
|
73
|
+
- [Programmatic API](https://unrift.pages.dev/reference/programmatic-api)
|
|
74
|
+
|
|
75
|
+
## License
|
|
76
|
+
|
|
77
|
+
MIT
|