create-craftjs 1.0.4 → 1.0.6

package/README.md

@@ -1,137 +1,139 @@
-# 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)
+# 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/
+├── docker-compose.yml
+├── Dockerfile
+├── .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

@@ -1,158 +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();
-})();
+#!/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

@@ -1,24 +1,24 @@
-{
-  "name": "create-craftjs",
-  "version": "1.0.4",
-  "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"
-  ]
-}
+{
+  "name": "create-craftjs",
+  "version": "1.0.6",
+  "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"
+  ]
+}