kizu 4.0.0 → 5.0.0

package/README.md

@@ -40,96 +40,6 @@ Designed to help you write simple, readable, and maintainable tests that do not
 - Works great with [c8](https://github.com/bcoe/c8) for code coverage out of the box (see [getting started](docs/gettingStarted.md)).
 - Handles compilation errors gracefully.
 
-## Installation
-
-```bash
-npm i -D kizu
-```
-
-**Note:** `tsx` is automatically installed as a peer dependency for TypeScript support. kizu will use it for fast TypeScript compilation.
-
-## Module System Support (ESM & CJS)
-
-kizu works seamlessly with both **CommonJS (CJS)** and **ES Modules (ESM)** projects. Here's how it handles different module systems:
-
-### **How It Works**
-
-kizu uses a **hybrid approach** that gives you the best of both worlds:
-
-- **Test Runner**: Runs in CommonJS mode for maximum compatibility
-- **Your Test Code**: Can use any module system (CJS or ESM)
-- **TypeScript Compilation**: Uses `tsx` for fast TypeScript compilation
-
-### **ESM Projects**
-
-If your project uses ESM (`"type": "module"` in package.json):
-
-```typescript
-// test.spec.ts - Your test files can use ESM syntax
-import { test } from 'kizu';
-import { myESMFunction } from './myESMModule.js'; // ESM imports work fine
-
-test('ESM test', (assert) => {
-  const result = myESMFunction();
-  assert.equal(result, 'expected');
-});
-```
-
-**What happens:**
-1. kizu uses `tsx` to compile your TypeScript files to JavaScript
-2. Runs the compiled code (which preserves your ESM imports/exports)
-3. Your ESM code works exactly as expected
-
-### **CJS Projects**
-
-If your project uses CommonJS:
-
-```typescript
-// test.spec.ts - Your test files can use CJS syntax
-import { test } from 'kizu';
-const { myFunction } = require('./myModule'); // CJS imports work fine
-
-test('CJS test', (assert) => {
-  const result = myFunction();
-  assert.equal(result, 'expected');
-});
-```
-
-### **Why This Approach?**
-
-**Benefits:**
-- ✅ **Works everywhere** - No module system conflicts
-- ✅ **Uses your TypeScript setup** - Respects your tsconfig
-- ✅ **No build step needed** - Runs tests immediately
-- ✅ **Predictable behavior** - Same experience across projects
-
-**Technical Details:**
-- kizu uses `tsx` for TypeScript compilation (fast and reliable)
-- This prevents module system conflicts in the test runner
-- Your test code can still use any module system
-- The compilation preserves your original module syntax
-
-### **Mocking Dependencies**
-
-**For CJS modules:** Use [cjs-mock](https://github.com/mhweiner/cjs-mock) for easy dependency mocking:
-
-```typescript
-import { test } from 'kizu';
-import { mock } from 'cjs-mock';
-
-test('mocked test', (assert) => {
-  const mockedModule = mock('./myModule', {
-    './dependency': { someFunction: () => 'mocked' }
-  });
-  
-  assert.equal(mockedModule.doSomething(), 'mocked');
-});
-```
-
-**For ESM modules:** ESM mocking is more complex and not fully supported by most tools. Jest has some ESM mocking capabilities, but they're limited and can be unreliable. For the best testing experience, consider using CJS for modules you need to mock.
-
-If you have any issues running in ESM projects, please [open an issue](https://github.com/mhweiner/kizu/issues).
-
 ## Quick Examples
 
 For more examples, see the [examples](examples) and [src](src) folders.
@@ -137,7 +47,8 @@ For more examples, see the [examples](examples) and [src](src) folders.
 ```bash
 # Run all tests in the src directory and its subdirectories, and only show failures in the output.
 npx kizu 'src/**/*.test.ts' --fail-only
-# Run a specific test file
+
+# Run a specific test file and show all output
 npx kizu 'src/example.test.ts'
 ```
 
@@ -161,64 +72,24 @@ test('user object', (assert) => {
     name: 'John',
     age: 30,
     email: 'john@example.com',
+    hobbies: ['reading', 'coding', 'hiking'],
     preferences: {
       theme: 'dark',
       notifications: true
     }
   };
-  
   const expected = {
-    name: 'John',
-    age: 30,
-    email: 'john@example.com',
+    name: /^[A-Za-z]+$/,
+    age: /^\d+$/,
+    email: /^[^@]+@[^@]+\.[^@]+$/,
+    hobbies: ['reading', 'coding', 'hiking'],
     preferences: {
       theme: 'dark',
       notifications: true
     }
   };
   
-  assert.equal(actual, expected); // Deep equality comparison
-});
-
-// RegExp pattern matching ✨ NEW!
-test('email validation', (assert) => {
-  const email = 'user@example.com';
-  
-  // Match email pattern
-  assert.equal(email, /^[^@]+@[^@]+\.[^@]+$/);
-  
-  // Match domain
-  assert.equal(email, /@example\.com$/);
-  
-  // Match username
-  assert.equal(email, /^user@/);
-});
-
-// Complex data structures
-test('complex data', (assert) => {
-  const actual = {
-    users: [
-      { name: 'Alice', email: 'alice@company.com' },
-      { name: 'Bob', email: 'bob@company.com' }
-    ],
-    metadata: {
-      count: 2,
-      lastUpdated: '2024-01-15'
-    }
-  };
-  
-  const expected = {
-    users: [
-      { name: 'Alice', email: /@company\.com$/ }, // RegExp in nested objects!
-      { name: 'Bob', email: /@company\.com$/ }
-    ],
-    metadata: {
-      count: 2,
-      lastUpdated: /^\d{4}-\d{2}-\d{2}$/ // Date pattern
-    }
-  };
-  
-  assert.equal(actual, expected);
+  assert.equal(actual, expected); // Complex & deep strict object comparison by value, type-safe, and with regular expressions!
 });
 
 // Error handling
@@ -243,9 +114,10 @@ test('fetchData', async (assert) => {
 
 ## Table of Contents
 
-- [Quick Start](docs/quickStart.md)
+- [Installation & Setup](docs/setup.md)
+- [ESM Support](docs/esm.md)
 - [CLI](docs/cli.md)
-- [Test API](docs/api.md)
+- [Assertion API](docs/api.md)
 - [Visual Diff Tool](docs/visualDiff.md)
 - [Example Tests](examples)
 - [Best Practices](docs/bestPractices.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kizu",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "An easy-to-use, fast, and defensive Typescript/Javascript test runner designed to help you to write simple, readable, and maintainable tests.",
   "license": "MIT",
   "main": "./dist/index.js",