Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ As part of the Mono-Repo it also provides some shim implementations which are de
The documentation site includes:
- Quick start guides and usage examples
- Feature highlights and comparison tables
- Migration guides (e.g., from Chai.js)
- Migration guides:
- [From Node.js Native Assert](https://nevware21.github.io/tripwire/migration/migrating-from-node-assert.html)
- [From Chai.js](https://nevware21.github.io/tripwire/migration/migrating-from-chai.html)
- Detailed guides for specific features (like change/increase/decrease assertions)
- [Expression Adapter Guide](https://nevware21.github.io/tripwire/expression-adapter.html) - Creating custom assertions using expressions
- Links to full TypeDoc API reference for each module
Expand Down
5 changes: 5 additions & 0 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ expect({ a: 1 }).to.deep.equal({ a: 1 });

**Guides**:
- [Change/Increase/Decrease Assertions](https://nevware21.github.io/tripwire/change-assertions)
- [Expression Adapter Guide](https://nevware21.github.io/tripwire/expression-adapter)

**Migration Guides**:
- [Migrating from Node.js Native Assert](https://nevware21.github.io/tripwire/migration/migrating-from-node-assert)
- [Migrating from Chai](https://nevware21.github.io/tripwire/migration/migrating-from-chai)

**Repository**: [github.com/nevware21/tripwire](https://github.com/nevware21/tripwire)

Expand Down
19 changes: 19 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,25 @@ expect("hello").to.be.a.string;
expect({ a: 1 }).to.deep.equal({ a: 1 });
```

## Migration Guides

### Migrating from Node.js Native Assert

[Migrating from Node.js Assert to Tripwire](migration/migrating-from-node-assert.md) - Complete guide for migrating from Node.js native assert module

**Key difference to be aware of:**
```diff
// Node.js: deepStrictEqual uses structural equality
const result = Object.assign({}, { a: 1 });
assert.deepStrictEqual(result, { a: 1 }); // ✅ Passes

// Tripwire: deepStrictEqual requires same instances
- assert.deepStrictEqual(result, { a: 1 }); // ❌ Fails
+ assert.deepEqual(result, { a: 1 }); // ✅ Passes
```

See the [full migration guide](migration/migrating-from-node-assert.md) for complete details and examples.

## Shim Chai

[![npm version](https://badge.fury.io/js/%40nevware21%2Ftripwire-chai.svg)](https://badge.fury.io/js/%40nevware21%2Ftripwire-chai)
Expand Down
Loading