Skip to content

Conversation

@nev21
Copy link
Contributor

@nev21 nev21 commented Jan 22, 2026

… documentation

New Features

  • Implemented assert.isNumber() and assert.isNotNumber() assertion methods
  • Implemented assert.isBoolean() and assert.isNotBoolean() assertion methods

Implementation Details

  • Imported isNumberFunc and isBooleanFunc to assertClass.ts
  • Added method signatures to IAssertClass interface with complete TypeDoc documentation

Documentation Updates

  • Enhanced all README files with improved structure and clarity
  • Converted Feature Highlights to comprehensive HTML table format
  • Added code formatting for all function names
  • Expanded documentation with:
    • Quick Start guides for all modules
    • Installation and version range recommendations
    • Detailed usage examples and code snippets
    • Feature comparison tables
    • Migration guides for Chai shim
  • Updated Type Checking section with isNumber and isBoolean examples
  • Improved formatting and readability across all documentation files
  • Fixed typo: "packare" → "package"

@nev21 nev21 added this to the 0.1.5 milestone Jan 22, 2026
Copilot AI review requested due to automatic review settings January 22, 2026 06:37
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds isNumber/isNotNumber and isBoolean/isNotBoolean assertion methods to the tripwire assertion library, along with comprehensive documentation improvements across all README files.

Changes:

  • Added four new assertion methods (assert.isNumber(), assert.isNotNumber(), assert.isBoolean(), assert.isNotBoolean()) with full TypeDoc documentation
  • Enhanced all README files with improved formatting, comprehensive feature tables, Quick Start guides, and migration examples
  • Fixed typos: "packare" → "package" and "Primive" → "Primitive"

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
core/src/assert/assertClass.ts Added imports for isNumberFunc and isBooleanFunc, wired up new assertions via createExprAdapter
core/src/assert/interface/IAssertClass.ts Added method signatures for isNumber, isNotNumber, isBoolean, isNotBoolean with comprehensive TypeDoc examples; fixed "Primive" → "Primitive" typo
core/test/src/assert/assert.isNumber.test.ts New comprehensive test suite for isNumber and isNotNumber assertions covering all edge cases
core/test/src/assert/assert.isBoolean.test.ts New comprehensive test suite for isBoolean and isNotBoolean assertions covering all edge cases
core/README.md Enhanced with better structure, feature highlights, installation instructions, and improved examples
shim/chai/README.md Restructured with migration guide, feature comparison, installation steps, and clearer usage examples
docs/README.md Added Quick Start sections, feature highlight tables with code examples for both core and Chai shim
README.md Fixed "packare" → "package" typo and improved feature list formatting

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated no new comments.

@nev21 nev21 force-pushed the nev21/readmeDocs branch 5 times, most recently from 8d89147 to 6a27193 Compare January 22, 2026 07:39
… documentation

## New Features
- Implemented `assert.isNumber()` and `assert.isNotNumber()` assertion methods
- Implemented `assert.isBoolean()` and `assert.isNotBoolean()` assertion methods

## Implementation Details
- Imported `isNumberFunc` and `isBooleanFunc` to assertClass.ts
- Added method signatures to IAssertClass interface with complete TypeDoc documentation

## Documentation Updates
- Enhanced all README files with improved structure and clarity
- Converted Feature Highlights to comprehensive HTML table format
- Added code formatting for all function names
- Expanded documentation with:
  - Quick Start guides for all modules
  - Installation and version range recommendations
  - Detailed usage examples and code snippets
  - Feature comparison tables
  - Migration guides for Chai shim
- Updated Type Checking section with isNumber and isBoolean examples
- Improved formatting and readability across all documentation files
- Fixed typo: "packare" → "package"
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 8 out of 8 changed files in this pull request and generated no new comments.

@nev21 nev21 enabled auto-merge (squash) January 22, 2026 08:10
@nev21 nev21 merged commit f0ad8f2 into main Jan 22, 2026
16 checks passed
@nev21 nev21 deleted the nev21/readmeDocs branch January 22, 2026 08:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants