@kanjijs/testing 0.2.0-beta.1

package/README.md

@@ -0,0 +1,47 @@
+# @kanjijs/testing
+
+The official testing utility for Kanjijs Framework. It provides a robust way to test your Modules and Controllers by mocking dependencies in the `KanjijsIoC` container.
+
+## Installation
+
+```bash
+bun add -d @kanjijs/testing
+```
+
+## Usage
+
+### Unit Testing Controllers
+
+You can easily mock services to test controllers in isolation.
+
+```typescript
+import { Test } from "@kanjijs/testing";
+import { UsersController } from "./users.controller";
+import { UsersService } from "./users.service";
+import { AppModule } from "./app.module";
+
+describe("UsersController", () => {
+  it("should return mocked users", async () => {
+    // 1. Create a Testing Module
+    const moduleRef = await Test.createTestingModule({
+      imports: [AppModule], // Or just the module containing the controller
+    })
+      .overrideProvider(UsersService)
+      .useValue({
+        findAll: () => ["Test User 1", "Test User 2"],
+      })
+      .compile();
+
+    // 2. Get the Controller instance (dependencies are injected automatically)
+    const controller = moduleRef.get(UsersController);
+
+    // 3. Assert
+    expect(controller.findAll()).toEqual(["Test User 1", "Test User 2"]);
+  });
+});
+```
+
+### Key Features
+- **`Test.createTestingModule(metadata)`**: Creates a sandbox for your test.
+- **`.overrideProvider(token).useValue(mock)`**: Replaces a real provider with a mock implementation.
+- **`KanjijsIoC` Integration**: Automatically resets the DI container between tests to prevent state leakage.