create-craftjs 1.0.0

package/README.md

@@ -0,0 +1,137 @@
+# CraftJS
+
+A starter kit backend framework powered by Express, TypeScript, EJS Engine, and Prisma — designed for rapid development, simplicity, and scalability.
+
+---
+
+## Features
+
+- **Express.js** based API architecture
+- **TypeScript** support out of the box
+- **Prisma ORM** with scalable database structure
+- **CLI tool** (`craft`) for project automation
+- Built-in **Logger**, **Validation**, **Error handler**, and **Request lifecycle**
+- Predefined project structure for fast onboarding
+
+---
+
+💡 Note: EJS View Engine is included but disabled by default. To enable it:
+Open src/application/web.ts and uncomment the following lines:
+
+```bash
+import expressLayouts from "express-ejs-layouts";
+import path from "path";
+
+web.set("view engine", "ejs");
+web.set("views", path.join(\_\_dirname, "..", "views"));
+web.use(expressLayouts);
+web.set("layout", "layouts/main");
+```
+
+Then, go to src/routes/main-route.ts and uncomment this:
+
+```bash
+mainRouter.get("/", (req, res) => {
+res.render("index", { title: "Home Page" });
+});
+```
+
+## Getting Started
+
+### Scaffold a New Project
+
+```bash
+npx create-craftjs  my-app
+```
+
+OR
+
+```bash
+npm init craftjs my-app
+```
+
+### Go to project folder
+
+```bash
+cd my-app
+```
+
+### Run Craft Setup
+
+```bash
+npm install
+node craft key:generate
+node craft generate
+node craft db:migrate
+node craft dev
+```
+
+### Available Craft Commands
+
+```bash
+node craft help
+```
+
+---
+
+## Project Structure
+
+```
+my-app/
+├── craft/
+├── src/
+│   ├── apidocs/
+│   ├── config/
+│   ├── controllers/
+│   ├── middleware/
+│   ├── repositories/
+│   ├── dtos/
+│   ├── routes/
+│   └── services/
+│   └── types/
+│   └── utils/
+│   └── validations/
+│   └── main.ts
+├── test/
+├── logs/
+├── .env
+├── .env.example
+├── prisma/
+├── .gitignore
+├── babel.config.json
+├── craft.js
+├── nodemon.json
+├── package.json
+├── package-lock.json
+└── tsconfig.json
+```
+
+---
+
+## Scripts
+
+| Command                 | Description                    |
+| ----------------------- | ------------------------------ |
+| `craft start`           | Start production server        |
+| `craft dev`             | Run in development mode        |
+| `craft build`           | Build for production           |
+| `craft test`            | Run Jest tests                 |
+| `craft db:generate`     | Generate Prisma client         |
+| `craft db:migrate`      | Run Prisma migrations          |
+| `craft db:reset`        | Run Prisma migrations refresh  |
+| `craft key:generate`    | Generate secret keys           |
+| `craft make:controller` | Make Controller File           |
+| `craft make:command`    | Make Command File              |
+| `craft make:middleware` | Make Middleware File           |
+| `craft make:repository` | Make repository File           |
+| `craft make:dto`        | Make Data Transfer Object File |
+| `craft make:route`      | Make Route File                |
+| `craft make:service`    | Make Service File              |
+| `craft make:test`       | Make Test case                 |
+| `craft make:utils`      | Make Utils                     |
+| `craft make:validation` | Make Validation                |
+| `craft make:view`       | Make View                      |
+
+---
+
+Made by [@muhammadisa-n](https://github.com/muhammadisa-n)

package/bin/index.js

@@ -0,0 +1,158 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const path = require("path");
+const { spawnSync } = require("child_process");
+const readline = require("readline");
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout,
+});
+
+const ask = (question) => {
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => resolve(answer.trim()));
+  });
+};
+
+(async () => {
+  console.log("🚀 Welcome to CraftJS Project Creator!");
+
+  let projectName = process.argv[2];
+
+  if (!projectName) {
+    projectName = await ask("📦 Enter your project name: ");
+    while (!projectName || !/^[a-zA-Z0-9-_]+$/.test(projectName)) {
+      console.log(
+        "❌ Invalid project name. Use only letters, numbers, - and _."
+      );
+      projectName = await ask("📦 Enter your project name: ");
+    }
+  } else {
+    if (!/^[a-zA-Z0-9-_]+$/.test(projectName)) {
+      console.error(
+        "❌ Project name can only contain letters, numbers, dashes (-), and underscores (_)."
+      );
+      rl.close();
+      process.exit(1);
+    }
+  }
+
+  const targetPath = path.resolve(process.cwd(), projectName);
+  const templatePath = path.join(__dirname, "..", "template");
+
+  if (fs.existsSync(targetPath)) {
+    console.error(`❌ Folder "${projectName}" already exists.`);
+    rl.close();
+    process.exit(1);
+  }
+
+  const copyRecursiveSync = (src, dest) => {
+    const entries = fs.readdirSync(src, { withFileTypes: true });
+    fs.mkdirSync(dest, { recursive: true });
+
+    for (let entry of entries) {
+      const srcPath = path.join(src, entry.name);
+      const destPath = path.join(dest, entry.name);
+      if (entry.isDirectory()) {
+        copyRecursiveSync(srcPath, destPath);
+      } else {
+        fs.copyFileSync(srcPath, destPath);
+      }
+    }
+  };
+
+  console.log(`\n🚧 Creating project in ./${projectName}...`);
+  copyRecursiveSync(templatePath, targetPath);
+
+  const packageJsonPath = path.join(targetPath, "package.json");
+  if (fs.existsSync(packageJsonPath)) {
+    const pkg = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+    pkg.name = projectName;
+    fs.writeFileSync(packageJsonPath, JSON.stringify(pkg, null, 2));
+    console.log(`📦 Updated package.json name to "${projectName}"`);
+  }
+
+  const envContent = `APP_NAME="${projectName}"
+APP_SECRET=
+NODE_ENV="development"
+TZ="Asia/Jakarta"
+DATETIME_FORMAT="dd-MM-yyyy HH:mm:ss"
+DATABASE_URL="mysql://root:@localhost:3306/${projectName}"
+BASE_URL="http://localhost:3000"
+BASE_API_URL="http://localhost:3000/api"
+PORT=3000
+JWT_SECRET=
+`;
+
+  const envExampleContent = envContent.replace(/=.*/g, "=");
+
+  const sourceReadmePath = path.join(__dirname, "..", "README.md");
+  const targetReadmePath = path.join(targetPath, "README.md");
+
+  if (fs.existsSync(sourceReadmePath)) {
+    fs.copyFileSync(sourceReadmePath, targetReadmePath);
+    console.log("📄  Copied README.md...");
+  }
+
+  console.log("📝 Generating .env and .env.example...");
+  fs.writeFileSync(path.join(targetPath, ".env"), envContent);
+  fs.writeFileSync(path.join(targetPath, ".env.example"), envExampleContent);
+
+  console.log("🔧 Initializing git repository...");
+  const gitInit = spawnSync("git", ["init"], {
+    cwd: targetPath,
+    stdio: "inherit",
+    shell: true,
+  });
+
+  if (gitInit.status !== 0) {
+    console.warn("⚠️ Git initialization failed.");
+  }
+
+  const gitignorePath = path.join(targetPath, ".gitignore");
+  if (!fs.existsSync(gitignorePath)) {
+    fs.writeFileSync(
+      gitignorePath,
+      `node_modules
+.env
+dist
+`
+    );
+  }
+
+  const installNow = await ask(
+    "📥 Do you want to install dependencies now? (yes/no): "
+  );
+  if (installNow.toLowerCase() === "yes" || installNow.toLowerCase() === "y") {
+    console.log("📦 Installing dependencies...");
+    const npmInstall = spawnSync("npm", ["install"], {
+      cwd: targetPath,
+      stdio: "inherit",
+      shell: true,
+    });
+
+    if (npmInstall.status !== 0) {
+      console.warn("⚠️ npm install failed.");
+      console.log("\n✅ Done!");
+      console.log(
+        `\nNext steps:\n cd ${projectName}\n npm install\n node craft key:generate\n node craft db:generate\n node craft db:migrate\n node craft dev`
+      );
+    } else {
+      console.log("✅ Dependencies installed successfully.");
+      console.log("\n✅ Done!");
+      console.log(
+        `\nNext steps:\n cd ${projectName}\n node craft key:generate\n node craft db:generate\n node craft db:migrate\n node craft dev`
+      );
+    }
+  } else {
+    console.log("ℹ️ Skipping dependency installation.");
+    console.log("\n✅ Done!");
+    console.log(
+      `\nNext steps:\n cd ${projectName}\n npm install\n node craft key:generate\n node craft db:generate\n node craft db:migrate\n node craft dev`
+    );
+  }
+
+  rl.close();
+})();

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "create-craftjs",
+  "version": "1.0.0",
+  "description": "A starter kit backend framework powered by Express, TypeScript, EJS Engine, and Prisma — designed for rapid development, simplicity, and scalability.",
+  "bin": {
+    "create-craftjs": "bin/index.js"
+  },
+  "author": "Muhammad Isa Nuruddin",
+  "homepage": "https://github.com/muhammadisa-n/CraftJS#readme",
+  "bugs": {
+    "url": "https://github.com/muhammadisa-n/CraftJS/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/muhammadisa-n/CraftJS.git"
+  },
+  "license": "UNLICENSED",
+  "keywords": [
+    "express",
+    "typescript",
+    "prisma",
+    "api"
+  ]
+}

