@saulpaulus17/node-module-generator 2.0.5 → 2.0.8

package/.github/workflows/release.yml

@@ -5,10 +5,18 @@ on:
     tags:
       - 'v*.*.*'
 
+# Prevent multiple simultaneous releases
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
   publish:
     runs-on: ubuntu-latest
-
+    permissions:
+      contents: read
+      id-token: write # Required for NPM provenance
+    
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -19,13 +27,13 @@ jobs:
           node-version: 20
           registry-url: 'https://registry.npmjs.org'
 
-      - name: Install deps
-        run: npm install
+      - name: Install dependencies
+        run: npm ci
 
-      - name: Run test
+      - name: Run tests
         run: npm test
 
       - name: Publish to npm
-        run: npm publish --access public
+        run: npm publish --access public --provenance
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="https://raw.githubusercontent.com/saul-paulus/node-module-generator/main/assets/banner.png" alt="Node Module Generator Banner" width="600" style="max-width: 100%;" />
+  <img src="./assets/banner.png" alt="Node Module Generator Banner" width="600" style="max-width: 100%;" />
   <h1>🚀 Node Module Generator (NMG)</h1>
   <p><strong>The ultimate CLI companion for rapid, enterprise-grade Node.js scaffolding.</strong></p>
   <p>
@@ -76,6 +76,25 @@ npx @saulpaulus17/node-module-generator <command> <name>
 
 ---
 
+## 🛠️ Target Project Dependencies
+
+To ensure the modules generated by NMG function correctly, your main project must have the following core dependencies installed:
+
+### Production Dependencies
+```bash
+npm install express awilix @prisma/client
+```
+
+### Development Dependencies
+```bash
+npm install --save-dev jest
+```
+
+> [!TIP]
+> These dependencies are essential because the generated code relies on Express for routing, Awilix for Dependency Injection, and Prisma for the data layer.
+
+---
+
 ## 🚀 Detailed Usage
 
 ### 1. Generating a Full Module

package/generator/module.generator.js

@@ -19,8 +19,6 @@ module.exports = async function (name) {
   // Create directories
   dirs.forEach((dir) => fs.ensureDirSync(path.join(basePath, dir)));
 
-  // Generate scoped package.json for ESM support
-  fs.writeJsonSync(path.join(basePath, "package.json"), { type: "module" }, { spaces: 2 });
 
   const templateData = {
     name,

package/generator/resource.generator.js

@@ -18,8 +18,6 @@ module.exports = async function (name) {
 
   dirs.forEach((dir) => fs.ensureDirSync(path.join(basePath, dir)));
 
-  // Generate scoped package.json for ESM support
-  fs.writeJsonSync(path.join(basePath, "package.json"), { type: "module" }, { spaces: 2 });
 
   const templateData = {
     name,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saulpaulus17/node-module-generator",
-  "version": "2.0.5",
+  "version": "2.0.8",
   "description": "CLI tool to grenerate modular scaffolding for nodejs projects following clean arsitecture principles. ",
   "keywords": [
     "nodejs",
@@ -11,6 +11,14 @@
   "license": "MIT",
   "author": "saul-paulus (ixspx)",
   "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/saul-paulus/node-module-generator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/saul-paulus/node-module-generator/issues"
+  },
+  "homepage": "https://github.com/saul-paulus/node-module-generator#readme",
   "main": "index.js",
   "bin": {
     "nmg": "./bin/cli.js"