nest-combo 1.1.1 → 1.2.0

package/README.MD

@@ -19,20 +19,57 @@ A CLI tool to generate NestJS modules, controllers, services, and other componen
 
 ---
 
-## How it works
+## How It Works
 
-How Nest-Combo Works with NestJS CLI
+### How Nest-Combo Works with NestJS CLI
 
-If you have the NestJS CLI installed globally , nest-combo will automatically detect and use it to execute commands. This ensures compatibility with your existing global setup.
+If you have the **NestJS CLI** installed globally, **nest-combo** will automatically detect and use it to execute commands. This ensures compatibility with your existing global setup.
 
-If the NestJS CLI is not installed globally, don't worry! nest-combo comes bundled with its own local version of the NestJS CLI. It will seamlessly fall back to this cached version to ensure smooth operation without requiring any additional setup from you.
-WIth Nest-Combo you will be able to speed you development process with single line commands.
+If the NestJS CLI is not installed globally, don't worry! **nest-combo** comes bundled with its own local version of the NestJS CLI. It will seamlessly fall back to this cached version to ensure smooth operation without requiring any additional setup from you.
+
+---
+
+### Key Features of Nest-Combo
+
+#### 1. **Importing a YAML File for Project Scaffolding**
+
+With **nest-combo**, you can define an entire project structure in a `project.yml` file and let **nest-combo** handle the scaffolding process for you. Simply specify your modules, resources, dependencies, and optional flags in the YAML file, and **nest-combo** will generate the entire project automatically.
+
+This feature encourages thoughtful planning and allows you to automate repetitive tasks, saving you time and effort. Additionally, **nest-combo** supports **recursive logic** for creating nested modules, ensuring that even complex project structures are generated accurately.
+
+For example, you can define deeply nested modules like this:
+
+```yaml
+modules:
+  - name: core
+    resources:
+      - module
+    modules:
+      - name: user
+        resources:
+          - module
+          - controller
+          - service
+        options:
+          - --no-spec
+        modules:
+          - name: subUsers
+            resources:
+              - module
+              - controller
+              - service
+            options:
+              - --no-spec
+```
+
+This recursive approach ensures that all parent and child modules are created with proper imports and dependencies.
 
 ---
 
 ## Features
 
-- Generate NestJS modules, controllers, services, gateways, middleware, and interceptors with single line command.
+- Load a full project from a YAML file.
+- Generate NestJS modules, controllers, services, gateways, middleware, and interceptors with a single-line command.
 - Support for optional flags like `--no-spec` and `--dry-run`.
 - Colorful and user-friendly output using `chalk`.
 - Easy-to-use command-line interface.
@@ -63,14 +100,20 @@ Run the CLI tool with the desired module name and options:
 nest-combo <module-name> [options]
 ```
 
-### Example:
+### Example Commands
 
-To create a module, controller and a service in a single line command:
+#### Create a Module, Controller, and Service in a Single Line
 
 ```bash
 nest-combo users -m -c -s
 ```
 
+#### Create a Full Project from a YAML File
+
+```bash
+nest-combo -f project.yml
+```
+
 ---
 
 ## Options
@@ -85,11 +128,72 @@ nest-combo users -m -c -s
 | `-itc, --interceptor` | Generate an interceptor                                        |
 | `-ns, --no-spec`      | Do not generate `.spec.ts` test files                          |
 | `-dr, --dry-run`      | Report actions that would be taken without writing out results |
+| `-f, --file`          | Create a project from a YAML file                              |
+
+---
+
+### YAML Example for Loading a Full Project from Scratch
+
+```yaml
+# YML example for loading a full project from scratch
+nest-combo:
+  project-name: my-new-project
+  open-vscode: true # Open VSCode when the process is finished
+  package-manager: npm # npm | yarn | pnpm
+  dependencies:
+    - "@nestjs/config"
+    - "@nestjs/bull"
+    - "class-transformer"
+    - "class-validator"
+    - "nestjs-twilio"
+  modules:
+    - name: core
+      resources:
+        - module
+      modules:
+        - name: user
+          resources:
+            - module
+            - controller
+            - service
+          options:
+            - --no-spec
+          modules:
+            - name: subUsers
+              resources:
+                - module
+                - controller
+                - service
+              options:
+                - --no-spec
+        - name: auth
+          resources:
+            - module
+            - controller
+            - service
+            - interceptor
+    - name: product
+      resources:
+        - module
+        - controller
+        - service
+    - name: payment
+      resources:
+        - module
+        - controller
+        - service
+```
 
 ---
 
 ## Examples
 
+### Create a Full Project from a YAML File
+
+```bash
+nest-combo -f project.yml
+```
+
 ### Generate a Module, Controller, and Service
 
 ```bash