package/template/.dockerignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+Dockerfile
+.dockerignore

package/template/Dockerfile

@@ -0,0 +1,12 @@
+FROM node:20
+WORKDIR /usr/src/app
+COPY package*.json ./
+RUN npm install
+COPY prisma ./prisma
+RUN npx prisma generate
+COPY . .
+COPY .env .env
+RUN npm install typescript
+RUN npm run build
+EXPOSE 3000
+CMD ["npm", "run", "dev"]

package/template/babel.config.json

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env", "@babel/preset-typescript"]
+}

package/template/craft/commands/build.js

@@ -0,0 +1,15 @@
+const { execSync } = require("child_process");
+const chalk = require("chalk");
+function Build() {
+  console.log(chalk.blue("📦 Building project..."));
+
+  try {
+    execSync("npx tsc && cp -r src/views dist/views", { stdio: "inherit" });
+    console.log(chalk.green("✅ Build completed successfully."));
+  } catch (error) {
+    console.error(chalk.red("❌ Build failed."));
+    process.exit(1);
+  }
+}
+
+module.exports = Build;

package/template/craft/commands/db-fresh.js

@@ -0,0 +1,22 @@
+const { spawnSync } = require("child_process");
+const chalk = require("chalk");
+
+function DbReset() {
+  console.log(chalk.blue("🚀 Running prisma migrate reset..."));
+
+  const result = spawnSync("npx", ["prisma", "migrate", "reset"], {
+    stdio: "inherit",
+    shell: true,
+  });
+
+  if (result.status !== 0) {
+    console.error(chalk.red("❌ Migrate reset failed."));
+    if (result.error) {
+      console.error(chalk.red(`Error: ${result.error.message}`));
+    }
+    process.exit(result.status ?? 1);
+  } else {
+    console.log(chalk.green("✅ Migrate reset completed."));
+  }
+}
+module.exports = DbReset;

