@ooneex/cli 0.1.0 → 0.3.0

package/README.md

@@ -1 +1,380 @@
 # @ooneex/cli
+
+A powerful command-line interface for scaffolding Ooneex applications, modules, controllers, services, and more. This package provides an interactive CLI tool with code generation capabilities to accelerate development workflows.
+
+![Bun](https://img.shields.io/badge/Bun-Compatible-orange?style=flat-square&logo=bun)
+![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue?style=flat-square&logo=typescript)
+![MIT License](https://img.shields.io/badge/License-MIT-yellow?style=flat-square)
+
+## Features
+
+✅ **Application Scaffolding** - Generate complete Ooneex applications with best practices
+
+✅ **Module Generation** - Create feature modules with controllers, entities, and services
+
+✅ **Controller Generation** - Generate HTTP and WebSocket controllers with route definitions
+
+✅ **Service Generation** - Create service classes with dependency injection
+
+✅ **Entity Generation** - Generate TypeORM entities with common fields
+
+✅ **CRUD Generation** - Scaffold complete CRUD operations in one command
+
+✅ **Interactive Prompts** - User-friendly prompts for customization
+
+✅ **Docker Support** - Generate Docker configuration files
+
+✅ **Migration & Seeds** - Create database migrations and seed files
+
+## Installation
+
+### Bun (Global)
+```bash
+bun add -g @ooneex/cli
+```
+
+### Bun (Local)
+```bash
+bun add -D @ooneex/cli
+```
+
+### pnpm
+```bash
+pnpm add -D @ooneex/cli
+```
+
+### Yarn
+```bash
+yarn add -D @ooneex/cli
+```
+
+### npm
+```bash
+npm install -D @ooneex/cli
+```
+
+## Usage
+
+### Creating a New Application
+
+```bash
+ooneex make:app
+```
+
+This command will interactively prompt you for:
+- Application name
+- Destination path
+
+The generated application includes:
+- Configured `package.json` with all necessary dependencies
+- TypeScript configuration
+- Biome linting setup
+- Nx workspace configuration
+- Git configuration with `.gitignore`
+- Initial app module
+
+### Generating a Module
+
+```bash
+ooneex make:module
+```
+
+Creates a new feature module with:
+- Module structure
+- Controllers directory
+- Services directory
+- Entities directory
+- Repository files
+- Test scaffolding
+
+### Generating a Controller
+
+```bash
+ooneex make:controller
+```
+
+Interactive prompts will ask for:
+- Controller name
+- Socket or HTTP controller
+- Route namespace (api, admin, public, etc.)
+- Resource name
+- Route action
+- Route path
+- HTTP method (for HTTP controllers)
+
+**Example output:**
+```
+✔ src/controllers/UserListController.ts created successfully
+✔ src/types/routes/api.users.list.ts created successfully
+✔ tests/controllers/UserListController.spec.ts created successfully
+```
+
+### Generating a Service
+
+```bash
+ooneex make:service
+```
+
+Creates a service class with:
+- Dependency injection decorator
+- Interface implementation
+- Test file
+
+### Generating an Entity
+
+```bash
+ooneex make:entity
+```
+
+Creates a TypeORM entity with:
+- Base entity fields (id, timestamps)
+- Primary column configuration
+- Repository integration
+
+### Generating CRUD Operations
+
+```bash
+ooneex make:crud
+```
+
+Scaffolds complete CRUD operations including:
+- List controller
+- Show controller
+- Create controller
+- Update controller
+- Delete controller
+- Associated route types
+- Test files
+
+### Additional Commands
+
+| Command | Description |
+|---------|-------------|
+| `make:ai` | Generate AI service integration |
+| `make:analytics` | Generate analytics service |
+| `make:cache` | Generate cache service |
+| `make:cron` | Generate cron job class |
+| `make:database` | Generate database configuration |
+| `make:docker` | Generate Docker files |
+| `make:logger` | Generate logger service |
+| `make:mailer` | Generate mailer service |
+| `make:middleware` | Generate middleware class |
+| `make:migration` | Generate database migration |
+| `make:permission` | Generate permission class |
+| `make:pubsub` | Generate pub/sub handler |
+| `make:repository` | Generate repository class |
+| `make:seed` | Generate database seeder |
+| `make:storage` | Generate storage service |
+| `make:translation` | Generate translation files |
+
+## API Reference
+
+### Interfaces
+
+#### `ICommand<Options>`
+
+Interface for creating custom CLI commands.
+
+```typescript
+interface ICommand<Options extends Record<string, unknown> = Record<string, unknown>> {
+  run: (options: Options) => Promise<void> | void;
+  getName: () => string;
+  getDescription: () => string;
+}
+```
+
+### Types
+
+#### `CommandClassType`
+
+```typescript
+type CommandClassType = new (...args: any[]) => ICommand;
+```
+
+### Decorators
+
+#### `@decorator.command()`
+
+Decorator to register a command with the CLI container.
+
+```typescript
+import { decorator } from '@ooneex/cli';
+import type { ICommand } from '@ooneex/cli';
+
+@decorator.command()
+class MyCustomCommand implements ICommand {
+  public getName(): string {
+    return 'my:command';
+  }
+
+  public getDescription(): string {
+    return 'My custom command description';
+  }
+
+  public async run(options: Record<string, unknown>): Promise<void> {
+    // Command implementation
+  }
+}
+```
+
+## Advanced Usage
+
+### Creating Custom Commands
+
+```typescript
+import { decorator } from '@ooneex/cli';
+import type { ICommand } from '@ooneex/cli';
+import { TerminalLogger } from '@ooneex/logger';
+
+type MyCommandOptions = {
+  name?: string;
+  verbose?: boolean;
+};
+
+@decorator.command()
+class MyCustomCommand implements ICommand<MyCommandOptions> {
+  private readonly logger = new TerminalLogger();
+
+  public getName(): string {
+    return 'custom:generate';
+  }
+
+  public getDescription(): string {
+    return 'Generate custom files for the project';
+  }
+
+  public async run(options: MyCommandOptions): Promise<void> {
+    const { name, verbose } = options;
+
+    if (verbose) {
+      this.logger.info('Running in verbose mode');
+    }
+
+    // Custom generation logic
+    await Bun.write('output.ts', 'export const example = true;');
+
+    this.logger.success('File generated successfully', undefined, {
+      showTimestamp: false,
+      showArrow: false,
+      useSymbol: true,
+    });
+  }
+}
+```
+
+### Using with Arguments
+
+```bash
+ooneex make:controller --name UserList
+```
+
+### Programmatic Usage
+
+```typescript
+import { getCommand } from '@ooneex/cli';
+
+const command = getCommand('make:controller');
+
+if (command) {
+  await command.run({
+    name: 'UserList',
+    isSocket: false,
+    route: {
+      name: 'api.users.list',
+      path: '/api/users',
+      method: 'GET'
+    }
+  });
+}
+```
+
+### Generated Application Structure
+
+When running `make:app`, the following structure is created:
+
+```
+my-app/
+├── modules/
+│   └── app/
+│       ├── src/
+│       │   ├── controllers/
+│       │   ├── entities/
+│       │   ├── services/
+│       │   └── index.ts
+│       ├── tests/
+│       └── package.json
+├── .commitlintrc.ts
+├── .gitignore
+├── biome.jsonc
+├── bunfig.toml
+├── nx.json
+├── package.json
+└── tsconfig.json
+```
+
+### Generated Module Structure
+
+```
+modules/
+└── user/
+    ├── src/
+    │   ├── controllers/
+    │   ├── entities/
+    │   │   └── UserEntity.ts
+    │   ├── services/
+    │   │   └── UserService.ts
+    │   ├── types/
+    │   │   └── routes/
+    │   └── index.ts
+    ├── tests/
+    │   ├── controllers/
+    │   ├── entities/
+    │   └── services/
+    ├── package.json
+    └── bunup.config.ts
+```
+
+## Error Handling
+
+The CLI provides informative error messages when something goes wrong:
+
+```typescript
+import { CommandException } from '@ooneex/cli';
+
+// Errors are automatically caught and displayed
+// with proper formatting via TerminalLogger
+```
+
+## Environment
+
+The CLI respects the following environment variables:
+
+| Variable | Description |
+|----------|-------------|
+| `CWD` | Custom working directory for file generation |
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+### Development Setup
+
+1. Clone the repository
+2. Install dependencies: `bun install`
+3. Run tests: `bun run test`
+4. Build the project: `bun run build`
+
+### Guidelines
+
+- Write tests for new features
+- Follow the existing code style
+- Update documentation for API changes
+- Ensure all tests pass before submitting PR
+
+---
+
+Made with ❤️ by the Ooneex team

package/dist/index.js

@@ -923,7 +923,7 @@ describe("{{NAME}}Module", () => {
   "include": ["src/**/*.ts", "src/**/*.tsx", "tests/**/*.ts", "tests/**/*.tsx"],
   "exclude": ["node_modules", "dist"]
 }
-`;class T4{getName(){return"make:module"}getDescription(){return"Generate a new module"}async run(Y){let{cwd:X=process.cwd(),silent:$=!1,skipBin:Z=!1,skipMigrations:H=!1,skipSeeds:W=!1,bunupPackages:G="external"}=Y,{name:J}=Y;if(!J)J=await w0({message:"Enter module name"});let L=O0(J).replace(/Module$/,""),A=BX(L),E=gY(X,"modules",A),z=gY(E,"bin"),B=gY(E,"src"),D=gY(E,"tests"),U=Es.replace(/{{NAME}}/g,L),S=Ls.replace(/{{NAME}}/g,L),I=zs.replace(/{{NAME}}/g,A),R=Ds.replace(/{{NAME}}/g,L),F=Js.replace('packages: "external"',`packages: "${G}"`);if(await Bun.write(gY(E,"bunup.config.ts"),F),!Z)await Bun.write(gY(z,"migration","up.ts"),As),await Bun.write(gY(z,"seed","run.ts"),Bs);if(await Bun.write(gY(B,`${L}Module.ts`),U),await Bun.write(gY(B,"index.ts"),S),!H)await Bun.write(gY(B,"migrations","migrations.ts"),"");if(!W)await Bun.write(gY(B,"seeds","seeds.ts"),"");if(await Bun.write(gY(E,"package.json"),I),await Bun.write(gY(E,"tsconfig.json"),Us),await Bun.write(gY(D,`${L}Module.spec.ts`),R),!$)new R0().success(`modules/${A} created successfully`,void 0,{showTimestamp:!1,showArrow:!1,useSymbol:!0})}}T4=I0([P0.command()],T4);class tH{getName(){return"make:app"}getDescription(){return"Generate a new application"}async run(Y){let{name:X,destination:$}=Y;if(!X)X=await w0({message:"Enter application name"});let Z=BX(X);if(!$)$=await au({message:"Enter destination path",initial:Z});let H=Ws.replace(/{{NAME}}/g,Z);await Bun.write(A6($,".commitlintrc.ts"),eu),await Bun.write(A6($,".gitignore"),Ys),await Bun.write(A6($,"biome.jsonc"),Xs),await Bun.write(A6($,"bunfig.toml"),$s),await Bun.write(A6($,"nx.json"),Hs),await Bun.write(A6($,"package.json"),H),await Bun.write(A6($,"tsconfig.json"),Gs),await new T4().run({name:"app",cwd:$,silent:!0,skipBin:!0,skipMigrations:!0,skipSeeds:!0,bunupPackages:"bundle"}),await Bun.write(A6($,"modules","app","src","index.ts"),Zs),await dV0`cd ${$} && bun add ${["@ooneex/analytics","@ooneex/app","@ooneex/app-env","@ooneex/cache","@ooneex/database","@ooneex/logger","@ooneex/mailer","@ooneex/module","@ooneex/rate-limit","@ooneex/storage","reflect-metadata"]} && bun add ${["@ooneex/cli","@biomejs/biome","@commitlint/cli","@commitlint/config-conventional","@commitlint/prompt-cli","@nx/js","@nx/workspace","@swc-node/register","@swc/core","@swc/helpers","@types/bun","@types/node","@typescript/native-preview","bunup","husky","lint-staged","nx","typescript","undici-types"]} -D`,new R0().success(`${Z} created successfully at ${$}`,void 0,{showTimestamp:!1,showArrow:!1,useSymbol:!0})}}tH=I0([P0.command()],tH);import{join as E6}from"path";var Vs=`import { describe, expect, test } from "bun:test";
+`;class T4{getName(){return"make:module"}getDescription(){return"Generate a new module"}async run(Y){let{cwd:X=process.cwd(),silent:$=!1,skipBin:Z=!1,skipMigrations:H=!1,skipSeeds:W=!1,bunupPackages:G="external"}=Y,{name:J}=Y;if(!J)J=await w0({message:"Enter module name"});let L=O0(J).replace(/Module$/,""),A=BX(L),E=gY(X,"modules",A),z=gY(E,"bin"),B=gY(E,"src"),D=gY(E,"tests"),U=Es.replace(/{{NAME}}/g,L),S=Ls.replace(/{{NAME}}/g,L),I=zs.replace(/{{NAME}}/g,A),R=Ds.replace(/{{NAME}}/g,L),F=Js.replace('packages: "external"',`packages: "${G}"`);if(await Bun.write(gY(E,"bunup.config.ts"),F),!Z)await Bun.write(gY(z,"migration","up.ts"),As),await Bun.write(gY(z,"seed","run.ts"),Bs);if(await Bun.write(gY(B,`${L}Module.ts`),U),await Bun.write(gY(B,"index.ts"),S),!H)await Bun.write(gY(B,"migrations","migrations.ts"),"");if(!W)await Bun.write(gY(B,"seeds","seeds.ts"),"");if(await Bun.write(gY(E,"package.json"),I),await Bun.write(gY(E,"tsconfig.json"),Us),await Bun.write(gY(D,`${L}Module.spec.ts`),R),!$)new R0().success(`modules/${A} created successfully`,void 0,{showTimestamp:!1,showArrow:!1,useSymbol:!0})}}T4=I0([P0.command()],T4);class tH{getName(){return"make:app"}getDescription(){return"Generate a new application"}async run(Y){let{name:X,destination:$}=Y;if(!X)X=await w0({message:"Enter application name"});let Z=BX(X);if(!$)$=await au({message:"Enter destination path",initial:Z});let H=Ws.replace(/{{NAME}}/g,Z);await Bun.write(A6($,".commitlintrc.ts"),eu),await Bun.write(A6($,".gitignore"),Ys),await Bun.write(A6($,"biome.jsonc"),Xs),await Bun.write(A6($,"bunfig.toml"),$s),await Bun.write(A6($,"nx.json"),Hs),await Bun.write(A6($,"package.json"),H),await Bun.write(A6($,"tsconfig.json"),Gs),await new T4().run({name:"app",cwd:$,silent:!0,skipBin:!0,skipMigrations:!0,skipSeeds:!0,bunupPackages:"bundle"}),await Bun.write(A6($,"modules","app","src","index.ts"),Zs),await dV0`cd ${$} && bun add ${["@ooneex/routing@0.2.0","@ooneex/analytics","@ooneex/app","@ooneex/app-env","@ooneex/cache","@ooneex/database","@ooneex/logger","@ooneex/mailer","@ooneex/module","@ooneex/rate-limit","@ooneex/storage","reflect-metadata"]} && bun add ${["@ooneex/cli","@biomejs/biome","@commitlint/cli","@commitlint/config-conventional","@commitlint/prompt-cli","@nx/js","@nx/workspace","@swc-node/register","@swc/core","@swc/helpers","@types/bun","@types/node","@typescript/native-preview","bunup","husky","lint-staged","nx","typescript","undici-types"]} -D`,new R0().success(`${Z} created successfully at ${$}`,void 0,{showTimestamp:!1,showArrow:!1,useSymbol:!0})}}tH=I0([P0.command()],tH);import{join as E6}from"path";var Vs=`import { describe, expect, test } from "bun:test";
 import { {{NAME}}CacheAdapter } from "@/cache/{{NAME}}CacheAdapter";
 
 describe("{{NAME}}CacheAdapter", () => {
@@ -2558,4 +2558,4 @@ export default defineConfig({
 `),process.exit(1);var ni=jp(oi);if(!ni)pE.info(`No commands found
 `),process.exit(1);try{await ni.run(FF0)}catch(Y){pE.error(Y,void 0,{showArrow:!1,showTimestamp:!1,showLevel:!1}),process.exit(1)}
 
-//# debugId=369A1D42B8499F0864756E2164756E21
+//# debugId=AC9A96DEDE6CB9FC64756E2164756E21