@craftycodesmith/node-structure 1.0.1 → 1.0.3

package/README.md

@@ -0,0 +1,107 @@
+# Feature-Based CLI Generator
+
+A zero-dependency CLI tool to scaffold Node.js projects with a **Feature-Based (Modular) Architecture** using TypeScript.
+
+---
+
+## 🚀 Quick Start
+
+You can run this tool directly using `npx` without installation:
+```bash
+# Initialize a new project
+npx your-package-name init [folder-name]
+
+# Generate a feature module
+npx your-package-name res [resource-name]
+```
+
+---
+
+## 📦 Commands
+
+### `init [folder-name]`
+
+Creates a new project with the feature-based architecture structure.
+
+**Usage:**
+```bash
+npx your-package-name init my-project
+```
+
+If no folder name is provided, it initializes in the current directory.
+
+**What it does:**
+- Creates the directory structure
+- Runs `npm init -y`
+- Installs TypeScript and `@types/node`
+- Generates a `tsconfig.json`
+- Sets up base folders (`features`, `common`, `config`, `middleware`)
+
+---
+
+### `res [resource-name]`
+
+Generates a new feature module with Controller, Service, and Model files.
+
+**Usage:**
+```bash
+npx your-package-name res User
+```
+
+This creates:
+```
+src/features/user/
+├── user.controller.ts
+├── user.service.ts
+└── user.model.ts
+```
+
+Each file includes boilerplate code to get you started quickly.
+
+---
+
+## 🏗 Generated Architecture
+
+The tool enforces a modular structure where each functional area of your application lives in its own "feature" folder.
+```
+project-root/
+├── src/
+│   ├── features/
+│   │   └── [feature-name]/
+│   │       ├── [name].controller.ts
+│   │       ├── [name].service.ts
+│   │       └── [name].model.ts
+│   ├── common/      # Shared utilities and helpers
+│   ├── config/      # Environment and DB configurations
+│   └── middleware/  # Global Express/Koa middlewares
+├── tsconfig.json
+└── package.json
+```
+
+---
+
+## 🛠 Features
+
+- **Zero Dependencies**: Lightweight and fast
+- **TypeScript Ready**: Automatically generates `tsconfig.json` and installs `@types/node` and `typescript`
+- **Automated Setup**: Runs `npm init -y` and dependency installation automatically
+- **Clean Code**: Generates boilerplate classes and interfaces for rapid development
+- **Modular Architecture**: Each feature is self-contained for better maintainability
+
+---
+
+## 📝 Example Workflow
+```bash
+# 1. Create a new project
+npx your-package-name init my-app
+
+# 2. Navigate to the project
+cd my-app
+
+# 3. Generate features
+npx your-package-name res User
+npx your-package-name res Product
+npx your-package-name res Order
+
+# 4. Start building!
+```

package/dist/index.js

@@ -5,43 +5,51 @@ const node_child_process_1 = require("node:child_process");
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const node_util_1 = require("node:util");
-const { values, positionals } = (0, node_util_1.parseArgs)({
-    allowPositionals: true,
-    options: {
-        help: { type: 'boolean', short: 'h' }
-    }
+const { positionals } = (0, node_util_1.parseArgs)({
+    allowPositionals: true
 });
 const command = positionals[0];
-const root = process.cwd();
 const getTemplate = (type, name) => {
     const templates = {
         controller: `export class ${name}Controller {\n  // Logic for ${name}\n}`,
         service: `export class ${name}Service {\n  // Business logic for ${name}\n}`,
         model: `export interface ${name} {\n  id: string;\n}`,
-        tsconfig: `{\n  "compilerOptions": {\n    "target": "ESNext",\n    "module": "NodeNext",\n    "outDir": "./dist",\n    "strict": true\n  }\n}`
+        tsconfig: `{\n  "compilerOptions": {\n    "target": "ESNext",\n    "module": "NodeNext",\n    "moduleResolution": "NodeNext",\n    "outDir": "./dist",\n    "rootDir": "./src",\n    "strict": true,\n    "esModuleInterop": true\n  },\n  "include": ["src/**/*"]\n}`
     };
     return templates[type] || '';
 };
-// --- Command Handlers ---
-const init = () => {
-    console.log('Initializing feature-based structure...');
+const init = (targetDir = '.') => {
+    const root = (0, node_path_1.resolve)(process.cwd(), targetDir);
+    console.log(`Initializing structure in: ${root}`);
+    // Create target directory if it doesn't exist
+    if (!(0, node_fs_1.existsSync)(root)) {
+        (0, node_fs_1.mkdirSync)(root, { recursive: true });
+    }
     const folders = ['src/features', 'src/common', 'src/config'];
     folders.forEach(folder => {
         (0, node_fs_1.mkdirSync)((0, node_path_1.join)(root, folder), { recursive: true });
     });
     (0, node_fs_1.writeFileSync)((0, node_path_1.join)(root, 'tsconfig.json'), getTemplate('tsconfig', ''));
+    // Execute commands inside the target directory
+    const execOptions = { cwd: root, stdio: 'inherit' };
     if (!(0, node_fs_1.existsSync)((0, node_path_1.join)(root, 'package.json'))) {
-        (0, node_child_process_1.execSync)('npm init -y', { stdio: 'inherit' });
+        (0, node_child_process_1.execSync)('npm init -y', execOptions);
     }
-    (0, node_child_process_1.execSync)('npm install -D typescript @types/node ts-node', { stdio: 'inherit' });
+    (0, node_child_process_1.execSync)('npm install -D typescript @types/node ts-node', execOptions);
     console.log('Project initialized successfully.');
 };
 const generateResource = (name) => {
     if (!name) {
-        console.error('Error: Please provide a resource name.');
+        console.error('Error: Please provide a resource name (e.g., npx my-cli res user)');
         process.exit(1);
     }
+    // Assumes execution from project root
+    const root = process.cwd();
     const featureDir = (0, node_path_1.join)(root, 'src/features', name.toLowerCase());
+    if (!(0, node_fs_1.existsSync)((0, node_path_1.join)(root, 'src'))) {
+        console.error('Error: src directory not found. Run "init" first.');
+        process.exit(1);
+    }
     (0, node_fs_1.mkdirSync)(featureDir, { recursive: true });
     const files = [
         { fileName: `${name.toLowerCase()}.controller.ts`, type: 'controller' },
@@ -53,14 +61,14 @@ const generateResource = (name) => {
     });
     console.log(`Module "${name}" generated in ${featureDir}`);
 };
-// --- Simple Router ---
+// --- Command Dispatcher ---
 switch (command) {
     case 'init':
-        init();
+        init(positionals[1]); // positionals[1] is the folder name if provided
         break;
     case 'res':
         generateResource(positionals[1]);
         break;
     default:
-        console.log('Usage: npx your-tool <command> [args]\nCommands: init, res [name]');
+        console.log('Usage:\n  npx my-cli init [folder-name]\n  npx my-cli res [resource-name]');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@craftycodesmith/node-structure",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Feature-based architecture generator",
   "main": "dist/index.js",
   "bin": {