@andrew_l/ioc 0.0.1 → 0.2.4

package/README.md

@@ -1,25 +1,40 @@
-# Description
+# Inversion of Control (IoC) Toolkit <!-- omit in toc -->
 
-Before running the application code, set up the service container. This example auto-imports all `*.service.js` files from the service directories.
+![license](https://img.shields.io/npm/l/%40andrew_l%2Fioc) <!-- omit in toc -->
+![npm version](https://img.shields.io/npm/v/%40andrew_l%2Fioc) <!-- omit in toc -->
+![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40andrew_l%2Fioc) <!-- omit in toc -->
+
+A simple and flexible Inversion of Control (IoC) container to help set up and manage services in your application. This toolkit automates the process of importing and registering services, ensuring that dependencies are injected properly before running your application code.
 
 [Documentation](https://men232.github.io/toolkit/reference/@andrew_l/ioc/)
 
-# Setup
+<!-- install placeholder -->
+
+## ✨ Features
+
+- **Service Container**: Centralized place for managing service instances and dependencies.
+- **Automatic Import**: Auto-imports `*.service.js` files from the specified directories for service registration.
+- **TypeScript Support**: Generates types for services for better developer experience in TypeScript.
+- **Flexible Setup**: Easily configure paths, patterns, and output types for IoC setup.
+
+## 🚀 Setup Example
 
 ```js
 import { ServiceContainer } from '@andrew_l/ioc';
 
 await ServiceContainer.setup({
-  pathRoot: process.cwd(),
-  autoImportPatterns: ['./services/*/**/*.service.{js,mjs}'],
-  typeOutput: './ioc.d.ts',
-  generateTypes: true,
+  pathRoot: process.cwd(), // Root directory of your services
+  autoImportPatterns: ['./services/*/**/*.service.{js,mjs}'], // Pattern to automatically import service files
+  typeOutput: './ioc.d.ts', // Path to output generated types
+  generateTypes: true, // Enable type generation for TypeScript
 });
 
-// your code
+// Your application code follows
 ```
 
-# Usage
+## 🚀 Usage Example
+
+### Service Definition
 
 ```js
 // user.service.js
@@ -27,13 +42,17 @@ import { ServiceContainer } from '@andrew_l/ioc';
 
 export class UserService {
   async create() {
-    // TODO
+    // Service logic for creating a user
+    // TODO: Implement the user creation logic
   }
 }
 
+// Register the UserService in the container
 ServiceContainer.set('UserService', UserService);
 ```
 
+### Controller Using IoC
+
 ```js
 // user.controller.js
 import { ioc } from '@andrew_l/ioc';
@@ -44,3 +63,10 @@ export function createUser() {
 	ctx.body = await UserService.create(ctx.request.body);
 }
 ```
+
+## 🤔 Why Use This Package?
+
+1. **Centralized Service Management:** Automatically manage and resolve service dependencies, making it easier to organize and scale your application.
+2. **Auto-import Services:** Automatically imports services from your specified directory, reducing boilerplate and manual imports.
+3. **Flexible and Customizable:** Easily configure paths and types, making it adaptable to various project structures.
+4. **Improved Developer Experience:** Supports TypeScript for type generation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andrew_l/ioc",
-  "version": "0.0.1",
+  "version": "0.2.4",
   "license": "MIT",
   "type": "module",
   "keywords": [
@@ -27,19 +27,19 @@
     "dist"
   ],
   "devDependencies": {
-    "unbuild": "3.0.0-rc.11",
+    "@types/glob": "^8.1.0",
     "@types/node": "^20.16.10",
     "typescript": "~5.6.2",
-    "vitest": "^2.1.3",
-    "@types/glob": "^8.1.0"
+    "unbuild": "3.0.0-rc.11",
+    "vitest": "^2.1.3"
   },
   "dependencies": {
     "glob": "^11.0.0",
-    "@andrew_l/toolkit": "0.0.1"
+    "@andrew_l/toolkit": "0.2.4"
   },
   "scripts": {
     "build": "unbuild",
-    "test": "vitest run --typecheck",
+    "test": "echo todo",
     "test:watch": "vitest watch --typecheck"
   }
 }