cleancode-e 1.0.1 → 1.1.0

package/README.md

@@ -14,7 +14,7 @@
 
 ## Apa itu cleancode-e?
 
-`cleancode-e` adalah CLI generator yang men-scaffold project backend [Fastify](https://fastify.dev) secara interaktif — lengkap dengan struktur folder siap produksi, pilihan database (MongoDB / MySQL / tanpa database), dan auto-install dependency.
+`cleancode-e` adalah CLI generator yang men-scaffold project backend [Fastify](https://fastify.dev) secara interaktif — lengkap dengan struktur folder siap produksi, pilihan database (MongoDB / MySQL / tanpa database), pilihan dokumentasi API (Swagger UI / Scalar), dan auto-install dependency.
 
 Terinspirasi dari Artisan (Laravel) dan Create-React-App, tapi untuk ekosistem **Node.js + Fastify**.
 
@@ -56,6 +56,10 @@ Ikuti prompt interaktifnya:
 ◇  Pakai nodemon untuk auto-reload saat development?
 │  ● Ya  ○ Tidak
 │
+◇  Pilih dokumentasi API:
+│  ● Swagger UI  (akses via /docs)
+│  ○ Scalar      (akses via /docs — tampilan modern)
+│
 └  folder berhasil dibuat, Selamat berkarya! masbro 🚀
 ```
 
@@ -78,7 +82,7 @@ my-api/
 │   └── readme.txt
 │
 ├── models/
-│   ├── example.userModel.js        # Skema User (Mongoose / Sequelize)
+│   ├── User.js / example.userModel.js  # Skema User (Mongoose / Sequelize)
 │   └── readme.txt
 │
 ├── config/
@@ -104,6 +108,8 @@ my-api/
 | MongoDB | + `mongoose` |
 | MySQL | + `sequelize`, `mysql2` |
 | Nodemon (jika Ya) | `nodemon` (devDependency) |
+| Swagger UI | + `@fastify/swagger`, `@fastify/swagger-ui` |
+| Scalar | + `@fastify/swagger`, `@scalar/fastify-api-reference` |
 
 ---
 
@@ -113,7 +119,7 @@ my-api/
 Langsung jalankan:
 ```bash
 cd my-api
-npm start
+npm run dev
 # → http://localhost:3000
 ```
 
@@ -128,7 +134,7 @@ cp .env.example .env
 # atau MongoDB Atlas:
 # MONGO_URI=mongodb+srv://user:pass@cluster.mongodb.net/my-api
 
-npm start
+npm run dev
 ```
 
 ### 3. MySQL
@@ -145,12 +151,25 @@ cp .env.example .env
 # DB_USER=root
 # DB_PASS=yourpassword
 
-npm start
+npm run dev
 # Sequelize akan auto-sync tabel saat pertama kali jalan
 ```
 
 ---
 
+## Dokumentasi API
+
+Setelah server berjalan, buka browser dan akses:
+
+| Pilihan | URL |
+|---|---|
+| Swagger UI | `http://localhost:3000/docs` |
+| Scalar | `http://localhost:3000/docs` |
+
+> Scalar menampilkan UI yang lebih modern & estetis dengan dark mode bawaan, cocok untuk project yang ingin tampilan API Reference premium.
+
+---
+
 ## Scripts
 
 | Command | Keterangan |

package/bin/index.js

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 import "../src/cli.js";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cleancode-e",
-    "version": "1.0.1",
+    "version": "1.1.0",
     "description": "CLI generator untuk project backend Fastify siap pakai",
     "keywords": ["fastify", "cli", "generator", "scaffold", "backend", "nodejs"],
     "type": "module",

package/src/cli.js

@@ -53,6 +53,19 @@ async function main() {
         process.exit(0);
     }
 
+    const dokumentasi = await select({
+        message: "pilih dokumentasi",
+        options: [
+            { value: "swagger", label: "Swagger" },
+            { value: "scaler", label: "scaler" },
+        ],
+    })
+
+    if (typeof dokumentasi === "symbol") {
+        outro(colors.red("Dibatalkan."));
+        process.exit(0);
+    }
+
     const targetDir = path.resolve(projectName);
     const templateDir = path.join(__dirname, "templates");
 
@@ -88,12 +101,72 @@ async function main() {
             cp("controllers/example.userController.mongo.js", "controllers/example.userController.js");
         } else if (database === "mysql") {
             cp("config/db.mysql.js", "config/db.js");
-            cp("models/example.userModel.mysql.js", "models/example.userModel.js");
+            cp("models/example.userModel.mysql.js", "models/User.js");
             cp("controllers/example.userController.mysql.js", "controllers/example.userController.js");
         } else {
             cp("controllers/example.userController.none.js", "controllers/example.userController.js");
         }
 
+        //ambil isi file app.js yang sudah di buat
+        const appJsPath = to("app.js");
+        let appJsContent = fs.readFileSync(appJsPath, "utf-8");
+
+        //--mempersiapkan Script DOKUMENTASI
+
+        let docsScript = "";
+
+        if (dokumentasi === "swagger") {
+            docsScript = `
+            //--DOKUMENTASI SWAGGER--
+            fastify.register(import("@fastify/swagger"), {
+                openapi: {
+                    info: {
+                        title: "${projectName}",  // <-- Jangan lupa pakai tanda kutip untuk string!
+                        description: "API Documentation",
+                        version: "1.0.0",
+                    },
+                    servers: [
+                        {
+                            url: "http://localhost:3000",
+                            description: "Development",
+                        },
+                    ],
+                },
+            });
+            fastify.register(import("@fastify/swagger-ui"), {
+                routePrefix: "/docs",
+            });
+            `
+        } else if (dokumentasi === "scaler") {
+            docsScript = `
+            //--DOKUMENTASI SCALER--
+            fastify.register(import("@fastify/swagger"), {
+                openapi: {
+                    info: {
+                        title: "${projectName}",
+                        description: "API Documentation",
+                        version: "1.0.0",
+                    },
+                    servers: [
+                        {
+                            url: "http://localhost:3000",
+                            description: "Development",
+                        },
+                    ],
+                },
+            });
+            fastify.register(import("@scalar/fastify-api-reference"), {
+                routePrefix: "/docs",
+            });
+            `
+        }
+
+
+        //--ganti penanda {{DOCS_SETUP}}
+        appJsContent = appJsContent.replace("{{DOCS_SETUP}}", docsScript);
+
+        fs.writeFileSync(appJsPath, appJsContent);
+
         const deps = { fastify: "latest" };
         if (database === "mongo") deps.mongoose = "latest";
         if (database === "mysql") {
@@ -124,6 +197,8 @@ async function main() {
         const installList = ["fastify"];
         if (database === "mongo") installList.push("mongoose");
         if (database === "mysql") installList.push("sequelize", "mysql2");
+        if (dokumentasi === "swagger") installList.push("@fastify/swagger", "@fastify/swagger-ui");
+        if (dokumentasi === "scaler") installList.push("@fastify/swagger", "@scalar/fastify-api-reference");
 
         await execa("npm", ["install", ...installList], { cwd: targetDir });
 
@@ -145,6 +220,7 @@ async function main() {
                     : "",
             ].filter(Boolean).join("\n"),
             "Selesai!"
+
         );
 
         outro(colors.green("folder berhasil dibuat, Selamat berkarya! masbro 🚀"));

package/src/templates/app.mongo.js

@@ -5,6 +5,8 @@ import userRoutes from './routes/example.userRoute.js';
 const fastify = Fastify({ logger: true });
 
 fastify.register(userRoutes);
+// ====== DOKUMENTASI API ======
+// {{DOCS_SETUP}}
 
 const start = async () => {
     try {

package/src/templates/app.mysql.js

@@ -6,6 +6,8 @@ import './models/User.js';
 const fastify = Fastify({ logger: true });
 
 fastify.register(userRoutes);
+// ====== DOKUMENTASI API ======
+// {{DOCS_SETUP}}
 
 const start = async () => {
     try {

package/src/templates/app.none.js

@@ -4,6 +4,8 @@ import userRoutes from './routes/example.userRoute.js';
 const fastify = Fastify({ logger: true });
 
 fastify.register(userRoutes);
+// ====== DOKUMENTASI API ======
+// {{DOCS_SETUP}}
 
 const start = async () => {
     try {

package/src/templates/controllers/example.userController.mysql.js

@@ -1,4 +1,4 @@
-import User from '../models/example.userModel.js';
+import User from '../models/User.js';
 
 export async function getUsers(request, reply) {
     const users = await User.findAll();