Merge pull request #15 from PrabothCharith/development

prabothcharith · web-flow · commit dd52dc72b037 · 2026-01-20T13:44:09.000+05:30
Feature: Package Manager Selection
diff --git a/README.md b/README.md
@@ -65,11 +65,14 @@ You will be guided to select your preferred tools:
 For power users, skip the prompts by passing flags directly:
 
 ```bash
-# Create a full-stack app
-npx nxt-gen-cli my-app --orm prisma --ui shadcn --auth next-auth --react-query --pnpm
+# Create a full-stack app with pnpm
+npx nxt-gen-cli my-app --pm pnpm --orm prisma --ui shadcn --auth next-auth --react-query
 
-# Create a minimal API service
-npx nxt-gen-cli api-service --orm drizzle --docker --ci
+# Create a minimal API service with yarn
+npx nxt-gen-cli api-service --pm yarn --orm drizzle --docker --ci
+
+# Create a project with bun
+npx nxt-gen-cli my-bun-app --pm bun --ui shadcn --react-query
 ```
 
 ## Features
@@ -119,6 +122,7 @@ Arguments:
   name                    Project name (prompted if not provided)
 
 Options:
+  --pm <type>             Package Manager: npm, pnpm, yarn, bun
   --orm <type>            ORM: prisma, drizzle, none
   --auth <type>           Auth Provider: next-auth, clerk, none
   --ui <type>             UI Library: shadcn, heroui, both, none
diff --git a/bin/nxt-gen-cli b/bin/nxt-gen-cli
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "nxt-gen-cli",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "The ultimate Next.js scaffold CLI generator. Customize your stack with Prisma, React Query, Shadcn, HeroUI, and more in seconds.",
   "main": "dist/index.js",
   "type": "module",
diff --git a/src/index.ts b/src/index.ts
@@ -8,6 +8,7 @@ import updateNotifier from "update-notifier";
 import { createRequire } from "module";
 import { initialPrompt } from "./prompts.js";
 import { validateProjectName } from "./lib/validation.js";
+import { PACKAGE_MANAGERS, PackageManager } from "./lib/pm.js";
 
 const require = createRequire(import.meta.url);
 const pkg = require("../package.json");
