create-pnpm-custom-app 1.0.2 → 1.0.4

package/README.md

@@ -19,6 +19,8 @@
 
 ### Recommended: Use npx (always latest version)
 
+[![npm version](https://img.shields.io/npm/v/create-pnpm-custom-app.svg)](https://www.npmjs.com/package/create-pnpm-custom-app)
+
 ```bash
 npx create-pnpm-custom-app@latest my-project
 ```
@@ -104,7 +106,7 @@ my-project/
    ```bash
    # Frontend
    cp apps/web/.env.example apps/web/.env.local
-   
+
    # Backend
    cp apps/api/.env.example apps/api/.env
    ```
@@ -118,7 +120,7 @@ my-project/
    ```bash
    # Terminal 1: Frontend (http://localhost:3000)
    pnpm --filter web dev
-   
+
    # Terminal 2: Backend (http://localhost:3002)
    pnpm --filter api dev
    ```
@@ -160,14 +162,14 @@ pnpm --filter api lint          # Lint code
 
 ## Tech Stack
 
-| Category | Technologies |
-| ---------- | ------------- |
+| Category     | Technologies                                                |
+| ------------ | ----------------------------------------------------------- |
 | **Frontend** | Next.js 16, React 19, TypeScript, Tailwind CSS 4, next-intl |
-| **Backend** | Fastify 5, TypeScript, MongoDB, Mongoose, Pino |
-| **Auth** | @fastify/jwt, bcrypt |
-| **Testing** | Jest, Supertest |
-| **Tooling** | pnpm, ESLint, Prettier, TypeScript |
-| **Docs** | Swagger/OpenAPI, JSDoc |
+| **Backend**  | Fastify 5, TypeScript, MongoDB, Mongoose, Pino              |
+| **Auth**     | @fastify/jwt, bcrypt                                        |
+| **Testing**  | Jest, Supertest                                             |
+| **Tooling**  | pnpm, ESLint, Prettier, TypeScript                          |
+| **Docs**     | Swagger/OpenAPI, JSDoc                                      |
 
 ## Requirements
 

package/bin/cli.js

@@ -1,13 +1,13 @@
 #!/usr/bin/env node
 
-import { Command } from 'commander';
-import prompts from 'prompts';
-import chalk from 'chalk';
-import ora from 'ora';
-import fs from 'fs-extra';
-import path from 'path';
-import { fileURLToPath } from 'url';
-import { execSync } from 'child_process';
+import { Command } from "commander";
+import prompts from "prompts";
+import chalk from "chalk";
+import ora from "ora";
+import fs from "fs-extra";
+import path from "path";
+import { fileURLToPath } from "url";
+import { execSync } from "child_process";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
@@ -15,31 +15,34 @@ const __dirname = path.dirname(__filename);
 const program = new Command();
 
 program
-  .name('create-pnpm-custom-app')
-  .description('Scaffold a professional full-stack monorepo with Next.js, Fastify, and pnpm workspaces')
-  .version('1.0.0')
-  .argument('[project-name]', 'Name of the project')
+  .name("create-pnpm-custom-app")
+  .description(
+    "Scaffold a professional full-stack monorepo with Next.js, Fastify, and pnpm workspaces",
+  )
+  .version("1.0.0")
+  .argument("[project-name]", "Name of the project")
   .parse(process.argv);
 
 const args = program.args;
 
 async function main() {
-  console.log(chalk.bold.cyan('\n🚀 Create PNPM Custom App\n'));
+  console.log(chalk.bold.cyan("\n🚀 Create PNPM Custom App\n"));
 
   let projectName = args[0];
-  let githubUser = '';
+  let githubUser = "";
 
   if (!projectName) {
     const response = await prompts({
-      type: 'text',
-      name: 'projectName',
-      message: 'What is your project name?',
-      initial: 'my-app',
-      validate: (value) => (value.length > 0 ? true : 'Project name is required'),
+      type: "text",
+      name: "projectName",
+      message: "What is your project name?",
+      initial: "my-app",
+      validate: (value) =>
+        value.length > 0 ? true : "Project name is required",
     });
 
     if (!response.projectName) {
-      console.log(chalk.red('\n❌ Project creation cancelled.'));
+      console.log(chalk.red("\n❌ Project creation cancelled."));
       process.exit(1);
     }
 
@@ -48,9 +51,10 @@ async function main() {
 
   // Ask for GitHub username
   const githubResponse = await prompts({
-    type: 'text',
-    name: 'githubUser',
-    message: 'What is your GitHub username? (optional, used only for repository links)',
+    type: "text",
+    name: "githubUser",
+    message:
+      "What is your GitHub username? (optional, used only for repository links)",
     initial: projectName,
     validate: (value) => true, // Optional field
   });
@@ -66,43 +70,49 @@ async function main() {
 
   console.log(chalk.gray(`\n📁 Creating project at: ${projectPath}\n`));
 
-  const spinner = ora('Creating project structure...').start();
+  const spinner = ora("Creating project structure...").start();
 
   try {
     // Create project directory
     fs.mkdirSync(projectPath, { recursive: true });
 
     // Copy all templates
-    const templatesDir = path.join(__dirname, '../templates');
+    const templatesDir = path.join(__dirname, "../templates");
     fs.copySync(templatesDir, projectPath);
 
     // Rename gitignore files (npm publish removes .gitignore)
-    const gitignoreRootPath = path.join(projectPath, 'gitignore-root');
+    const gitignoreRootPath = path.join(projectPath, "gitignore-root");
     if (fs.existsSync(gitignoreRootPath)) {
-      fs.renameSync(gitignoreRootPath, path.join(projectPath, '.gitignore'));
+      fs.renameSync(gitignoreRootPath, path.join(projectPath, ".gitignore"));
     }
 
-    const webGitignorePath = path.join(projectPath, 'apps/web/gitignore');
+    const webGitignorePath = path.join(projectPath, "apps/web/gitignore");
     if (fs.existsSync(webGitignorePath)) {
-      fs.renameSync(webGitignorePath, path.join(projectPath, 'apps/web/.gitignore'));
+      fs.renameSync(
+        webGitignorePath,
+        path.join(projectPath, "apps/web/.gitignore"),
+      );
     }
 
-    const apiGitignorePath = path.join(projectPath, 'apps/api/gitignore');
+    const apiGitignorePath = path.join(projectPath, "apps/api/gitignore");
     if (fs.existsSync(apiGitignorePath)) {
-      fs.renameSync(apiGitignorePath, path.join(projectPath, 'apps/api/.gitignore'));
+      fs.renameSync(
+        apiGitignorePath,
+        path.join(projectPath, "apps/api/.gitignore"),
+      );
     }
 
     // Replace project name in package.json files
     const packageJsonPaths = [
-      path.join(projectPath, 'package.json'),
-      path.join(projectPath, 'apps/web/package.json'),
-      path.join(projectPath, 'apps/api/package.json'),
-      path.join(projectPath, 'packages/shared/package.json'),
+      path.join(projectPath, "package.json"),
+      path.join(projectPath, "apps/web/package.json"),
+      path.join(projectPath, "apps/api/package.json"),
+      path.join(projectPath, "packages/shared/package.json"),
     ];
 
     packageJsonPaths.forEach((pkgPath) => {
       if (fs.existsSync(pkgPath)) {
-        const content = fs.readFileSync(pkgPath, 'utf-8');
+        const content = fs.readFileSync(pkgPath, "utf-8");
         const updated = content.replace(/\{\{PROJECT_NAME\}\}/g, projectName);
         fs.writeFileSync(pkgPath, updated);
       }
@@ -110,76 +120,97 @@ async function main() {
 
     // Replace project name in all other files (tsx, ts, md, json, etc.)
     const filesToReplace = [
-      path.join(projectPath, 'README.md'),
-      path.join(projectPath, 'CONTRIBUTING.md'),
-      path.join(projectPath, 'apps/web/app/layout.tsx'),
-      path.join(projectPath, 'apps/web/app/manifest.json'),
-      path.join(projectPath, 'apps/web/app/components/layout/Nav.component.tsx'),
-      path.join(projectPath, 'apps/web/app/components/layout/Footer.component.tsx'),
-      path.join(projectPath, 'apps/web/app/[locale]/(routes)/page.tsx'),
-      path.join(projectPath, 'apps/web/app/opengraph-image.tsx'),
-      path.join(projectPath, 'apps/web/app/twitter-image.tsx'),
-      path.join(projectPath, 'apps/web/app/apple-icon.tsx'),
-      path.join(projectPath, 'apps/web/app/icon.tsx'),
-      path.join(projectPath, 'apps/web/messages/en.json'),
-      path.join(projectPath, 'apps/web/messages/es.json'),
-      path.join(projectPath, 'apps/api/src/app.ts'),
-      path.join(projectPath, 'packages/shared/src/index.ts'),
-      path.join(projectPath, '.github/copilot-instructions.md'),
+      path.join(projectPath, "README.md"),
+      path.join(projectPath, "CONTRIBUTING.md"),
+      path.join(projectPath, "apps/web/app/layout.tsx"),
+      path.join(projectPath, "apps/web/app/manifest.json"),
+      path.join(
+        projectPath,
+        "apps/web/app/components/layout/Nav.component.tsx",
+      ),
+      path.join(
+        projectPath,
+        "apps/web/app/components/layout/Footer.component.tsx",
+      ),
+      path.join(projectPath, "apps/web/app/[locale]/(routes)/page.tsx"),
+      path.join(projectPath, "apps/web/app/opengraph-image.tsx"),
+      path.join(projectPath, "apps/web/app/twitter-image.tsx"),
+      path.join(projectPath, "apps/web/app/apple-icon.tsx"),
+      path.join(projectPath, "apps/web/app/icon.tsx"),
+      path.join(projectPath, "apps/web/messages/en.json"),
+      path.join(projectPath, "apps/web/messages/es.json"),
+      path.join(projectPath, "apps/api/src/app.ts"),
+      path.join(projectPath, "packages/shared/src/index.ts"),
+      path.join(projectPath, ".github/copilot-instructions.md"),
     ];
 
     filesToReplace.forEach((filePath) => {
       if (fs.existsSync(filePath)) {
-        let content = fs.readFileSync(filePath, 'utf-8');
+        let content = fs.readFileSync(filePath, "utf-8");
         content = content.replace(/\{\{PROJECT_NAME\}\}/g, projectName);
         content = content.replace(/\{\{GITHUB_USER\}\}/g, githubUser);
         fs.writeFileSync(filePath, content);
       }
     });
 
-    spinner.succeed(chalk.green('Project structure created!'));
+    spinner.succeed(chalk.green("Project structure created!"));
 
     // Install dependencies
-    spinner.start('Installing dependencies with pnpm... This may take a few minutes.');
-    
+    spinner.start(
+      "Installing dependencies with pnpm... This may take a few minutes.",
+    );
+
     try {
-      execSync('pnpm install', { cwd: projectPath, stdio: 'ignore' });
-      spinner.succeed(chalk.green('Dependencies installed successfully!'));
+      execSync("pnpm install", { cwd: projectPath, stdio: "ignore" });
+      spinner.succeed(chalk.green("Dependencies installed successfully!"));
     } catch (error) {
-      spinner.warn(chalk.yellow('Could not install dependencies automatically.'));
-      console.log(chalk.gray('  Run `pnpm install` manually inside the project.'));
+      spinner.warn(
+        chalk.yellow("Could not install dependencies automatically."),
+      );
+      console.log(
+        chalk.gray("  Run `pnpm install` manually inside the project."),
+      );
     }
 
     // Success message
-    console.log(chalk.bold.green(`\n✅ Project "${projectName}" created successfully!\n`));
-    console.log(chalk.cyan('📦 Project structure:'));
-    console.log(chalk.gray('  ├── apps/'));
-    console.log(chalk.gray('  │   ├── web/        (Next.js 16 + TypeScript + Tailwind 4)'));
-    console.log(chalk.gray('  │   └── api/        (Fastify + MongoDB + TypeScript)'));
-    console.log(chalk.gray('  ├── packages/'));
-    console.log(chalk.gray('  │   └── shared/     (Shared types and interfaces)'));
-    console.log(chalk.gray('  └── docs/           (Project documentation)\n'));
-
-    console.log(chalk.cyan('🚀 Next steps:'));
+    console.log(
+      chalk.bold.green(`\n✅ Project "${projectName}" created successfully!\n`),
+    );
+    console.log(chalk.cyan("📦 Project structure:"));
+    console.log(chalk.gray("  ├── apps/"));
+    console.log(
+      chalk.gray(
+        "  │   ├── web/        (Next.js 16 + TypeScript + Tailwind 4)",
+      ),
+    );
+    console.log(
+      chalk.gray("  │   └── api/        (Fastify + MongoDB + TypeScript)"),
+    );
+    console.log(chalk.gray("  ├── packages/"));
+    console.log(
+      chalk.gray("  │   └── shared/     (Shared types and interfaces)"),
+    );
+    console.log(chalk.gray("  └── docs/           (Project documentation)\n"));
+
+    console.log(chalk.cyan("🚀 Next steps:"));
     console.log(chalk.white(`  1. cd ${projectName}`));
-    console.log(chalk.white('  2. Copy .env.example files and configure:'));
-    console.log(chalk.gray('     - apps/web/.env.local'));
-    console.log(chalk.gray('     - apps/api/.env'));
-    console.log(chalk.white('  3. Start development:'));
-    console.log(chalk.gray('     - Frontend: pnpm --filter web dev'));
-    console.log(chalk.gray('     - Backend:  pnpm --filter api dev'));
-    console.log(chalk.white('  4. Read the README.md for more information\n'));
-
-    console.log(chalk.bold.magenta('Happy coding! 🎉\n'));
-
+    console.log(chalk.white("  2. Copy .env.example files and configure:"));
+    console.log(chalk.gray("     - apps/web/.env.local"));
+    console.log(chalk.gray("     - apps/api/.env"));
+    console.log(chalk.white("  3. Start development:"));
+    console.log(chalk.gray("     - Frontend: pnpm --filter web dev"));
+    console.log(chalk.gray("     - Backend:  pnpm --filter api dev"));
+    console.log(chalk.white("  4. Read the README.md for more information\n"));
+
+    console.log(chalk.bold.magenta("Happy coding! 🎉\n"));
   } catch (error) {
-    spinner.fail(chalk.red('Failed to create project'));
+    spinner.fail(chalk.red("Failed to create project"));
     console.error(error);
     process.exit(1);
   }
 }
 
 main().catch((error) => {
-  console.error(chalk.red('An error occurred:'), error);
+  console.error(chalk.red("An error occurred:"), error);
   process.exit(1);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-pnpm-custom-app",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A professional CLI to scaffold full-stack monorepo projects with Next.js, Fastify, and pnpm workspaces",
   "type": "module",
   "bin": {
@@ -26,12 +26,20 @@
     "node": ">=20.0.0"
   },
   "dependencies": {
-    "chalk": "^5.3.0",
-    "commander": "^12.1.0",
-    "fs-extra": "^11.2.0",
-    "ora": "^8.1.1",
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "fs-extra": "^11.3.3",
+    "ora": "^9.1.0",
     "prompts": "^2.4.2"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pelayotrives/create-pnpm-custom-app"
+  },
+  "homepage": "https://github.com/pelayotrives/create-pnpm-custom-app#readme",
+  "bugs": {
+    "url": "https://github.com/pelayotrives/create-pnpm-custom-app/issues"
+  },
   "files": [
     "bin",
     "templates"

package/templates/.github/copilot-instructions.md

@@ -5,6 +5,7 @@
 [Brief description of your project]
 
 **Tech Stack:**
+
 - **Frontend**: Next.js 16+ (App Router), React 19+, TypeScript
 - **Backend**: Fastify API with MongoDB
 - **Monorepo**: pnpm workspace (apps/web, apps/api, packages/shared)

package/templates/CONTRIBUTING.md

@@ -77,7 +77,7 @@ pnpm --filter api test:watch
 
 We follow [Conventional Commits](https://www.conventionalcommits.org/):
 
-```
+```txt
 <type>(<scope>): <subject>
 
 <body>
@@ -108,11 +108,13 @@ docs(readme): update installation instructions
 1. **Update documentation** - Update README.md if needed
 2. **Add tests** - Ensure new features have test coverage
 3. **Run quality checks**:
+
    ```bash
    pnpm run lint
    pnpm run build
    pnpm run test
    ```
+
 4. **Create pull request** - Use a clear title and description
 5. **Link issues** - Reference related issues in the PR description
 6. **Wait for review** - Address feedback from maintainers
@@ -121,18 +123,22 @@ docs(readme): update installation instructions
 
 ```markdown
 ## Description
+
 Brief description of changes
 
 ## Type of Change
+
 - [ ] Bug fix
 - [ ] New feature
 - [ ] Breaking change
 - [ ] Documentation update
 
 ## Testing
+
 Describe the tests you ran
 
 ## Checklist
+
 - [ ] Code follows project style guidelines
 - [ ] Self-review completed
 - [ ] Comments added for complex code
@@ -177,6 +183,7 @@ Describe the tests you ran
 ## Questions?
 
 If you have questions, please:
+
 1. Check existing documentation
 2. Search existing issues
 3. Create a new issue with the `question` label

package/templates/README.md

@@ -281,10 +281,10 @@ pnpm --filter api test:coverage # With coverage
 Example test structure:
 
 ```typescript
-import { describe, it, expect } from '@jest/globals';
+import { describe, it, expect } from "@jest/globals";
 
-describe('Feature Name', () => {
-  it('should do something', () => {
+describe("Feature Name", () => {
+  it("should do something", () => {
     expect(true).toBe(true);
   });
 });

package/templates/apps/api/package.json

@@ -13,35 +13,35 @@
     "lint": "eslint src --ext .ts"
   },
   "dependencies": {
-    "@fastify/cors": "^10.0.1",
-    "@fastify/jwt": "^9.0.1",
-    "@fastify/multipart": "^9.0.1",
-    "@fastify/rate-limit": "^10.1.1",
-    "@fastify/swagger": "^9.3.0",
-    "@fastify/swagger-ui": "^5.0.1",
+    "@fastify/cors": "^11.2.0",
+    "@fastify/jwt": "^10.0.0",
+    "@fastify/multipart": "^9.4.0",
+    "@fastify/rate-limit": "^10.3.0",
+    "@fastify/swagger": "^9.6.1",
+    "@fastify/swagger-ui": "^5.2.4",
     "@{{PROJECT_NAME}}/shared": "workspace:*",
-    "bcrypt": "^5.1.1",
-    "dotenv": "^16.4.7",
-    "fastify": "^5.2.0",
-    "mongoose": "^8.9.3",
-    "pino": "^9.5.0",
-    "pino-pretty": "^13.0.0"
+    "bcrypt": "^6.0.0",
+    "dotenv": "^17.2.3",
+    "fastify": "^5.7.2",
+    "mongoose": "^9.1.5",
+    "pino": "^10.3.0",
+    "pino-pretty": "^13.1.3"
   },
   "devDependencies": {
-    "@eslint/js": "^9.18.0",
-    "@jest/globals": "^29.7.0",
-    "@types/bcrypt": "^5.0.2",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.10.5",
-    "@types/supertest": "^6.0.2",
-    "eslint": "^9.18.0",
-    "jest": "^29.7.0",
-    "supertest": "^7.0.0",
-    "ts-jest": "^29.2.5",
+    "@eslint/js": "^9.39.2",
+    "@jest/globals": "^30.2.0",
+    "@types/bcrypt": "^6.0.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.19.7",
+    "@types/supertest": "^6.0.3",
+    "eslint": "^9.39.2",
+    "jest": "^30.2.0",
+    "supertest": "^7.2.2",
+    "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
-    "tsx": "^4.19.2",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.21.0"
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0"
   },
   "engines": {
     "node": ">=20.0.0"

package/templates/apps/api/src/app.ts

@@ -30,7 +30,7 @@ function registerJWT(app: FastifyInstance) {
       'JWT_SECRET is not defined. Please copy apps/api/.env.example to apps/api/.env and set JWT_SECRET'
     );
   }
-  
+
   app.register(jwt, {
     secret: config.jwtSecret,
     sign: {
@@ -46,7 +46,7 @@ function registerRateLimit(app: FastifyInstance) {
   if (config.env === 'test') {
     return;
   }
-  
+
   app.register(rateLimit, {
     global: false,
   });
@@ -70,9 +70,7 @@ async function registerSwagger(app: FastifyInstance) {
           description: 'Development server',
         },
       ],
-      tags: [
-        { name: 'Health', description: 'Health check endpoints' },
-      ],
+      tags: [{ name: 'Health', description: 'Health check endpoints' }],
     },
   });
 
@@ -99,7 +97,7 @@ function registerMultipart(app: FastifyInstance) {
 
 /**
  * Builds and configures the Fastify application
- * 
+ *
  * @returns Configured Fastify instance
  */
 export async function buildApp(): Promise<FastifyInstance> {

package/templates/apps/api/src/config/config.ts

@@ -15,12 +15,12 @@ const env = process.env.NODE_ENV ?? 'development';
 
 /**
  * Application configuration loaded from environment variables
- * 
+ *
  * @remarks
  * Required environment variables:
  * - MONGODB_URI: MongoDB connection string
  * - JWT_SECRET: Secret for JWT token signing
- * 
+ *
  * Optional environment variables:
  * - PORT: Server port (default: 3002)
  * - CORS_ORIGIN: Allowed CORS origin (default: *)

package/templates/apps/api/src/config/logger.ts

@@ -3,9 +3,9 @@ import pino from 'pino';
 
 /**
  * Returns logger configuration based on environment
- * 
+ *
  * @returns Logger config or false to disable logging in test
- * 
+ *
  * @remarks
  * - Test/E2E: Logging disabled
  * - Production: Structured JSON logs at 'info' level
@@ -46,7 +46,7 @@ export function getLoggerConfig(): false | object {
 
 /**
  * Application-wide logger instance using Pino
- * 
+ *
  * @example
  * ```typescript
  * logger.info({ userId: '123' }, 'User logged in');

package/templates/apps/api/src/db/mongo.ts

@@ -2,11 +2,11 @@ import mongoose from 'mongoose';
 
 /**
  * Establishes connection to MongoDB
- * 
+ *
  * @param uri - MongoDB connection URI
  * @returns Mongoose connection object
  * @throws Error if connection fails
- * 
+ *
  * @example
  * ```typescript
  * await connectMongo('mongodb://localhost:27017/mydb');
@@ -20,7 +20,7 @@ export async function connectMongo(uri: string) {
 
 /**
  * Disconnects from MongoDB
- * 
+ *
  * @remarks
  * Call this when shutting down the application or when database
  * connection is no longer needed.

package/templates/apps/api/src/index.ts

@@ -4,14 +4,14 @@ import config from './config/config.js';
 
 /**
  * Starts the API server
- * 
+ *
  * - Connects to MongoDB
  * - Starts the Fastify server on configured port
  * - Logs server URL when ready
  */
 async function start() {
   const app = await buildApp();
-  
+
   try {
     if (!config.mongoUri) {
       app.log.error(