feat: add ability to select between pnpm and npm, when we create apdminforth app

yaroslav8765 · yaroslav8765 · commit bdf27219e0c9 · 2026-03-10T16:17:49.000+02:00
https://web.tracklify.com/project/2b7ZVgE5/AdminForth/1316/EzZFZwip/cli-switch-to-use-pnpmnpm-pnpm
diff --git a/adminforth/commands/createApp/templates/Dockerfile.hbs b/adminforth/commands/createApp/templates/Dockerfile.hbs
@@ -1,7 +1,19 @@
+
+{{#unless useNpm}}
 FROM devforth/node20-pnpm:latest
 WORKDIR /code/
 ADD package.json pnpm-lock.yaml pnpm-workspace.yaml /code/
 RUN pnpm i  
 ADD . /code/
 RUN pnpm exec adminforth bundle
 CMD ["sh", "-c", "pnpm migrate:prod && pnpm prod"]
+{{/unless}}
+{{#if useNpm}}
+FROM node:{{nodeMajor}}-slim
+WORKDIR /code/
+ADD package.json package-lock.json /code/
+RUN npm ci  
+ADD . /code/
+RUN npx adminforth bundle
+CMD ["sh", "-c", "npm run migrate:prod && npm run prod"]
+{{/if}}
diff --git a/adminforth/commands/createApp/templates/custom/package.json.hbs b/adminforth/commands/createApp/templates/custom/package.json.hbs
@@ -0,0 +1,12 @@
+{
+  "name": "custom",
+  "version": "1.0.0",
+  "main": "index.ts",
+  "scripts": {
+      "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": ""
+}
diff --git a/adminforth/commands/createApp/templates/package.json.hbs b/adminforth/commands/createApp/templates/package.json.hbs
@@ -8,6 +8,7 @@
   "license": "ISC",
   "description": "",
   "scripts": {
+    {{#unless useNpm}}
     "dev": "pnpm _env:dev tsx watch index.ts",
     "prod": "pnpm _env:prod tsx index.ts",
     "start": "pnpm dev",
@@ -16,6 +17,17 @@
     "migrate:prod": "pnpm _env:prod npx --yes prisma migrate deploy",
     "_env:dev": "dotenvx run -f .env -f .env.local --",
     "_env:prod": "dotenvx run -f .env.prod --"
+    {{/unless}}
+    {{#if useNpm}}
+      "dev": "npm run _env:dev -- tsx watch index.ts",
+      "prod": "npm run _env:prod -- tsx index.ts",
+      "start": "npm run dev",
+      "makemigration": "npm run _env:dev -- npx --yes prisma migrate dev --create-only",
+      "migrate:local": "npm run _env:dev -- npx --yes prisma migrate deploy",
+      "migrate:prod": "npm run _env:prod -- npx --yes prisma migrate deploy",
+      "_env:dev": "dotenvx run -f .env -f .env.local --",
+      "_env:prod": "dotenvx run -f .env.prod --"
+    {{/if}}
   },
   "engines": {
     "node": ">=20"
diff --git a/adminforth/commands/createApp/templates/pnpm_templates/pnpm-workspace.yaml.hbs b/adminforth/commands/createApp/templates/pnpm_templates/pnpm-workspace.yaml.hbs
diff --git a/adminforth/commands/createApp/templates/readme.md.hbs b/adminforth/commands/createApp/templates/readme.md.hbs
@@ -1,7 +1,25 @@
 ## Starting the application
 
 Install dependencies:
+{{#if useNpm}}
+```bash
+npm i
+```
+
+Migrate the database:
+
+```bash
+npm run migrate:local
+```
+
+Start the server:
+
+```bash
+npm run dev
+```
+{{/if}}
 
+{{#unless useNpm}}
 ```bash
 pnpm i
 ```
@@ -17,6 +35,7 @@ Start the server:
 ```bash
 pnpm dev
 ```
+{{/unless}}
 
 {{#if prismaDbUrl}}
 ## Changing schema
diff --git a/adminforth/commands/createApp/utils.js b/adminforth/commands/createApp/utils.js
@@ -44,6 +44,7 @@ export function parseArgumentsIntoOptions(rawArgs) {
     {
       '--app-name': String,
       '--db': String,
+      '--use-npm': Boolean,
       // you can add more flags here if needed
     },
     {
@@ -54,6 +55,7 @@ export function parseArgumentsIntoOptions(rawArgs) {
   return {
     appName: args['--app-name'],
     db: args['--db'],
+    useNpm: args['--use-npm'],
   };
 }
 
@@ -78,11 +80,21 @@ export async function promptForMissingOptions(options) {
       });
   };
 
+  if (!options.useNpm) {
+    questions.push({
+      type: 'confirm',
+      name: 'useNpm',
+      message: 'Do you want to use npm instead of pnpm?',
+      default: false,
+    });
+  }
+
   const answers = await inquirer.prompt(questions);
   return {
       ...options,
       appName: options.appName || answers.appName,
       db: options.db || answers.db,
+      useNpm: options.useNpm || answers.useNpm,
   };
 }
 
@@ -230,7 +242,7 @@ async function scaffoldProject(ctx, options, cwd) {
   await fse.copy(sourceAssetsDir, targetAssetsDir);
 
   // Write templated files
-  await writeTemplateFiles(dirname, projectDir, {
+  await writeTemplateFiles(dirname, projectDir, options.useNpm, {
     dbUrl: connectionString.toString(),
     dbUrlProd: connectionStringProd,
     prismaDbUrl,
@@ -244,7 +256,7 @@ async function scaffoldProject(ctx, options, cwd) {
   return projectDir;  // Return the new directory path
 }
 
-async function writeTemplateFiles(dirname, cwd, options) {
+async function writeTemplateFiles(dirname, cwd, useNpm, options) {
   const { 
     dbUrl, prismaDbUrl, appName, provider, nodeMajor,
     dbUrlProd, prismaDbUrlProd, sqliteFile
@@ -268,14 +280,6 @@ async function writeTemplateFiles(dirname, cwd, options) {
       dest: 'prisma.config.ts',
       data: {},
     },
-    {
-      src: 'package.json.hbs',
-      dest: 'package.json',
-      data: { 
-        appName,
-        adminforthVersion: adminforthVersion,
-       },
-    },
     {
       src: 'index.ts.hbs',
       dest: 'index.ts',
@@ -304,7 +308,7 @@ async function writeTemplateFiles(dirname, cwd, options) {
     {
       src: 'readme.md.hbs',
       dest: 'README.md',
-      data: { dbUrl, prismaDbUrl, appName, sqliteFile },
+      data: { dbUrl, prismaDbUrl, appName, sqliteFile, useNpm },
     },
     {
       // We'll write .env using the same content as .env.sample
@@ -322,11 +326,6 @@ async function writeTemplateFiles(dirname, cwd, options) {
       dest: 'custom/tsconfig.json',
       data: {},
     },
-    {
-      src: 'Dockerfile.hbs',
-      dest: 'Dockerfile',
-      data: { nodeMajor },
-    },
     {
       src: '.dockerignore.hbs',
       dest: '.dockerignore',
@@ -335,12 +334,39 @@ async function writeTemplateFiles(dirname, cwd, options) {
       },
     },
     {
-      src: 'pnpm-workspace.yaml.hbs',
-      dest: 'pnpm-workspace.yaml',
-      data: {},
-    }
+      src: 'Dockerfile.hbs',
+      dest: 'Dockerfile',
+      data: { nodeMajor, useNpm },
+    },
+    {
+      src: 'package.json.hbs',
+      dest: 'package.json',
+      data: { 
+        appName,
+        adminforthVersion: adminforthVersion,
+        useNpm
+      },
+    },
   ];
 
+  if (!useNpm) {
+    templateTasks.push(
+      {
+        src: 'pnpm_templates/pnpm-workspace.yaml.hbs',
+        dest: 'pnpm-workspace.yaml',
+        data: {},
+      },
+    )
+  } else {
+    templateTasks.push(
+      {
+        src: 'custom/package.json.hbs',
+        dest: 'custom/package.json',
+        data: {}
+      }
+    )
+  }
+
   for (const task of templateTasks) {
     // If a condition is specified and false, skip this file
     if (task.condition === false) continue;
@@ -358,7 +384,7 @@ async function writeTemplateFiles(dirname, cwd, options) {
   }
 }
 
-async function installDependencies(ctx, cwd) {
+async function installDependenciesPnpm(ctx, cwd) {
   const isWindows = process.platform === 'win32';
 
   const nodeBinary = process.execPath; 
@@ -375,10 +401,28 @@ async function installDependencies(ctx, cwd) {
       await execAsync(`${nodeBinary} ${npmPath} install`, { cwd: customDir, env: { PATH: process.env.PATH } }),
     ]);
   }
-  // console.log(chalk.dim(`Dependencies installed in ${cwd} and ${customDir}: \n${res[0].stdout}${res[1].stdout}`));
 }
 
-function generateFinalInstructions(skipPrismaSetup, options) {
+async function installDependenciesNpm(ctx, cwd) {
+  const isWindows = process.platform === 'win32';
+
+  const nodeBinary = process.execPath; 
+  const npmPath = path.join(path.dirname(nodeBinary), isWindows ? 'npm.cmd' : 'npm');
+  const customDir = ctx.customDir;
+  if (isWindows) {
+    const res = await Promise.all([
+      await execAsync(`npm install`, { cwd, env: { PATH: process.env.PATH } }),
+      await execAsync(`npm install`, { cwd: customDir, env: { PATH: process.env.PATH } }),
+    ]);
+  } else {
+    const res = await Promise.all([
+      await execAsync(`${nodeBinary} ${npmPath} install`, { cwd, env: { PATH: process.env.PATH } }),
+      await execAsync(`${nodeBinary} ${npmPath} install`, { cwd: customDir, env: { PATH: process.env.PATH } }),
+    ]);
+  }
+}
+
+function generateFinalInstructionsPnpm(skipPrismaSetup, options) {
   let instruction = '⏭️  Run the following commands to get started:\n';
   if (!skipPrismaSetup)
     instruction += `
@@ -399,6 +443,27 @@ function generateFinalInstructions(skipPrismaSetup, options) {
   return instruction;
 }
 
+function generateFinalInstructionsNpm(skipPrismaSetup, options) {
+  let instruction = '⏭️  Run the following commands to get started:\n';
+  if (!skipPrismaSetup)
+    instruction += `
+  ${chalk.dim('// Go to the project directory')}
+  ${chalk.dim('$')}${chalk.cyan(` cd ${options.appName}`)}\n`;
+
+    instruction += `
+  ${chalk.dim('// Generate and apply initial migration')}
+  ${chalk.dim('$')}${chalk.cyan(' npm run makemigration -- --name init && npm run migrate:local')}\n`;
+
+  instruction += `
+  ${chalk.dim('// Start dev server with tsx watch for hot-reloading')}
+  ${chalk.dim('$')}${chalk.cyan(' npm run dev')}\n
+`;
+
+  instruction += '😉 Happy coding!';
+
+  return instruction;
+}
+
 function renderHBSTemplate(templatePath, data) {
   // Example: renderHBRTemplate('path/to/template.hbs', {name: 'John Doe'})
   const template = fs.readFileSync(templatePath, 'utf-8');
@@ -425,13 +490,23 @@ export function prepareWorkflow(options) {
     },
     {
       title: '📦 Installing dependencies...',
-      task: async (ctx) => installDependencies(ctx, ctx.projectDir)
+      task: async (ctx) => {
+        if (options.useNpm) {
+          await installDependenciesNpm(ctx, ctx.projectDir);
+        } else {
+          await installDependenciesPnpm(ctx, ctx.projectDir);
+        }
+      }
     },
     {
       title: '📝 Preparing final instructions...',
       task: (ctx) => {
         console.log(chalk.green(`✅ Successfully created your new Adminforth project in ${ctx.projectDir}!\n`));
-        console.log(generateFinalInstructions(ctx.skipPrismaSetup, options));
+        if (options.useNpm) {
+          console.log(generateFinalInstructionsNpm(ctx.skipPrismaSetup, options));
+        } else {
+          console.log(generateFinalInstructionsPnpm(ctx.skipPrismaSetup, options));
+        }
         console.log('\n\n');
       }
     }