@@ -97,6 +98,7 @@ export async function main() {
     .description("Create Next.js Project with Custom Features")
     .version(pkg.version)
     .argument("[name]", "Project name")
+    .option("--pm <type>", "Package Manager (npm, pnpm, yarn, bun)")
     .option("--orm <type>", "ORM (prisma, drizzle, none)")
     .option("--react-query [boolean]", "Install React Query")
     .option("--axios [boolean]", "Install Axios")
@@ -142,6 +144,33 @@ export async function main() {
         process.exit(1);
       }
 
+      // Normalize and validate pm option
+      if (options.pm !== undefined && options.pm !== null) {
+        const rawPm = options.pm;
+        const normalizedPm =
+          typeof rawPm === "string" ? rawPm.trim() : rawPm;
+
+        if (normalizedPm === "") {
+          console.log(
+            chalk.red(
+              `Package manager value cannot be empty. Must be one of: ${PACKAGE_MANAGERS.join(", ")}`
+            )
+          );
+          process.exit(1);
+        }
+
+        if (!PACKAGE_MANAGERS.includes(normalizedPm as PackageManager)) {
+          console.log(
+            chalk.red(
+              `Invalid package manager: ${normalizedPm}. Must be one of: ${PACKAGE_MANAGERS.join(", ")}`
+            )
+          );
+          process.exit(1);
+        }
+        options.packageManager = normalizedPm as PackageManager;
+        delete options.pm;
+      }
+
       const config = await initialPrompt(options);
       console.log(chalk.blue("Selected Configuration:"), config);
 
diff --git a/src/lib/pm.ts b/src/lib/pm.ts
@@ -1,5 +1,7 @@
 export type PackageManager = "npm" | "pnpm" | "yarn" | "bun";
 
+export const PACKAGE_MANAGERS: readonly PackageManager[] = ["npm", "pnpm", "yarn", "bun"];
+
 export function detectPackageManager(): PackageManager {
   const userAgent = process.env.npm_config_user_agent;
   if (!userAgent) return "npm";
diff --git a/src/prompts.ts b/src/prompts.ts
@@ -1,6 +1,8 @@
 import prompts from "prompts";
+import { PackageManager, PACKAGE_MANAGERS } from "./lib/pm.js";
 
 export interface ProjectConfig {
+  packageManager?: PackageManager;
   orm: "prisma" | "drizzle" | "none";
   reactQuery: boolean;
   axios: boolean;
@@ -59,6 +61,13 @@ export async function initialPrompt(
 
   const response = await prompts(
     [
+      {
+        type: options.packageManager !== undefined ? null : "select",
+        name: "packageManager",
+        message: "Which package manager would you like to use?",
+        choices: PACKAGE_MANAGERS.map(pm => ({ title: pm, value: pm })),
+        initial: 0,
+      },
       {
         type: options.orm !== undefined ? null : "select",
         name: "orm",
diff --git a/src/scaffold.ts b/src/scaffold.ts
@@ -68,7 +68,8 @@ export const scaffoldProject = async (
   config: ProjectConfig
 ) => {
   const projectPath = path.resolve(process.cwd(), projectName);
-  const pm = detectPackageManager();
+  // Use the package manager from config, or auto-detect as fallback
+  const pm = config.packageManager || detectPackageManager();
   const deps = new DependencyCollector();
 
   // Check if directory already exists
diff --git a/test/fixtures/README.md b/test/fixtures/README.md
@@ -0,0 +1,9 @@
+# Test Fixtures
+
+This directory contains test fixture files used by the test suite.
+
+## package-managers.json
+
+Contains the list of supported package managers for testing purposes. This file should be kept in sync with the `PACKAGE_MANAGERS` constant in `src/lib/pm.ts`.
+
+**Note**: This file is used as a fallback when the compiled `dist/lib/pm.js` is not available. The test suite includes an automatic validation check (Test 5) that will fail if this file becomes out of sync with the source code, ensuring you'll be notified if an update is needed.
diff --git a/test/fixtures/package-managers.json b/test/fixtures/package-managers.json
@@ -0,0 +1,6 @@
+[
+  "npm",
+  "pnpm",
+  "yarn",
+  "bun"
+]
diff --git a/test/pm-test.mjs b/test/pm-test.mjs
@@ -0,0 +1,148 @@
+#!/usr/bin/env node
+
+/**
+ * Test package manager selection functionality
+ */
+
+import { execSync } from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Import PACKAGE_MANAGERS constant from compiled pm.js or fallback to test fixtures
+let PACKAGE_MANAGERS;
+try {
+  const pmModule = await import('../dist/lib/pm.js');
+  PACKAGE_MANAGERS = pmModule.PACKAGE_MANAGERS;
+} catch {
+  // Fallback: load from test fixtures file
+  try {
+    const fixturesPath = path.join(__dirname, 'fixtures', 'package-managers.json');
+    PACKAGE_MANAGERS = JSON.parse(fs.readFileSync(fixturesPath, 'utf-8'));
+  } catch (error) {
+    console.error('  ✗ Could not load PACKAGE_MANAGERS constant');
+    console.error(`  Error: ${error.message}`);
+    console.error('  Please run "npm run build" or check test/fixtures/package-managers.json');
+    process.exit(1);
+  }
+}
+
+console.log('='.repeat(60));
+console.log('Package Manager Selection Test');
+console.log('='.repeat(60));
+
+// Test 1: Check if --pm flag is recognized
+console.log('\n✓ Test 1: CLI accepts --pm flag');
+try {
+  const cliPath = path.join(__dirname, '..', 'bin', 'nxt-gen-cli');
+  const output = execSync(`node ${cliPath} --help`, {
+    cwd: path.join(__dirname, '..'),
+    encoding: 'utf-8'
+  });
+  
+  if (output.includes('--pm <type>') && output.includes('Package Manager')) {
+    console.log('  ✓ --pm flag is documented in help');
+  } else {
+    console.error('  ✗ --pm flag not found in help output');
+    process.exit(1);
+  }
+} catch (error) {
+  console.error('  ✗ Failed to check help output');
+  process.exit(1);
+}
+
+// Test 2: Validate package manager types
+console.log('\n✓ Test 2: Package Manager Types');
+console.log(`  ✓ Supported package managers: ${PACKAGE_MANAGERS.join(', ')}`);
+
+// Test 3: Check dist files for package manager support
+console.log('\n✓ Test 3: Code Implementation');
+try {
+  const distPromptsPath = path.join(__dirname, '..', 'dist', 'prompts.js');
+  if (fs.existsSync(distPromptsPath)) {
+    const distPrompts = fs.readFileSync(distPromptsPath, 'utf-8');
+    if (distPrompts.toLowerCase().includes('packagemanager')) {
+      console.log('  ✓ Package manager implementation found in prompts.js');
+    } else {
+      console.log('  ⚠ Package manager implementation not found in dist files');
+    }
+  } else {
+    console.log('  ℹ Note: dist/prompts.js not found - build may be needed');
+  }
+} catch (error) {
+  console.log('  ℹ Note: Could not check dist files');
+}
+
+// Test 4: Verify pm.ts has all package managers
+console.log('\n✓ Test 4: Package Manager Module');
+try {
+  const pmPath = path.join(__dirname, '..', 'src', 'lib', 'pm.ts');
+  const pmContent = fs.readFileSync(pmPath, 'utf-8');
+  
+  const hasAllPMs = PACKAGE_MANAGERS.every(pm => pmContent.includes(pm));
+  if (hasAllPMs) {
+    console.log('  ✓ All package managers supported in pm.ts');
+  } else {
+    console.error('  ✗ Some package managers missing in pm.ts');
+    process.exit(1);
+  }
+} catch (error) {
+  console.error('  ✗ Failed to read pm.ts');
+  process.exit(1);
+}
+
+// Test 5: Validate fixtures are in sync with source
+console.log('\n✓ Test 5: Fixtures Validation');
+try {
+  const fixturesPath = path.join(__dirname, 'fixtures', 'package-managers.json');
+  const fixturesData = JSON.parse(fs.readFileSync(fixturesPath, 'utf-8'));
+  
+  const pmPath = path.join(__dirname, '..', 'src', 'lib', 'pm.ts');
+  const pmContent = fs.readFileSync(pmPath, 'utf-8');
+  
+  // Extract PACKAGE_MANAGERS values from source for comparison
+  // Note: This is a simple regex-based check for a constant array of string literals.
+  // It's sufficient for validating sync but not a full TypeScript parser.
+  const match = pmContent.match(/export const PACKAGE_MANAGERS[^=]*=\s*\[(.*?)\]/s);
+  if (!match) {
+    console.error('  ✗ Could not parse PACKAGE_MANAGERS from source');
+    process.exit(1);
+  }
+  
+  // Parse array values, handling both single and double quotes
+  const sourceValues = match[1]
+    .split(',')
+    .map(v => v.trim())
+    .filter(v => v)
+    .map(v => v.replace(/^['"]|['"]$/g, ''));
+  
+  // Ensure both are arrays of strings before comparing
+  if (!Array.isArray(fixturesData) || !fixturesData.every(v => typeof v === 'string')) {
+    console.error('  ✗ Fixtures must be an array of strings');
+    process.exit(1);
+  }
+  
+  const fixturesMatch = JSON.stringify(fixturesData.sort()) === JSON.stringify(sourceValues.sort());
+  if (fixturesMatch) {
+    console.log('  ✓ Fixtures file is in sync with source');
+  } else {
+    console.error('  ✗ Fixtures file is out of sync with source');
+    console.error(`  Source: [${sourceValues.join(', ')}]`);
+    console.error(`  Fixtures: [${fixturesData.join(', ')}]`);
+    process.exit(1);
+  }
+} catch (error) {
+  console.error('  ✗ Failed to validate fixtures');
+  console.error(`  Error: ${error.message}`);
+  process.exit(1);
+}
+
+console.log('\n' + '='.repeat(60));
+console.log('✓ All package manager tests passed!');
+console.log('='.repeat(60));
+console.log('\nPackage manager selection can be used in two ways:');
+console.log('  1. CLI flag: npx nxt-gen-cli my-app --pm pnpm');
+console.log('  2. Interactive prompt: Select during project setup');
+console.log('\n');

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "nxt-gen-cli",`
`3`		`- "version": "2.1.3",`
	`3`	`+ "version": "2.1.4",`
`4`	`4`	`"description": "The ultimate Next.js scaffold CLI generator. Customize your stack with Prisma, React Query, Shadcn, HeroUI, and more in seconds.",`
`5`	`5`	`"main": "dist/index.js",`
`6`	`6`	`"type": "module",`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +[
 +  "npm",
 +  "pnpm",
 +  "yarn",
 +  "bun"
 +]