nest-combo 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ViniBr
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.MD

@@ -0,0 +1,160 @@
+# NestJS Combo CLI
+
+![npm](https://img.shields.io/npm/v/nest-combo) ![npm](https://img.shields.io/npm/dt/nest-combo)
+
+A CLI tool to generate NestJS modules, controllers, services, and other components in a single line command.
+
+---
+
+## Table of Contents
+
+- [How it works](#how-it-works)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Options](#options)
+- [Examples](#examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## How it works {#howitworks}
+
+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 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.
+
+---
+
+## Features
+
+- Generate NestJS modules, controllers, services, gateways, middleware, and interceptors with 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.
+
+---
+
+## Installation
+
+Install the package globally using npm:
+
+```bash
+npm install -g nest-combo
+```
+
+Verify the installation by checking the version:
+
+```bash
+nest-combo --version
+```
+
+---
+
+## Usage
+
+Run the CLI tool with the desired module name and options:
+
+```bash
+nest-combo <module-name> [options]
+```
+
+### Example:
+
+To create a module, controller and a service in a single line command:
+
+```bash
+nest-combo users -m -c -s
+```
+
+---
+
+## Options
+
+| Flag                  | Description                                                    |
+| --------------------- | -------------------------------------------------------------- |
+| `-m, --module`        | Generate a module                                              |
+| `-c, --controller`    | Generate a controller                                          |
+| `-s, --service`       | Generate a service                                             |
+| `-g, --gateway`       | Generate a gateway                                             |
+| `-mw, --middleware`   | Generate middleware                                            |
+| `-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 |
+
+---
+
+## Examples
+
+### 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 --no-spec
+```
+
+### Dry Run: Check What Would Be Generated
+
+```bash
+nest-combo products -m -c --dry-run
+```
+
+---
+
+## Contributing
+
+We welcome contributions! Here’s how you can help:
+
+1. **Fork the repository** and clone it locally.
+2. Create a new branch for your feature or bug fix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+3. Make your changes and ensure everything works as expected.
+4. Commit your changes with a clear message:
+   ```bash
+   git commit -m "Add feature: description of your changes"
+   ```
+5. Push your branch to GitHub:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+6. Open a pull request on GitHub.
+
+### Development Setup
+
+1. Install dependencies:
+   ```bash
+   npm install
+   ```
+2. Test your changes locally:
+   ```bash
+   npm link
+   nest-combo users -m -c -s
+   ```
+
+---
+
+## License
+
+This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
+
+---
+
+## Acknowledgments
+
+- Built with ❤️ using [NestJS](https://nestjs.com/) and [Chalk](https://github.com/chalk/chalk).
+- Inspired by the need for a faster and more efficient way to scaffold NestJS projects.
+
+---
+
+Feel free to customize this `README.md` further to match your project's specific details or add additional sections (e.g., FAQs, roadmap). Let me know if you need any modifications! 🚀

package/bin/cli.js

@@ -0,0 +1,159 @@
+#!/usr/bin/env node
+import chalk from "chalk";
+import {
+  generateModule,
+  generateController,
+  generateService,
+  generateInterceptor,
+  generateGateway,
+  generateMiddlware,
+} from "../lib/generate.js";
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+
+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() {
+  const { askForHelp, askForVersion, moduleName, hasDryRun, hasNoSpec } =
+    getArgs();
+
+  if (askForVersion) {
+    showVersion();
+    process.exit(0);
+  }
+  if (askForHelp) {
+    showUsage();
+    process.exit(0);
+  }
+
+  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("---------------------------------------------------")
+      );
+    }
+  });
+}
+
+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");
+
+  return {
+    moduleName,
+    askForVersion,
+    askForHelp,
+    hasNoSpec,
+    hasDryRun,
+  };
+}
+
+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.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
+`);
+}
+
+function showVersion() {
+  const { name, version } = require("../package.json");
+  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();
+    process.exit(1);
+  }
+}
+
+main();

package/lib/generate.js

@@ -0,0 +1,54 @@
+import { execSync } from "child_process";
+import { fileURLToPath } from "url";
+import path from "path";
+import chalk from "chalk";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const getNestBinary = () => {
+  try {
+    execSync("nest --version", { stdio: "ignore" });
+    console.log(
+      chalk.bgMagenta("*** Using global Nest CLI Installation *** \n")
+    );
+    return "nest";
+  } catch (error) {
+    console.log(
+      chalk.bgBlueBright("*** Using local Nest CLI Installation *** \n")
+    );
+    return path.join(__dirname, "../node_modules/.bin/nest");
+  }
+};
+
+/**
+ * Generates a NestJS component (module, controller, service, etc.).
+ * @param {string} type - The type of component to generate (e.g., "mo", "co", "s").
+ * @param {string} moduleName - The name of the module to generate.
+ * @param {Object} options - Additional options for the command.
+ */
+const generateComponent = (type, moduleName, options) => {
+  const command = `${nest} g ${type} ${moduleName} ${options.join(" ")}`;
+  // console.log(`Running command: ${command}`);
+  execSync(command, { stdio: "inherit" });
+};
+
+export const generateModule = (moduleName, options) =>
+  generateComponent("mo", moduleName, options);
+
+export const generateController = (moduleName, options) =>
+  generateComponent("co", moduleName, options);
+
+export const generateService = (moduleName, options) =>
+  generateComponent("s", moduleName, options);
+
+export const generateGateway = (moduleName, options) =>
+  generateComponent("ga", moduleName, options);
+
+export const generateInterceptor = (moduleName, options) =>
+  generateComponent("itc", moduleName, options);
+
+export const generateMiddlware = (moduleName, options) =>
+  generateComponent("mi", moduleName, options);
+
+const nest = getNestBinary();

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "nest-combo",
+  "version": "1.0.0",
+  "main": "lib/generate.js",
+  "description": "A CLI tool to generate NestJS modules, controllers, and services, etc in horizontal.",
+  "type": "module",
+  "bin": {
+    "nest-combo": "bin/cli.js"
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "nestjs",
+    "cli",
+    "generator",
+    "module",
+    "controller",
+    "service"
+  ],
+  "author": "ViniBr",
+  "license": "MIT",
+  "dependencies": {
+    "@nestjs/cli": "^11.0.5",
+    "chalk": "^5.4.1"
+  }
+}