nest-combo 1.2.0 → 1.2.2

package/.prettierignore

@@ -0,0 +1,5 @@
+node_modules/
+dist/
+coverage/
+
+test-project/

package/README.MD

@@ -1,8 +1,8 @@
 # NestJS Combo CLI
 
-![npm](https://img.shields.io/npm/v/nest-combo) ![npm](https://img.shields.io/npm/dt/nest-combo)
+![npm](https://img.shields.io/npm/v/nest-combo) ![npm](https://img.shields.io/npm/dt/nest-combo) [![CI](https://github.com/vinisalves/nest-combo/actions/workflows/ci.yml/badge.svg)](https://github.com/vinisalves/nest-combo/actions/workflows/ci.yml)
 
-A CLI tool to generate NestJS modules, controllers, services, and other components in a single line command.
+A CLI tool to generate NestJS Projects, modules, controllers, services, and other components in a single line command.
 
 ---
 
@@ -29,46 +29,10 @@ If the NestJS CLI is not installed globally, don't worry! **nest-combo** comes b
 
 ---
 
-### 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
 
 - Load a full project from a YAML file.
+- Create a new project and automatically open VsCode
 - 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`.
@@ -97,15 +61,21 @@ nest-combo --version
 Run the CLI tool with the desired module name and options:
 
 ```bash
-nest-combo <module-name> [options]
+nest-combo <<project|module>-name> [options]
 ```
 
 ### Example Commands
 
-#### Create a Module, Controller, and Service in a Single Line
+#### Create a project
 
 ```bash
-nest-combo users -m -c -s
+nest-combo my-amazing-project -new # "VSCode will open by default once it's done. If you don't want it just add -no-vscode"
+```
+
+#### Create a Module, Controller, Service, Intercepetor, Gateway and Middleware in a Single Line Command
+
+```bash
+nest-combo users -m -c -s -itc -g -mw # if you don't want spcec files, just add -ns or --no-spec
 ```
 
 #### Create a Full Project from a YAML File
@@ -141,11 +111,11 @@ nest-combo:
   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"
+    - '@nestjs/config'
+    - '@nestjs/bull'
+    - 'class-transformer'
+    - 'class-validator'
+    - 'nestjs-twilio'
   modules:
     - name: core
       resources:
@@ -186,34 +156,6 @@ nest-combo:
 
 ---
 
-## Examples
-
-### Create a Full Project from a YAML File
-
-```bash
-nest-combo -f project.yml
-```
-
-### Generate a Module, Controller, and Service
-
-```bash
-nest-combo users -m -c -s
-```
-
-### Generate a Module and Service Without Spec Files
-
-```bash
-nest-combo auth -m -s --ns
-```
-
-### Dry Run: Check What Would Be Generated
-
-```bash
-nest-combo products -m -c --dr
-```
-
----
-
 ## Contributing
 
 We welcome contributions! Here’s how you can help:

package/bin/cli.js

@@ -1,218 +1,166 @@
 #!/usr/bin/env node
-import { execSync } from "child_process";
-import fs from "fs";
-import path from "path";
-import chalk from "chalk";
-import yaml from "js-yaml";
-import {
-  generateModule,
-  generateController,
-  generateService,
-  generateInterceptor,
-  generateGateway,
-  generateMiddlware,
-  generateProject,
-} from "../lib/generate.js";
-import { installDependencies } from "../lib/install.js";
-import { createRequire } from "module";
-import { validateYml } from "../lib/utils.js";
-const require = createRequire(import.meta.url);
-const { name, version } = require("../package.json");
-
+import { execSync } from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import yaml from 'js-yaml';
+import { generateProject } from '../lib/generate.js';
+import resources from '../lib/resources.js';
+import installDependencies from '../lib/installDependencies.js';
+import { validateResources, validateYml } from '../lib/utils.js';
+import { printBanner, showUsage, showVersion } from '../lib/outputs.js';
 const args = process.argv.slice(2);
-const resources = [
-  {
-    name: "module",
-    flag: "-m",
-    longFlag: "--module",
-    generator: generateModule,
-  },
-  {
-    name: "controller",
-    flag: "-c",
-    longFlag: "--controller",
-    generator: generateController,
-  },
-  {
-    name: "service",
-    flag: "-s",
-    longFlag: "--service",
-    generator: generateService,
-  },
-  {
-    name: "gateway",
-    flag: "-g",
-    longFlag: "--gateway",
-    generator: generateGateway,
-  },
-  {
-    name: "middleware",
-    flag: "-mw",
-    longFlag: "--middleware",
-    generator: generateMiddlware,
-  },
-  {
-    name: "interceptor",
-    flag: "-itc",
-    longFlag: "--interceptor",
-    generator: generateInterceptor,
-  },
-];
 
-function main() {
+export function main() {
   printBanner();
-  const {
-    askForHelp,
-    askForVersion,
-    moduleName,
-    hasDryRun,
-    hasNoSpec,
-    hasYmlFile,
-  } = getArgs();
+  const readArgs = getArgs();
 
-  switch (true) {
-    case askForVersion:
-      showVersion();
-      process.exit(0);
-      break;
+  if (readArgs.askForVersion) {
+    showVersion();
+    return;
+  }
 
-    case askForHelp:
-      showUsage();
-      process.exit(0);
-      break;
+  if (readArgs.askForHelp) {
+    showUsage();
+    return;
+  }
 
-    case hasYmlFile:
-      const file = args[1];
-      loadFromYml(file);
-      process.exit(0);
-      break;
+  if (readArgs.hasCreateNewProject) {
+    const packageManager = readArgs.hasPackageManager ? args[3] : undefined;
+    createNewProject(
+      readArgs.resourceName,
+      packageManager,
+      readArgs.doNotOpenVsCode,
+    );
+    return;
+  }
 
-    default:
-      execute(moduleName, hasNoSpec, hasDryRun);
+  if (readArgs.hasYmlFile) {
+    const file = args[1];
+    createFullProjectFromYmlFile(file);
+    return;
   }
-}
 
-function execute(moduleName, hasNoSpec, hasDryRun) {
-  validate(moduleName);
-  resources.forEach((component) => {
-    if (args.includes(component.flag) || args.includes(component.longFlag)) {
-      console.log(
-        chalk.green(`Generating ${component.name} for module ${moduleName}`)
-      );
-      if (component.generator) {
-        component.generator(moduleName, [
-          hasNoSpec ? "--no-spec" : null,
-          hasDryRun ? "--dry-run" : null,
-        ]);
-      } else {
-        console.warn(
-          chalk.yellow(`Warning:`) +
-            ` Generator not implemented for ${component.name}`
-        );
-      }
-      console.log(
-        chalk.green("---------------------------------------------------")
-      );
-    }
-  });
+  createResources(
+    readArgs.resourceName,
+    readArgs.hasNoSpec,
+    readArgs.hasDryRun,
+  );
 }
 
+/** 
+ * Return arguments from the user input command
+ * @returns {object} { resourceName,
+    askForVersion,
+    askForHelp,
+    hasNoSpec,
+    hasDryRun,
+    hasYmlFile,
+    hasCreateNewProject,
+    hasPackageManager
+    }
+ */
 function getArgs() {
-  const moduleName = args[0];
-  const askForVersion = args.includes("-v") || args.includes("--version");
-  const askForHelp = args.includes("-h") || args.includes("--help");
-  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 resourceName = args[0];
+  const askForVersion = args.includes('-v') || args.includes('--version');
+  const askForHelp = args.includes('-h') || args.includes('--help');
+  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 hasCreateNewProject =
+    args.includes('-new') || args.includes('--new-project');
+  const hasPackageManager =
+    args.includes('-p') || args.includes('--package-manager');
+  const doNotOpenVsCode = args.includes('-no-vscode');
 
   return {
-    moduleName,
+    resourceName,
     askForVersion,
     askForHelp,
     hasNoSpec,
     hasDryRun,
     hasYmlFile,
-    validateYmlFile,
+    hasCreateNewProject,
+    hasPackageManager,
+    doNotOpenVsCode,
   };
 }
 
-function showUsage() {
-  console.log(`
-${chalk.yellow("Usage:")} nest-combo <module-name> [options]
-
-${chalk.yellow("Options:")}
-  ${chalk.cyan("-m,   --module")}         Generate a Module
-  ${chalk.cyan("-c,   --controller")}     Generate a Controller
-  ${chalk.cyan("-s,   --service")}        Generate a Service
-  ${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.bgMagenta("Optional:")}
-  ${chalk.cyan("-ns, --no-spec")}     Do not generate spec (test) files
-  ${chalk.cyan(
-    "-dr, --dry-run"
-  )}     Report actions that would be taken without writing out results.
-
-${chalk.yellow("Example:")}
-  nest-combo users -m -c -s
-  nest-combo -f project.yml
-`);
-}
-
-function showVersion() {
-  console.log(chalk.green(`${name} - version: ${version}`));
-}
-
-function validate(moduleName) {
-  if (!moduleName) {
-    console.error(chalk.red("Error:") + " Module name is required.");
-    showUsage();
-    process.exit(1);
-  }
-  const hasComponentFlags = resources.some(
-    (component) =>
-      args.includes(component.flag) || args.includes(component.longFlag)
-  );
-
-  if (!hasComponentFlags) {
-    console.error(
-      chalk.red("Error:") +
-        ` At least one flag (${resources
-          .map((resource) => resource.flag)
-          .join(",")}) is required.`
-    );
-    showUsage();
+/**
+ * Genrate resources like Modules, Controller, Services, etc
+ * @param {string} resourceName - Module/Controller/Service/etc name
+ * @param {boolean} hasNoSpec  - if true do not generate spec files
+ * @param {boolean} hasDryRun  - if true dry run mode
+ * @throws {Error} Throws an error if something goes wrong
+ */
+function createResources(resourceName, hasNoSpec, hasDryRun) {
+  try {
+    validateResources(resourceName, args);
+    resources.forEach((component) => {
+      if (args.includes(component.flag) || args.includes(component.longFlag)) {
+        console.log(
+          chalk.green(`Generating ${component.name} for ${resourceName}`),
+        );
+        if (component.generator) {
+          component.generator(resourceName, [
+            hasNoSpec ? '--no-spec' : null,
+            hasDryRun ? '--dry-run' : null,
+          ]);
+        } else {
+          console.warn(
+            chalk.yellow(`Warning:`) +
+              ` Generator not implemented for ${component.name}`,
+          );
+        }
+        console.log(
+          chalk.green('---------------------------------------------------'),
+        );
+      }
+    });
+  } catch (error) {
+    console.error(chalk.red(`Error creating resources: ${error.message}`));
     process.exit(1);
   }
 }
 
-function loadFromYml(file) {
+/**
+ * Creates a full NestJS project based on the configuration provided in a YAML file.
+ *
+ * This function performs the following steps:
+ * 1. Parses the YAML file to extract project configuration (e.g., project name, dependencies, modules, etc.).
+ * 2. Generates the base NestJS project structure using the `nest-cli`.
+ * 3. Installs the specified project dependencies.
+ * 4. Recursively creates nested modules, controllers, services, and other resources as defined in the YAML file.
+ * 5. Opens the generated project in Visual Studio Code once it's done.
+ *
+ * @param {string} filePath - The absolute or relative path to the YAML configuration file.
+ * @throws {Error} Throws an error if the YAML file is invalid, missing required fields, or if any step fails during execution.
+ */
+function createFullProjectFromYmlFile(filePath) {
   try {
-    const fileContent = fs.readFileSync(file, "utf-8");
+    const fileContent = fs.readFileSync(filePath, 'utf-8');
     const ymlData = yaml.load(fileContent);
 
     validateYml(ymlData);
 
-    const content = ymlData["nest-combo"];
-    const projectName = content["project-name"];
-    const packageManager = content["package-manager"] || "npm";
-    const dependencies = Array.isArray(content["dependencies"])
-      ? content["dependencies"]
+    const content = ymlData['nest-combo'];
+    const projectName = content['project-name'];
+    const packageManager = content['package-manager'] || 'npm';
+    const dependencies = Array.isArray(content['dependencies'])
+      ? content['dependencies']
       : [];
-    const modules = Array.isArray(content["modules"]) ? content["modules"] : [];
+    const modules = Array.isArray(content['modules']) ? content['modules'] : [];
 
-    const openVsCode = content["open-vscode"];
+    const openVsCode = content['open-vscode'];
 
     console.log(chalk.green(`Generating project: ${projectName}`));
     generateProject(projectName, [`-p ${packageManager}`]);
 
     if (dependencies.length > 0) {
-      console.log(chalk.cyan("Installing dependencies..."));
+      console.log(chalk.cyan('Installing dependencies...'));
       installDependencies(projectName, dependencies);
     } else {
-      console.log(chalk.yellow("No dependencies to install."));
+      console.log(chalk.yellow('No dependencies to install.'));
     }
 
     const recursiveAddModule = (parentModule, modules) => {
@@ -231,8 +179,8 @@ function loadFromYml(file) {
         if (!Array.isArray(moduleResources)) {
           console.warn(
             chalk.yellow(
-              `Invalid resources for module: ${pathModule}. Skipping.`
-            )
+              `Invalid resources for module: ${pathModule}. Skipping.`,
+            ),
           );
           continue;
         }
@@ -242,17 +190,17 @@ function loadFromYml(file) {
 
           if (!resource) {
             console.warn(
-              chalk.yellow(`Unknown resource type: ${resourceName}. Skipping.`)
+              chalk.yellow(`Unknown resource type: ${resourceName}. Skipping.`),
             );
             return;
           }
 
           console.log(
-            chalk.magenta(`Generating ${resourceName} for ${pathModule}`)
+            chalk.magenta(`Generating ${resourceName} for ${pathModule}`),
           );
           resource.generator(pathModule, options, projectName);
           console.log(
-            chalk.green("---------------------------------------------------")
+            chalk.green('---------------------------------------------------'),
           );
         });
 
@@ -265,15 +213,13 @@ function loadFromYml(file) {
     recursiveAddModule(null, modules);
 
     if (openVsCode) {
-      const workingDirectory = path.join(process.cwd(), projectName);
-      const command = "code .";
-      execSync(command, { cwd: workingDirectory });
+      CmdOpenVsCode(projectName);
     }
 
     console.log(
       chalk.green(
-        "**************** succefully finished ************************** "
-      )
+        '**************** succefully finished ************************** ',
+      ),
     );
     showVersion();
   } catch (error) {
@@ -282,24 +228,33 @@ function loadFromYml(file) {
   }
 }
 
-function printBanner() {
-  console.log(
-    chalk.magenta(`      
-███╗   ██╗███████╗███████╗████████╗       ██████╗ ██████╗ ███╗   ███╗██████╗  ██████╗ 
-████╗  ██║██╔════╝██╔════╝╚══██╔══╝      ██╔════╝██╔═══██╗████╗ ████║██╔══██╗██╔═══██╗
-██╔██╗ ██║█████╗  ███████╗   ██║   █████╗██║     ██║   ██║██╔████╔██║██████╔╝██║   ██║
-██║╚██╗██║██╔══╝  ╚════██║   ██║   ╚════╝██║     ██║   ██║██║╚██╔╝██║██╔══██╗██║   ██║
-██║ ╚████║███████╗███████║   ██║         ╚██████╗╚██████╔╝██║ ╚═╝ ██║██████╔╝╚██████╔╝
-╚═╝  ╚═══╝╚══════╝╚══════╝   ╚═╝          ╚═════╝ ╚═════╝ ╚═╝     ╚═╝╚═════╝  ╚═════╝         
-    `)
-  );
-  console.log(
-    chalk.bgWhite(
-      chalk.bold(
-        `********************************************************************** version: ${version} `
-      )
-    )
-  );
+/**
+ * Creates a NestJS project and Open the generated project in Visual Studio Code once it's done
+ *
+ * @param {string} projectName - The projectName for the new project.
+ * @param {string} packageManagere - The packageManeger such npm, yarn or pnpm, by default it uses npm
+ * @throws {Error} Throws an error if something goes wrong.
+ *
+ */
+function createNewProject(
+  projectName,
+  packageManager = 'npm',
+  doNotOpenVsCode = false,
+) {
+  try {
+    generateProject(projectName, [`-p ${packageManager}`]);
+    if (doNotOpenVsCode) return;
+    CmdOpenVsCode(projectName);
+  } catch (error) {
+    console.error(chalk.red(`Error: ${error.message}`));
+    process.exit(1);
+  }
+}
+
+function CmdOpenVsCode(directory) {
+  const workingDirectory = path.join(process.cwd(), directory);
+  const command = 'code .';
+  execSync(command, { cwd: workingDirectory });
 }
 
 main();

package/index.html

@@ -1,4 +1,4 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />