@kanjijs/config 0.2.0-beta.1

package/README.md

@@ -0,0 +1,67 @@
+# @kanjijs/config
+
+Type-safe configuration module for Kanjijs Framework, powered by Zod.
+
+## Installation
+
+```bash
+bun add @kanjijs/config zod dotenv
+```
+
+## Usage
+
+### 1. Define your Config Schema
+Create a Zod schema that represents your required environment variables.
+
+```typescript
+// config.ts
+import { z } from "zod";
+
+export const AppConfig = z.object({
+  DATABASE_URL: z.string(),
+  PORT: z.coerce.number().default(3000),
+  NODE_ENV: z.enum(["development", "production", "test"]).default("development"),
+});
+
+export type AppConfigType = z.infer<typeof AppConfig>;
+```
+
+### 2. Register ConfigModule
+Import `ConfigModule` in your root `AppModule` using `.forRoot()`. Pass your Zod schema.
+
+```typescript
+// app.module.ts
+import { Module } from "@kanjijs/core";
+import { ConfigModule } from "@kanjijs/config";
+import { AppConfig } from "./config";
+
+@Module({
+  imports: [
+    ConfigModule.forRoot({
+      schema: AppConfig,
+      envFilePath: ".env" // optional, default
+    })
+  ]
+})
+export class AppModule {}
+```
+
+### 3. Inject ConfigService
+Inject `ConfigService` where needed. Pass the config type generic for auto-completion.
+
+```typescript
+// user.service.ts
+import { Injectable } from "@kanjijs/core";
+import { ConfigService } from "@kanjijs/config";
+import type { AppConfigType } from "./config";
+
+@Injectable()
+export class UserService {
+  constructor(private config: ConfigService<AppConfigType>) {}
+
+  getDbUrl() {
+    // Fully typed! Returns string.
+    return this.config.get("DATABASE_URL");
+  }
+}
+```