package/template/craft/commands/db-generate.js

@@ -0,0 +1,23 @@
+const { spawnSync } = require("child_process");
+const chalk = require("chalk");
+
+function DbGenerate() {
+  console.log(chalk.blue("🚀 Running prisma generate..."));
+
+  const result = spawnSync("npx", ["prisma", "generate"], {
+    stdio: "inherit",
+    shell: true,
+  });
+
+  if (result.status !== 0) {
+    console.error(chalk.red("❌ Generate failed."));
+    // Jika ada error, print detailnya
+    if (result.error) {
+      console.error(chalk.red(`Error: ${result.error.message}`));
+    }
+    process.exit(result.status ?? 1);
+  } else {
+    console.log(chalk.green("✅ Prisma generate completed."));
+  }
+}
+module.exports = DbGenerate;

package/template/craft/commands/db-migrate.js

@@ -0,0 +1,22 @@
+const { spawnSync } = require("child_process");
+const chalk = require("chalk");
+
+function DbMigrate() {
+  console.log(chalk.blue("🚀 Running prisma migrate dev..."));
+
+  const result = spawnSync("npx", ["prisma", "migrate", "dev"], {
+    stdio: "inherit",
+    shell: true,
+  });
+
+  if (result.status !== 0) {
+    console.error(chalk.red("❌ Migration failed."));
+    if (result.error) {
+      console.error(chalk.red(`Error: ${result.error.message}`));
+    }
+    process.exit(result.status ?? 1);
+  } else {
+    console.log(chalk.green("✅ Migration completed."));
+  }
+}
+module.exports = DbMigrate;