@@ -99,13 +203,13 @@ nest-combo users -m -c -s
 ### Generate a Module and Service Without Spec Files
 
 ```bash
-nest-combo auth -m -s --no-spec
+nest-combo auth -m -s --ns
 ```
 
 ### Dry Run: Check What Would Be Generated
 
 ```bash
-nest-combo products -m -c --dry-run
+nest-combo products -m -c --dr
 ```
 
 ---

package/bin/cli.js

@@ -124,8 +124,6 @@ function getArgs() {
   const hasNoSpec = args.includes("-ns") || args.includes("--no-spec");
   const hasDryRun = args.includes("-dr") || args.includes("--dry-run");
   const hasYmlFile = args.includes("-f") || args.includes("--file");
-  const validateYmlFile =
-    args.includes("-vf") || args.includes("--validate-yml");
 
   return {
     moduleName,
@@ -149,8 +147,7 @@ ${chalk.yellow("Options:")}
   ${chalk.cyan("-g,   --gateway")}        Generate a Gateway
   ${chalk.cyan("-mw,  --middleware")}     Generate Middleware
   ${chalk.cyan("-itc, --interceptor")}    Generate an Interceptor
-  ${chalk.cyan("-f,   --file")}           Generate project from yml file
-  ${chalk.cyan("-vf,   --validate-yml")}  Validate Yml File
+  ${chalk.cyan("-f,   --file")}           Generate project from yml file  
 
 ${chalk.bgMagenta("Optional:")}
   ${chalk.cyan("-ns, --no-spec")}     Do not generate spec (test) files
@@ -212,7 +209,7 @@ function loadFromYml(file) {
     generateProject(projectName, [`-p ${packageManager}`]);
 
     if (dependencies.length > 0) {
-      console.log(chalk.blue("Installing dependencies..."));
+      console.log(chalk.cyan("Installing dependencies..."));
       installDependencies(projectName, dependencies);
     } else {
       console.log(chalk.yellow("No dependencies to install."));

package/index.html

@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Video Demo</title>
+    <style>
+      body {
+        font-family: Arial, sans-serif;
+        text-align: center;
+        margin-top: 50px;
+      }
+      video {
+        max-width: 100%;
+        height: auto;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>Video Demo</h1>
+    <video controls>
+      <source src="./demo.mp4" type="video/mp4" />
+      Your browser does not support the video tag.
+    </video>
+    <p>Watch the demo video above.</p>
+  </body>
+</html>

package/lib/install.js

@@ -1,3 +1,4 @@
+import chalk from "chalk";
 import { execSync } from "child_process";
 import path from "path";
 function installDependencies(projectName, dependencies) {
@@ -5,11 +6,16 @@ function installDependencies(projectName, dependencies) {
   const workingDirectory = path.join(process.cwd(), projectName);
 
   execSync(cdCommand, { stdio: "inherit" });
-  if (Array.isArray(dependencies)) {
-    const command = `npm i ${dependencies
-      .map((dependency) => dependency.name)
-      .join(" ")}`;
-    execSync(command, { stdio: "inherit", cwd: workingDirectory });
+  try {
+    if (Array.isArray(dependencies)) {
+      for (const depency of dependencies) {
+        chalk.cyan(`- ${depency}`);
+      }
+      const command = `npm i ${dependencies.join(" ")}`;
+      execSync(command, { stdio: "inherit", cwd: workingDirectory });
+    }
+  } catch (error) {
+    chalk.red(`Error installing dependencies`);
   }
 }
 

package/lib/utils.js

@@ -28,15 +28,6 @@ export function validateYml(ymlData) {
     if (nestCombo.dependencies && !Array.isArray(nestCombo.dependencies)) {
       throw new Error("Invalid 'dependencies'. Must be an array.");
     }
-    if (nestCombo.dependencies) {
-      nestCombo.dependencies.forEach((dep, index) => {
-        if (!dep.name || typeof dep.name !== "string") {
-          throw new Error(
-            `Invalid dependency at index ${index}. Each dependency must have a 'name' field as a string.`
-          );
-        }
-      });
-    }
 
     if (nestCombo.modules && !Array.isArray(nestCombo.modules)) {
       throw new Error("Invalid 'modules'. Must be an array.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nest-combo",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "main": "lib/generate.js",
   "description": "A CLI tool to generate NestJS modules, controllers, and services, etc with single line commands.",
   "type": "module",

package/project.example.yml

@@ -4,11 +4,11 @@ nest-combo:
   open-vscode: true # open vscode when process is finished
   package-manager: npm # npm | yarn | pnmp
   dependencies:
-    - name: "@nestjs/config"    
-    - name: "@nestjs/bull"
-    - name: "class-transformer"
-    - name: "class-validator"
-    - name: "nestjs-twilio"
+    - "@nestjs/config"    
+    - "@nestjs/bull"
+    - "class-transformer"
+    - "class-validator"
+    - "nestjs-twilio"
   modules:
     - name: core
       resources: