express-module-cli 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mohammad Ashiqur Rahman
+
+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,91 @@
+# express-module-cli
+
+A CLI tool to generate modules for TypeScript-based Express applications.
+
+## Features
+
+- Quickly generate controllers, services, routes, models, and interfaces.
+- Designed for TypeScript-based Express apps.
+- Flexible commands with aliases for convenience.
+
+## Installation
+
+### 1. Using npm
+
+Install the package globally for easy usage:
+
+```bash
+npm install -g express-module-cli
+```
+
+### 2. As a Development Dependency
+
+Install it as a dev dependency in your project:
+
+```bash
+npm install --save-dev create-module-cli
+```
+
+## Usage
+
+### 1. Global Usage
+
+Run the CLI tool with the create command:
+
+```bash
+create module <module-name>
+```
+
+For example:
+
+```bash
+create module user
+```
+
+or,
+
+```bash
+create m user
+```
+
+### 2. Using npx
+
+Without installation:
+
+```bash
+npx express-module-cli module <module-name>
+```
+
+For example:
+
+```bash
+npx express-module-cli module user
+```
+
+or,
+
+```bash
+npx express-module-cli m user
+```
+
+## Example Output
+
+```bash
+npx create-module-cli module user
+```
+
+The following files will be created in src/modules/user:
+
+      - user.controller.ts
+      - user.service.ts
+      - user.route.ts
+      - user.model.ts
+      - user.interface.ts
+
+## Prerequisites
+
+This CLI tool is designed specifically for **TypeScript-based Express applications**. Ensure your project meets the following requirements:
+
+- TypeScript installed (`npm install typescript --save-dev`)
+- `tsconfig.json` configured in your project root
+- Express.js installed (`npm install express`)

package/dist/index.js

@@ -9,7 +9,7 @@ const capitalize = (name) => name.charAt(0).toUpperCase() + name.slice(1);
 // Main CLI logic
 yargs(hideBin(process.argv))
     .scriptName("create") // Allows using "npx create" or "create" if globally installed
-    .command("module <module>", "Create a new module", (yargs) => {
+    .command(["module <module>", "m <module>"], "Create a new module", (yargs) => {
     return yargs.positional("module", {
         describe: "The name of the module",
         type: "string",

package/package.json

@@ -1,6 +1,20 @@
 {
   "name": "express-module-cli",
-  "version": "1.0.0",
+  "version": "1.0.1",
+  "license": "MIT",
+  "keywords": [
+    "CLI",
+    "TypeScript",
+    "Express",
+    "Module Generator"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "peerDependencies": {
+    "typescript": "^4.0.0"
+  },
+  "author": "Mohammad Ashiqur Rahman",
   "description": "A CLI tool to create modules for TypeScript-based Express apps",
   "bin": {
     "create": "./dist/index.js"

package/src/index.ts

@@ -14,7 +14,7 @@ const capitalize = (name: string): string =>
 yargs(hideBin(process.argv))
   .scriptName("create") // Allows using "npx create" or "create" if globally installed
   .command(
-    "module <module>",
+    ["module <module>", "m <module>"],
     "Create a new module",
     (yargs) => {
       return yargs.positional("module", {