package/template/craft/commands/dev.js

@@ -0,0 +1,16 @@
+const { spawnSync } = require("child_process");
+const chalk = require("chalk");
+
+function Dev() {
+  console.log(chalk.blue("🚀 Starting development server with nodemon..."));
+  const result = spawnSync("nodemon", ["./src/main.ts"], {
+    stdio: "inherit",
+    shell: true,
+  });
+
+  if (result.status !== 0) {
+    console.error(chalk.red("❌ Failed to start development server."));
+    process.exit(result.status ?? 1);
+  }
+}
+module.exports = Dev;

package/template/craft/commands/key-generate.js

@@ -0,0 +1,41 @@
+const chalk = require("chalk");
+const fs = require("fs");
+const path = require("path");
+const crypto = require("crypto");
+
+function keyGenerate() {
+  const envPath = path.resolve(process.cwd(), ".env");
+  if (!fs.existsSync(envPath)) {
+    console.error(chalk.red("❌ .env file not found!"));
+    process.exit(1);
+  }
+
+  let envContent = fs.readFileSync(envPath, "utf-8");
+
+  const generateKey = (number) => crypto.randomBytes(number).toString("hex");
+
+  if (envContent.includes("JWT_SECRET=")) {
+    envContent = envContent.replace(
+      /JWT_SECRET=.*/g,
+      `JWT_SECRET=${generateKey(16)}`
+    );
+  } else {
+    envContent += `\nJWT_SECRET_ACCESS_TOKEN=${generateKey(16)}`;
+  }
+
+  if (envContent.includes("APP_SECRET=")) {
+    envContent = envContent.replace(
+      /APP_SECRET=.*/g,
+      `APP_SECRET=${generateKey(32)}`
+    );
+  } else {
+    envContent += `\APP_SECRET=${generateKey(32)}`;
+  }
+
+  fs.writeFileSync(envPath, envContent);
+
+  console.log(
+    chalk.green("✅ App Secret and JWT Secret generated successfully.")
+  );
+}
+module.exports = keyGenerate;

package/template/craft/commands/make-apidocs.js

