create-charcole 2.2.0 → 2.2.2

package/bin/lib/pkgManager.js

@@ -1,49 +1,49 @@
-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
- */
-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;
-    }
-  }
-
-  return "npm";
-}
-
-/**
- * Install dependencies
- */
-function installDependencies(targetDir, pkgManager) {
-  const installCmd =
-    pkgManager === "yarn" ? "yarn install" : `${pkgManager} install`;
-
-  execSync(installCmd, {
-    cwd: targetDir,
-    stdio: "inherit",
-  });
-}
-
-module.exports = {
-  detectPackageManager,
-  installDependencies,
-};
+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
+ */
+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;
+    }
+  }
+
+  return "npm";
+}
+
+/**
+ * Install dependencies
+ */
+function installDependencies(targetDir, pkgManager) {
+  const installCmd =
+    pkgManager === "yarn" ? "yarn install" : `${pkgManager} install`;
+
+  execSync(installCmd, {
+    cwd: targetDir,
+    stdio: "inherit",
+  });
+}
+
+module.exports = {
+  detectPackageManager,
+  installDependencies,
+};

package/bin/lib/templateHandler.js

@@ -1,33 +1,33 @@
-const fs = require("fs");
-const path = require("path");
-
-/**
- * Recursively copy directory contents, excluding specific files
- */
-function copyDir(src, dest, excludeFiles = []) {
-  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);
-
-    // Skip excluded files
-    if (excludeFiles.includes(entry.name)) {
-      continue;
-    }
-
-    if (entry.isDirectory()) {
-      copyDir(srcPath, destPath, excludeFiles);
-    } else {
-      fs.copyFileSync(srcPath, destPath);
-    }
-  }
-}
-
-module.exports = {
-  copyDir,
-};
+const fs = require("fs");
+const path = require("path");
+
+/**
+ * Recursively copy directory contents, excluding specific files
+ */
+function copyDir(src, dest, excludeFiles = []) {
+  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);
+
+    // Skip excluded files
+    if (excludeFiles.includes(entry.name)) {
+      continue;
+    }
+
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath, excludeFiles);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+module.exports = {
+  copyDir,
+};

package/package.json

