create-charcole 2.2.1 → 2.2.2

package/CHANGELOG.md

@@ -5,7 +5,7 @@ All notable changes to Charcole will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.2.1] – 2026-02-06
+## [2.2.2] – 2026-02-06
 
 ### 🎉 Major Release: Auto-Generated Swagger Documentation
 

package/README.md

@@ -349,6 +349,9 @@ We welcome contributions! Please:
 6. Update README.md for significant changes
 7. If adding Swagger docs, use Zod schemas as single source of truth
 
+
+Good luck!!!
+
 ## 📄 License
 
 ISC

package/bin/index.js

@@ -233,14 +233,14 @@ function copyDirRecursive(src, dest, excludeFiles = [], excludeDirs = []) {
       const swaggerPkgPath = path.join(swaggerModuleDir, "package.json");
       const swaggerTgzPath = path.join(
         swaggerModuleDir,
-        "charcole-swagger-1.0.0.tgz",
+        "charcole-swagger-1.0.1.tgz",
       );
 
       // Copy tarball temporarily for npm install (will be cleaned up after)
       if (fs.existsSync(swaggerTgzPath)) {
         fs.copyFileSync(
           swaggerTgzPath,
-          path.join(targetDir, "charcole-swagger-1.0.0.tgz"),
+          path.join(targetDir, "charcole-swagger-1.0.1.tgz"),
         );
         console.log("✓ Copied Swagger tarball temporarily for installation");
       } else {
@@ -418,12 +418,62 @@ function copyDirRecursive(src, dest, excludeFiles = [], excludeDirs = []) {
       Object.keys(mergedPkg.devDependencies || {}).join(", "),
     );
 
+    // Create .env from .env.example and ensure APP_NAME default exists
+    try {
+      const exampleEnvPath = path.join(targetDir, ".env.example");
+      const envPath = path.join(targetDir, ".env");
+
+      if (fs.existsSync(exampleEnvPath) && !fs.existsSync(envPath)) {
+        let exampleContent = fs.readFileSync(exampleEnvPath, "utf-8");
+
+        if (!/APP_NAME\s*=/.test(exampleContent)) {
+          exampleContent = `APP_NAME=CHARCOLE API\n` + exampleContent;
+        }
+
+        fs.writeFileSync(envPath, exampleContent, "utf-8");
+        console.log("✓ Created .env from .env.example with default APP_NAME");
+      }
+    } catch (err) {
+      console.warn("⚠️  Failed to create .env automatically:", err.message);
+    }
+
+    // Initialize git repository to make project git-friendly
+    try {
+      const { execSync } = require("child_process");
+
+      execSync("git --version", { stdio: "ignore" });
+      execSync("git init", { cwd: targetDir, stdio: "ignore" });
+
+      // Ensure .gitignore exists (copy from template if missing)
+      const gitignoreSrc = path.join(templateDir, ".gitignore");
+      const gitignoreDest = path.join(targetDir, ".gitignore");
+      if (!fs.existsSync(gitignoreDest) && fs.existsSync(gitignoreSrc)) {
+        fs.copyFileSync(gitignoreSrc, gitignoreDest);
+      }
+
+      // Stage files and attempt initial commit; ignore commit errors (e.g., missing git user config)
+      try {
+        execSync("git add .", { cwd: targetDir, stdio: "ignore" });
+        execSync('git commit -m "chore: initial commit from Charcole"', {
+          cwd: targetDir,
+          stdio: "ignore",
+        });
+        console.log("✓ Initialized git repository and created initial commit");
+      } catch (commitErr) {
+        console.log(
+          "✓ Initialized git repository (skipped commit — configure git user to enable commits)",
+        );
+      }
+    } catch (gitErr) {
+      console.log("ℹ️  Git not available; skipping repository initialization");
+    }
+
     console.log(`\n📦 Installing dependencies using ${pkgManager}...`);
     installDependencies(targetDir, pkgManager);
 
     // Clean up the swagger tarball after installation
     if (swagger) {
-      const tgzPath = path.join(targetDir, "charcole-swagger-1.0.0.tgz");
+      const tgzPath = path.join(targetDir, "charcole-swagger-1.0.1.tgz");
       if (fs.existsSync(tgzPath)) {
         fs.unlinkSync(tgzPath);
         console.log("✓ Cleaned up temporary Swagger tarball");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-charcole",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "CLI to create production-ready Node.js Express APIs with TypeScript/JavaScript, JWT auth, auto-generated Swagger docs, and repository pattern",
   "license": "MIT",
   "author": {
@@ -9,10 +9,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/sheraz4196/create-charcole.git"
+    "url": "https://github.com/sheraz4196/charcole.git"
   },
   "bugs": {
-    "url": "https://github.com/sheraz4196/create-charcole/issues"
+    "url": "https://github.com/sheraz4196/charcole/issues"
   },
   "homepage": "https://www.charcole.site/",
   "bin": {

package/packages/swagger/BACKWARD_COMPATIBILITY.md

@@ -37,7 +37,7 @@ Old setup without new options:
 ```typescript
 setupSwagger(app, {
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
 });
 ```
 

package/packages/swagger/CHANGELOG.md

@@ -121,7 +121,7 @@ import {
 setupSwagger(app, {
   // Old options (still work)
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
   path: "/api-docs",
   servers: [...],
 

package/packages/swagger/README.md

@@ -30,7 +30,7 @@ const app = express();
 
 setupSwagger(app, {
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
   schemas: {
     createUserSchema, // Auto-converted from Zod!
     loginSchema,
@@ -107,7 +107,7 @@ Sets up Swagger UI and documentation generation.
 | Option                   | Type    | Default                            | Description                         |
 | ------------------------ | ------- | ---------------------------------- | ----------------------------------- |
 | `title`                  | string  | "Charcole API"                     | API title                           |
-| `version`                | string  | "1.0.0"                            | API version                         |
+| `version`                | string  | "1.0.1"                            | API version                         |
 | `description`            | string  | "Auto-generated API documentation" | API description                     |
 | `path`                   | string  | "/api-docs"                        | Swagger UI path                     |
 | `servers`                | array   | `[{url: "http://localhost:3000"}]` | Server URLs                         |
@@ -267,7 +267,7 @@ const app: Application = express();
 
 const options: SwaggerOptions = {
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
   schemas: {
     mySchema,
   },

package/packages/swagger/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@charcoles/swagger",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Auto-generated Swagger documentation for Charcole APIs",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -17,11 +17,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/sheraz4196/create-charcole.git",
+    "url": "https://github.com/sheraz4196/charcole.git",
     "directory": "packages/swagger"
   },
   "bugs": {
-    "url": "https://github.com/sheraz4196/create-charcole/issues"
+    "url": "https://github.com/sheraz4196/charcole/issues"
   },
   "homepage": "https://www.charcole.site/guides/swagger/introduction",
   "scripts": {

package/packages/swagger/src/setup.js

@@ -7,7 +7,7 @@ import { registerSchemas, getCommonResponses } from "./helpers.js";
 export function setupSwagger(app, options = {}) {
   const defaultOptions = {
     title: "Charcole API",
-    version: "1.0.0",
+    version: "1.0.1",
     description: "Auto-generated API documentation",
     path: "/api-docs",
     servers: [{ url: "http://localhost:3000", description: "Local server" }],

package/template/js/.env.example

@@ -1,4 +1,5 @@
 # Server Configuration
+APP_NAME=CHARCOLE API
 NODE_ENV=development
 PORT=3000
 

package/template/js/README.md

@@ -34,9 +34,13 @@ Welcome! This guide will help you set up and start using the Charcole API framew
 
 2. **Create environment file**
 
-   ```bash
-   cp .env.example .env
-   ```
+The `create-charcole` CLI will automatically create a `.env` from `.env.example` and initialize a Git repository for you. Edit the generated `.env` as needed.
+
+If you prefer to create it manually:
+
+```bash
+cp .env.example .env
+```
 
 3. **Run the charcole**
    ```bash

package/template/js/basePackage.json

@@ -1,6 +1,6 @@
 {
   "name": "charcole",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "Production-grade Node.js Express API",
   "main": "src/server.js",
   "type": "module",

package/template/js/src/app.js

@@ -56,7 +56,7 @@ app.get(
       res,
       {
         message: "Welcome to Charcole API",
-        version: "1.0.0",
+        version: "1.0.1",
         environment: env.NODE_ENV,
       },
       200,

package/template/js/src/config/swagger.config.js

@@ -1,6 +1,6 @@
 export default {
   title: process.env.APP_NAME || "Charcole API",
-  version: process.env.APP_VERSION || "1.0.0",
+  version: process.env.APP_VERSION || "1.0.1",
   description: "Production-ready Node.js Express API",
   path: "/api-docs",
   servers: [

package/template/js/src/lib/swagger/SWAGGER_GUIDE.md

@@ -18,8 +18,8 @@ import { createItemSchema } from "../modules/health/controller.ts";
 
 const swaggerConfig = {
   title: "My API",
-  version: "1.0.0",
-  // Auto-register schemas - they'll be converted to OpenAPI automatically!
+  version: "1.0.1",
+  // Auto-register schemas - they'll be  converted to OpenAPI automatically!
   schemas: {
     registerSchema,
     loginSchema,
@@ -472,7 +472,7 @@ const app = express();
 
 setupSwagger(app, {
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
   schemas: {
     mySchema, // Your Zod schemas
   },

package/template/js/src/modules/swagger/package.json

@@ -1,5 +1,5 @@
 {
   "dependencies": {
-    "@charcoles/swagger": "file:./charcole-swagger-1.0.0.tgz"
+    "@charcoles/swagger": "file:./charcole-swagger-1.0.1.tgz"
   }
 }

package/template/ts/.env.example

@@ -1,4 +1,5 @@
 # Server Configuration
+APP_NAME=CHARCOLE API
 NODE_ENV=development
 PORT=3000
 

package/template/ts/README.md

@@ -34,9 +34,13 @@ Welcome! This guide will help you set up and start using the Charcole API framew
 
 2. **Create environment file**
 
-   ```bash
-   cp .env.example .env
-   ```
+The `create-charcole` CLI will automatically create a `.env` from `.env.example` and initialize a Git repository for you. Edit the generated `.env` as needed.
+
+If you prefer to create it manually:
+
+```bash
+cp .env.example .env
+```
 
 3. **Run the charcole**
    ```bash

package/template/ts/basePackage.json

@@ -1,6 +1,6 @@
 {
   "name": "charcole",
-  "version": "2.2.1",
+  "version": "2.2.2",
   "description": "Production-grade Node.js Express API",
   "main": "dist/server.js",
   "type": "module",

package/template/ts/src/config/swagger.config.ts

@@ -3,7 +3,7 @@ import { createItemSchema } from "../modules/health/controller.ts";
 
 const swaggerConfig = {
   title: process.env.APP_NAME || "Charcole API",
-  version: process.env.APP_VERSION || "1.0.0",
+  version: process.env.APP_VERSION || "1.0.1",
   description: "Production-ready Node.js Express API",
   path: "/api-docs",
   servers: [

package/template/ts/src/lib/swagger/SWAGGER_GUIDE.md

@@ -18,7 +18,7 @@ import { createItemSchema } from "../modules/health/controller.ts";
 
 const swaggerConfig = {
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
   // Auto-register schemas - they'll be converted to OpenAPI automatically!
   schemas: {
     registerSchema,
@@ -472,7 +472,7 @@ const app = express();
 
 setupSwagger(app, {
   title: "My API",
-  version: "1.0.0",
+  version: "1.0.1",
   schemas: {
     mySchema, // Your Zod schemas
   },

package/template/ts/src/modules/swagger/package.json

@@ -1,5 +1,5 @@
 {
   "dependencies": {
-    "@charcoles/swagger": "file:./charcole-swagger-1.0.0.tgz"
+    "@charcoles/swagger": "file:./charcole-swagger-1.0.1.tgz"
   }
 }