@@ -0,0 +1,121 @@
+const fs = require("fs");
+const path = require("path");
+const chalk = require("chalk");
+
+function makeApiDocs(name) {
+  if (!name) {
+    console.log(chalk.red("❌ Please provide a apidocs name."));
+    return;
+  }
+
+  const fileName = `${name.toLowerCase()}-docs.ts`;
+  const targetDir = path.resolve("src", "apidocs");
+
+  if (!fs.existsSync(targetDir)) {
+    fs.mkdirSync(targetDir, { recursive: true });
+  }
+
+  const filePath = path.join(targetDir, fileName);
+  if (fs.existsSync(filePath)) {
+    console.log(chalk.yellow("⚠️ Apidocs already exists."));
+    return;
+  }
+
+  const content = `/**
+ * @swagger
+ * /api/${name}:
+ *   get:
+ *     summary: Mengambil daftar semua ${name}
+ *     tags: [${name}s]
+ *     security:
+ *       - bearerAuth: []
+ *     parameters:
+ *       - in: query
+ *         name: page
+ *         schema:
+ *           type: integer
+ *         required: false
+ *         description: Nomor halaman
+ *       - in: query
+ *         name: take
+ *         schema:
+ *           type: integer
+ *         required: false
+ *         description: Jumlah data per halaman
+ *       - in: query
+ *         name: name
+ *         schema:
+ *           type: string
+ *         required: false
+ *         description: Filter berdasarkan nama (fullName)
+ *     responses:
+ *       200:
+ *         description: Berhasil Get All Data
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: boolean
+ *                 status_code:
+ *                   type: integer
+ *                 message:
+ *                   type: string
+ *                 data:
+ *                   type: object
+ *                   properties:
+ *                     data:
+ *                       type: array
+ *                       items:
+ *                         type: object
+ *                         properties:
+ *                           id:
+ *                             type: string
+ *                             format: uuid
+ *                           fullName:
+ *                             type: string
+ *                           email:
+ *                             type: string
+ *                           username:
+ *                             type: string
+ *                           password:
+ *                             type: string
+ *                             description: (Hashed password)
+ *                           image_id:
+ *                             type: string
+ *                           image_url:
+ *                             type: string
+ *                             format: uri
+ *                           is_verify:
+ *                             type: boolean
+ *                           created_at:
+ *                             type: string
+ *                             format: date-time
+ *                           updated_at:
+ *                             type: string
+ *                             format: date-time
+ *                           deleted_at:
+ *                             type: string
+ *                             format: date-time
+ *                             nullable: true
+ *                           role_id:
+ *                             type: string
+ *                             format: uuid
+ *                     total_data:
+ *                       type: integer
+ *                     paging:
+ *                       type: object
+ *                       properties:
+ *                         current_page:
+ *                           type: integer
+ *                         total_page:
+ *                           type: integer
+
+ */
+`;
+
+  fs.writeFileSync(filePath, content);
+  console.log(chalk.green(`✅ Controller created at ${filePath}`));
+}
+module.exports = makeApiDocs;

package/template/craft/commands/make-command.js

@@ -0,0 +1,38 @@
+const fs = require("fs");
+const path = require("path");
+const chalk = require("chalk");
+
+function makeCommand(name) {
+  if (!name) {
+    console.log(chalk.red("❌ Please provide a command name."));
+    return;
+  }
+
+  const fileName = `${name.toLowerCase()}.js`;
+  const targetDir = path.resolve("craft", "commands");
+
+  if (!fs.existsSync(targetDir)) {
+    fs.mkdirSync(targetDir, { recursive: true });
+  }
+
+  const filePath = path.join(targetDir, fileName);
+  if (fs.existsSync(filePath)) {
+    console.log(chalk.yellow("⚠️ Command already exists."));
+    return;
+  }
+
+  const content = `const fs = require("fs");
+  const path = require("path");
+  const chalk = require("chalk");
+
+  function make${name}(name) {
+
+  }
+
+  module.exports = make${name};
+`;
+
+  fs.writeFileSync(filePath, content);
+  console.log(chalk.green(`✅ Command created at ${filePath}`));
+}
+module.exports = makeCommand;

package/template/craft/commands/make-dto.js

@@ -0,0 +1,39 @@
+const fs = require("fs");
+const path = require("path");
+const chalk = require("chalk");
+
+const toPascalCase = (str) =>
+  str.replace(/(^\w|-\w)/g, (m) => m.replace("-", "").toUpperCase());
+
+function makeDto(name) {
+  if (!name) {
+    console.log(chalk.red("❌ Please provide a dto name."));
+    return;
+  }
+
+  const typeName = `${toPascalCase(name)}Request`;
+  const fileName = `${name.toLowerCase()}-dto.ts`;
+  const targetDir = path.resolve("src", "dtos");
+
+  if (!fs.existsSync(targetDir)) {
+    fs.mkdirSync(targetDir, { recursive: true });
+  }
+
+  const filePath = path.join(targetDir, fileName);
+  if (fs.existsSync(filePath)) {
+    console.log(chalk.yellow("⚠️ Dto already exists."));
+    return;
+  }
+
+  const content = `export type ${typeName} = {
+  field1: string;
+  field2?: string;   // optional
+
+};
+`;
+
+  fs.writeFileSync(filePath, content);
+  console.log(chalk.green(`✅ Dto created at ${filePath}`));
+}
+
+module.exports = makeDto;