@@ -1,27 +1,42 @@
-{
-  "name": "create-charcole",
-  "version": "2.2.0",
-  "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": {
-    "name": "Sheraz Manzoor",
-    "email": "sheraz.dev121@gmail.com"
-  },
-  "bin": {
-    "create-charcole": "bin/index.js"
-  },
-  "keywords": [
-    "express",
-    "backend",
-    "starter",
-    "boilerplate",
-    "production",
-    "charcole"
-  ],
-  "engines": {
-    "node": ">=16"
-  },
-  "dependencies": {
-    "prompts": "^2.4.2"
-  }
-}
+{
+  "name": "create-charcole",
+  "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": {
+    "name": "Sheraz Manzoor",
+    "email": "sheraz.dev121@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sheraz4196/charcole.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sheraz4196/charcole/issues"
+  },
+  "homepage": "https://www.charcole.site/",
+  "bin": {
+    "create-charcole": "bin/index.js"
+  },
+  "keywords": [
+    "express",
+    "backend",
+    "starter",
+    "boilerplate",
+    "production",
+    "charcole",
+    "nodejs starter",
+    "express starter",
+    "typescript backend",
+    "swagger",
+    "backend template",
+    "api-boilerplate",
+    "zod validation"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "dependencies": {
+    "prompts": "^2.4.2"
+  }
+}

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,44 +1,57 @@
-{
-  "name": "@charcoles/swagger",
-  "version": "1.0.0",
-  "description": "Auto-generated Swagger documentation for Charcole APIs",
-  "main": "src/index.js",
-  "types": "src/index.d.ts",
-  "type": "module",
-  "exports": {
-    ".": {
-      "types": "./src/index.d.ts",
-      "default": "./src/index.js"
-    }
-  },
-  "scripts": {
-    "test": "echo \"No tests yet\" && exit 0",
-    "prepare": "echo 'Ready for npm link'"
-  },
-  "dependencies": {
-    "swagger-ui-express": "^4.6.3",
-    "swagger-jsdoc": "^6.2.8",
-    "glob": "^10.3.10",
-    "zod-to-json-schema": "^3.22.4"
-  },
-  "peerDependencies": {
-    "zod": "^3.0.0"
-  },
-  "peerDependenciesMeta": {
-    "zod": {
-      "optional": true
-    }
-  },
-  "keywords": [
-    "charcole",
-    "swagger",
-    "openapi",
-    "documentation",
-    "express"
-  ],
-  "author": "Sheraz Manzoor",
-  "license": "ISC",
-  "publishConfig": {
-    "access": "public"
-  }
-}
+{
+  "name": "@charcoles/swagger",
+  "version": "1.0.1",
+  "description": "Auto-generated Swagger documentation for Charcole APIs",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "author": {
+    "name": "Sheraz Manzoor",
+    "email": "sheraz.dev121@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sheraz4196/charcole.git",
+    "directory": "packages/swagger"
+  },
+  "bugs": {
+    "url": "https://github.com/sheraz4196/charcole/issues"
+  },
+  "homepage": "https://www.charcole.site/guides/swagger/introduction",
+  "scripts": {
+    "test": "echo \"No tests yet\" && exit 0",
+    "prepare": "echo 'Ready for npm link'"
+  },
+  "dependencies": {
+    "swagger-ui-express": "^4.6.3",
+    "swagger-jsdoc": "^6.2.8",
+    "glob": "^10.3.10",
+    "zod-to-json-schema": "^3.22.4"
+  },
+  "peerDependencies": {
+    "zod": "^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "zod": {
+      "optional": true
+    }
+  },
+  "keywords": [
+    "charcole",
+    "swagger",
+    "openapi",
+    "documentation",
+    "express",
+    "charcole swagger"
+  ],
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/packages/swagger/src/index.d.ts

@@ -1,126 +1,126 @@
-import { Application } from "express";
-import { ZodType, ZodSchema } from "zod";
-
-export interface SwaggerServer {
-  url: string;
-  description: string;
-}
-
-export interface SwaggerOptions {
-  title?: string;
-  version?: string;
-  description?: string;
-  path?: string;
-  servers?: SwaggerServer[];
-  // NEW: Auto-register Zod schemas
-  schemas?: Record<string, ZodType<any>>;
-  // NEW: Include common response templates (default: true)
-  includeCommonResponses?: boolean;
-  // NEW: Custom response schemas
-  customResponses?: Record<string, any>;
-}
-
-export interface OpenAPISpec {
-  openapi: string;
-  info: {
-    title: string;
-    version: string;
-    description: string;
-  };
-  servers: SwaggerServer[];
-  components: {
-    securitySchemes: {
-      bearerAuth: {
-        type: string;
-        scheme: string;
-        bearerFormat: string;
-        description: string;
-      };
-    };
-    schemas?: Record<string, any>;
-    responses?: Record<string, any>;
-  };
-  paths?: Record<string, any>;
-}
-
-export function setupSwagger(
-  app: Application,
-  options?: SwaggerOptions,
-): OpenAPISpec;
-
-// Helper functions
-export interface EndpointParameter {
-  in: "path" | "query" | "header";
-  name: string;
-  required?: boolean;
-  type?: string;
-  description?: string;
-}
-
-export interface EndpointOptions {
-  summary: string;
-  description?: string;
-  tags?: string[];
-  schema?: string;
-  responseSchema?: string;
-  security?: boolean;
-  params?: EndpointParameter[];
-}
-
-export interface SwaggerDocOptions {
-  method: string;
-  path: string;
-  summary: string;
-  description?: string;
-  tags?: string[];
-  requestSchema?: string;
-  responseSchemaName?: string;
-  security?: boolean;
-  parameters?: EndpointParameter[];
-}
-
-/**
- * Convert Zod schema to OpenAPI JSON Schema
- */
-export function convertZodToOpenAPI(
-  zodSchema: ZodType<any>,
-  name: string,
-): object | null;
-
-/**
- * Extract body schema from a Zod schema that has a .body property
- */
-export function extractBodySchema(schema: ZodType<any>): ZodType<any> | null;
-
-/**
- * Get common response schemas (Success, ValidationError, Unauthorized, etc.)
- */
-export function getCommonResponses(): Record<string, any>;
-
-/**
- * Detect security requirements from middleware chain
- */
-export function detectSecurity(
-  middlewares: Function[],
-): Array<{ bearerAuth: [] }>;
-
-/**
- * Create a Swagger documentation comment block
- */
-export function createSwaggerDoc(options: SwaggerDocOptions): string;
-
-/**
- * Register Zod schemas for auto-documentation
- */
-export function registerSchemas(
-  schemas: Record<string, ZodType<any>>,
-): Record<string, any>;
-
-/**
- * Simplified API for quick endpoint documentation
- */
-export function endpoint(
-  method: string,
-  path: string,
-  options?: EndpointOptions,
-): Record<string, any>;
+import { Application } from "express";
+import { ZodType, ZodSchema } from "zod";
+
+export interface SwaggerServer {
+  url: string;
+  description: string;
+}
+
+export interface SwaggerOptions {
+  title?: string;
+  version?: string;
+  description?: string;
+  path?: string;
+  servers?: SwaggerServer[];
+  // NEW: Auto-register Zod schemas
+  schemas?: Record<string, ZodType<any>>;
+  // NEW: Include common response templates (default: true)
+  includeCommonResponses?: boolean;
+  // NEW: Custom response schemas
+  customResponses?: Record<string, any>;
+}
+
+export interface OpenAPISpec {
+  openapi: string;
+  info: {
+    title: string;
+    version: string;
+    description: string;
+  };
+  servers: SwaggerServer[];
+  components: {
+    securitySchemes: {
+      bearerAuth: {
+        type: string;
+        scheme: string;
+        bearerFormat: string;
+        description: string;
+      };
+    };
+    schemas?: Record<string, any>;
+    responses?: Record<string, any>;
+  };
+  paths?: Record<string, any>;
+}
+
+export function setupSwagger(
+  app: Application,
+  options?: SwaggerOptions,
+): OpenAPISpec;
+
+// Helper functions
+export interface EndpointParameter {
+  in: "path" | "query" | "header";
+  name: string;
+  required?: boolean;
+  type?: string;
+  description?: string;
+}
+
+export interface EndpointOptions {
+  summary: string;
+  description?: string;
+  tags?: string[];
+  schema?: string;
+  responseSchema?: string;
+  security?: boolean;
+  params?: EndpointParameter[];
+}
+
+export interface SwaggerDocOptions {
+  method: string;
+  path: string;
+  summary: string;
+  description?: string;
+  tags?: string[];
+  requestSchema?: string;
+  responseSchemaName?: string;
+  security?: boolean;
+  parameters?: EndpointParameter[];
+}
+
+/**
+ * Convert Zod schema to OpenAPI JSON Schema
+ */
+export function convertZodToOpenAPI(
+  zodSchema: ZodType<any>,
+  name: string,
+): object | null;
+
+/**
+ * Extract body schema from a Zod schema that has a .body property
+ */
+export function extractBodySchema(schema: ZodType<any>): ZodType<any> | null;
+
+/**
+ * Get common response schemas (Success, ValidationError, Unauthorized, etc.)
+ */
+export function getCommonResponses(): Record<string, any>;
+
+/**
+ * Detect security requirements from middleware chain
+ */
+export function detectSecurity(
+  middlewares: Function[],
+): Array<{ bearerAuth: [] }>;
+
+/**
+ * Create a Swagger documentation comment block
+ */
+export function createSwaggerDoc(options: SwaggerDocOptions): string;
+
+/**
+ * Register Zod schemas for auto-documentation
+ */
+export function registerSchemas(
+  schemas: Record<string, ZodType<any>>,
+): Record<string, any>;
+
+/**
+ * Simplified API for quick endpoint documentation
+ */
+export function endpoint(
+  method: string,
+  path: string,
+  options?: EndpointOptions,
+): Record<string, any>;

package/packages/swagger/src/index.js

@@ -1,12 +1,12 @@
-export { setupSwagger } from "./setup.js";
-
-// Export helper functions for advanced usage
-export {
-  convertZodToOpenAPI,
-  extractBodySchema,
-  getCommonResponses,
-  detectSecurity,
-  createSwaggerDoc,
-  registerSchemas,
-  endpoint,
-} from "./helpers.js";
+export { setupSwagger } from "./setup.js";
+
+// Export helper functions for advanced usage
+export {
+  convertZodToOpenAPI,
+  extractBodySchema,
+  getCommonResponses,
+  detectSecurity,
+  createSwaggerDoc,
+  registerSchemas,
+  endpoint,
+} from "./helpers.js";