create-charcole 1.1.0 → 2.0.1

package/.github/workflows/release.yml

@@ -0,0 +1,26 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org
+
+      - run: npm ci
+
+      - run: npm publish --access public

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [2.0.0] – 2026-01-24
+
+### Added
+
+- Full TypeScript project template support
+- Language selection (JavaScript / TypeScript) at CLI runtime
+- Improved project scaffolding structure
+- Better developer experience for production setups
+
+### Changed
+
+- Internal template resolution logic
+- CLI output and onboarding messages
+
+### Fixed
+
+- Incorrect template path resolution in previous versions
+- Local CLI linking issues during development
+
+### Notes
+
+- This release focuses on stability and language parity.
+- Authentication and database modules are intentionally not included yet.

package/README.md

@@ -1,6 +1,6 @@
 # Charcole API
 
-> **Production-grade Node.js Express API with enterprise-level error handling, Zod validation, and structured logging.**
+> **Charcole is a production-grade Node.js backend starter CLI that scaffolds enterprise-ready Express APIs with first-class TypeScript or JavaScript support, centralized error handling, Zod validation, and structured logging out of the box.**
 
 [![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
 [![Express.js](https://img.shields.io/badge/Express-4.18+-blue.svg)](https://expressjs.com/)
@@ -11,6 +11,7 @@
 
 A **production-ready Node.js Express backend** with:
 
+- ✅ **TypeScript or JavaScript** templates (v2 feature)
 - ✅ **Centralized Error Handling** - Every error flows through one place
 - ✅ **Error Classification** - Operational vs Programmer errors distinguished
 - ✅ **Zod Validation** - Type-safe schema validation with automatic error formatting
@@ -396,3 +397,12 @@ ISC
 **Made for teams that care about code quality and production reliability.** 🚀
 
 Need help? See the [Getting Started Guide](template/README.md) or [Full Documentation](ERROR_HANDLING.md).
+
+## 🆕 What’s New in v2.0
+
+- 🚀 **First-class TypeScript & JavaScript support**
+- 🧠 CLI-driven language selection
+- 🧩 Modular template architecture (future feature expansion)
+- 🧼 Cleaner project generation flow
+- 📦 Improved dependency handling
+- 🏗️ Foundation for built-in auth, Swagger, Docker modules

package/bin/index.js

@@ -1,88 +1,107 @@
 #!/usr/bin/env node
 
-const fs = require("fs");
 const path = require("path");
+const fs = require("fs");
 const { execSync } = require("child_process");
+const prompts = require("prompts");
+const { copyTemplateModules } = require("./lib/templateHandler");
+const {
+  detectPackageManager,
+  installDependencies,
+} = require("./lib/pkgManager");
 
-const projectName = process.argv[2];
-
-if (!projectName) {
-  console.error("❌ Please provide a project name.");
-  console.error("Usage: npx create-charcole my-backend");
-  process.exit(1);
-}
+(async function main() {
+  try {
+    console.log("🔥 Welcome to Charcole v2 CLI");
 
-const currentDir = process.cwd();
-const targetDir = path.join(currentDir, projectName);
-const templateDir = path.join(__dirname, "..", "template");
+    const responses = await prompts([
+      {
+        type: "text",
+        name: "projectName",
+        message: "Project name:",
+        validate: (name) => (name ? true : "Project name is required"),
+      },
+      {
+        type: "select",
+        name: "language",
+        message: "Language:",
+        choices: [
+          { title: "TypeScript", value: "ts" },
+          { title: "JavaScript", value: "js" },
+        ],
+        initial: 0,
+      },
+      // TODO: Uncomment when features are implemented
+      // {
+      //   type: "multiselect",
+      //   name: "features",
+      //   message: "Select features to include:",
+      //   choices: [
+      //     { title: "JWT Authentication", value: "auth" },
+      //     { title: "Swagger Docs", value: "swagger", selected: true },
+      //     { title: "Docker Support", value: "docker" },
+      //     { title: "ESLint + Prettier", value: "lint", selected: true },
+      //   ],
+      //   min: 0,
+      // },
+    ]);
 
-if (fs.existsSync(targetDir)) {
-  console.error(`❌ Folder "${projectName}" already exists.`);
-  process.exit(1);
-}
+    const { projectName, language } = responses;
+    const features = []; // Empty for now, will be responses.features later
+    const targetDir = path.join(process.cwd(), projectName);
 
-function copyDir(src, dest) {
-  fs.mkdirSync(dest, { recursive: true });
-  for (const file of fs.readdirSync(src)) {
-    const srcPath = path.join(src, file);
-    const destPath = path.join(dest, file);
-    if (fs.statSync(srcPath).isDirectory()) {
-      copyDir(srcPath, destPath);
-    } else {
-      fs.copyFileSync(srcPath, destPath);
+    if (fs.existsSync(targetDir)) {
+      console.error(`❌ Folder "${projectName}" already exists.`);
+      process.exit(1);
     }
-  }
-}
 
-function detectPackageManager() {
-  try {
-    execSync("bun -v", { stdio: "ignore" });
-    return "bun";
-  } catch {}
-  try {
-    execSync("pnpm -v", { stdio: "ignore" });
-    return "pnpm";
-  } catch {}
-  try {
-    execSync("yarn -v", { stdio: "ignore" });
-    return "yarn";
-  } catch {}
-  return "npm";
-}
+    const pkgManager = detectPackageManager();
 
-try {
-  console.log("🔥 Creating Charcole app...");
-  copyDir(templateDir, targetDir);
+    console.log(`\n📁 Creating project in ${language.toUpperCase()}...`);
 
-  const pkgPath = path.join(targetDir, "package.json");
-  if (fs.existsSync(pkgPath)) {
-    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf8"));
-    pkg.name = projectName;
-    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
-  }
+    // Template directory is template/js or template/ts
+    const templateDir = path.join(__dirname, "..", "template", language);
 
-  console.log("✅ Project created successfully!");
+    copyTemplateModules(templateDir, targetDir, features);
 
-  const pkgManager = detectPackageManager();
-  console.log(`📦 Installing dependencies using ${pkgManager}...`);
+    // basePackage.json is directly in template/js or template/ts
+    const basePkg = JSON.parse(
+      fs.readFileSync(path.join(templateDir, "basePackage.json")),
+    );
+    let mergedPkg = { ...basePkg };
 
-  const installCmd =
-    pkgManager === "bun"
-      ? "bun install"
-      : pkgManager === "yarn"
-        ? "yarn"
-        : pkgManager === "pnpm"
-          ? "pnpm install"
-          : "npm install";
+    // TODO: Uncomment when features are implemented
+    // features.forEach((f) => {
+    //   const fragPath = path.join(templateDir, "modules", f, "package.json");
+    //   if (fs.existsSync(fragPath)) {
+    //     const frag = JSON.parse(fs.readFileSync(fragPath));
+    //     mergedPkg.dependencies = {
+    //       ...mergedPkg.dependencies,
+    //       ...frag.dependencies,
+    //     };
+    //     mergedPkg.devDependencies = {
+    //       ...mergedPkg.devDependencies,
+    //       ...frag.devDependencies,
+    //     };
+    //     mergedPkg.scripts = { ...mergedPkg.scripts, ...frag.scripts };
+    //   }
+    // });
 
-  execSync(installCmd, { cwd: targetDir, stdio: "inherit" });
+    mergedPkg.name = projectName;
+    fs.writeFileSync(
+      path.join(targetDir, "package.json"),
+      JSON.stringify(mergedPkg, null, 2),
+    );
 
-  console.log("\n🚀 All set!");
-  console.log(`  cd ${projectName}`);
-  console.log("  npm run dev");
-  console.log("\n🧱 Built with Charcole — Express, but engineered.");
-} catch (err) {
-  console.error("❌ Failed to create Charcole app.");
-  console.error(err.message);
-  process.exit(1);
-}
+    console.log(`\n📦 Installing dependencies using ${pkgManager}...`);
+    installDependencies(targetDir, pkgManager);
+
+    console.log("\n✅ Charcole project created successfully!");
+    console.log(
+      `\n🚀 Next steps:\n  cd ${projectName}\n  ${pkgManager === "npm" ? "npm run dev" : `${pkgManager} dev`}`,
+    );
+  } catch (err) {
+    console.error("❌ Failed to create Charcole project:", err.message);
+    process.exit(1);
+  }
+})();

package/bin/lib/pkgManager.js

@@ -0,0 +1,66 @@
+const { execSync } = require("child_process");
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * Detect which package manager the user is using
+ * Priority: pnpm > yarn > npm
+ * @returns {string} - Package manager name ('pnpm', 'yarn', or 'npm')
+ */
+function detectPackageManager() {
+  const userAgent = process.env.npm_config_user_agent;
+
+  if (userAgent) {
+    if (userAgent.includes("pnpm")) return "pnpm";
+    if (userAgent.includes("yarn")) return "yarn";
+    if (userAgent.includes("npm")) return "npm";
+  }
+
+  const lockFiles = {
+    "pnpm-lock.yaml": "pnpm",
+    "yarn.lock": "yarn",
+    "package-lock.json": "npm",
+  };
+
+  for (const [lockFile, manager] of Object.entries(lockFiles)) {
+    if (fs.existsSync(path.join(process.cwd(), lockFile))) {
+      return manager;
+    }
+  }
+
+  const installedManagers = ["pnpm", "yarn", "npm"].filter((manager) => {
+    try {
+      execSync(`${manager} --version`, { stdio: "ignore" });
+      return true;
+    } catch {
+      return false;
+    }
+  });
+
+  return installedManagers[0] || "npm";
+}
+
+/**
+ * Install dependencies using the detected package manager
+ * @param {string} targetDir - Project directory where package.json exists
+ * @param {string} pkgManager - Package manager to use ('pnpm', 'yarn', or 'npm')
+ */
+function installDependencies(targetDir, pkgManager) {
+  try {
+    const installCmd =
+      pkgManager === "yarn" ? "yarn install" : `${pkgManager} install`;
+
+    execSync(installCmd, {
+      cwd: targetDir,
+      stdio: "inherit",
+    });
+  } catch (error) {
+    console.error(`\n❌ Failed to install dependencies with ${pkgManager}`);
+    throw error;
+  }
+}
+
+module.exports = {
+  detectPackageManager,
+  installDependencies,
+};

package/bin/lib/templateHandler.js

@@ -0,0 +1,70 @@
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * Recursively copy directory contents
+ * @param {string} src - Source directory
+ * @param {string} dest - Destination directory
+ */
+function copyDir(src, dest) {
+  if (!fs.existsSync(dest)) {
+    fs.mkdirSync(dest, { recursive: true });
+  }
+
+  const entries = fs.readdirSync(src, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+/**
+ * Copy template files based on selected language and features
+ * @param {string} templateDir - Path to template directory (e.g., template/js or template/ts)
+ * @param {string} targetDir - Destination project directory
+ * @param {string[]} features - Array of selected features
+ */
+function copyTemplateModules(templateDir, targetDir, features) {
+  if (!fs.existsSync(targetDir)) {
+    fs.mkdirSync(targetDir, { recursive: true });
+  }
+
+  const entries = fs.readdirSync(templateDir, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const srcPath = path.join(templateDir, entry.name);
+    const destPath = path.join(targetDir, entry.name);
+
+    if (entry.name === "modules" || entry.name.includes("package.json")) {
+      continue;
+    }
+
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+
+  const modulesDir = path.join(templateDir, "modules");
+  if (fs.existsSync(modulesDir)) {
+    features.forEach((feature) => {
+      const featurePath = path.join(modulesDir, feature);
+      if (fs.existsSync(featurePath)) {
+        copyDir(featurePath, targetDir);
+      }
+    });
+  }
+}
+
+module.exports = {
+  copyTemplateModules,
+  copyDir,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-charcole",
-  "version": "1.1.0",
+  "version": "2.0.1",
   "description": "Production-ready Express backend starter with engineering guardrails.",
   "license": "MIT",
   "author": {
@@ -20,5 +20,8 @@
   ],
   "engines": {
     "node": ">=16"
+  },
+  "dependencies": {
+    "prompts": "^2.4.2"
   }
 }

package/template/js/basePackage.json

@@ -0,0 +1,28 @@
+{
+  "name": "charcole",
+  "version": "2.0.0",
+  "description": "Production-grade Node.js Express API",
+  "main": "src/server.js",
+  "scripts": {
+    "start": "node src/server.js",
+    "dev": "nodemon src/server.js",
+    "lint": "echo 'Add linting here'",
+    "test": "echo 'Add tests here'"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "type": "module",
+  "dependencies": {
+    "cors": "^2.8.5",
+    "dotenv": "^16.3.1",
+    "express": "^4.18.2",
+    "zod": "^3.22.4"
+  },
+  "devDependencies": {
+    "nodemon": "^3.0.2"
+  }
+}