Merge pull request #497 from devforth/pnpm-for-dev-demo

Pnpm for dev demo

Author: yaroslav8765

README.md

@@ -58,14 +58,21 @@ npx adminforth create-app
 
 The most convenient way to add new features or fixes is using `dev-demo`. It imports the source code of the repository and plugins so you can edit them and see changes on the fly.
 
+# Requirements
+
+- **Node.js 20**
+- **Docker**
+- **pnpm**
+- **Taskfile**
+
 To run dev demo:
 ```sh
 cd dev-demo
 
-npm run setup-dev-demo
-npm run migrate:all
+pnpm setup-dev-demo
+pnpm migrate:all
 
-npm start
+pnpm start
 ```
 
 ## Adding columns to a database in dev-demo
@@ -77,13 +84,13 @@ To make migration add to the .prisma file in folder with database you need and a
 
 
 ```
-npm run makemigration:sqlite -- --name init
+pnpm makemigration:sqlite -- --name init
 ```
 
 and 
 
 ```
-npm run migrate:sqlite
+pnpm migrate:sqlite
 ```
 
 to apply migration
@@ -96,7 +103,7 @@ In order to make migration for the clickhouse, go to the `./migrations/clickhous
 
 Then run
 ```
-npm run migrate:clickhouse
+pnpm migrate:clickhouse
 ```
 
 to apply the migration.
@@ -108,18 +115,17 @@ Make sure you have not `adminforth` globally installed. If you have it, remove i
 
 
 ```sh
-npm uninstall -g adminforth
+pnpm uninstall -g adminforth
 ```
 
 Then, in the root of the project, run once:
 
 ```
 cd adminforth/adminforth
-npm run build
+pnpm build
+pnpm linl
 ```
 
-This will automatically make an npm link to the `adminforth` package in the root of the project.
-
 Then, go to testing app, e.g. created with CLI, and use next command:
 
 ```

adminforth/commands/createApp/templates/package.json.hbs

@@ -8,12 +8,12 @@
   "license": "ISC",
   "description": "",
   "scripts": {
-    "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",
+    "dev": "pnpm _env:dev -- tsx watch index.ts",
+    "prod": "pnpm _env:prod -- tsx index.ts",
+    "start": "pnpm dev",
+    "makemigration": "pnpm _env:dev -- npx --yes prisma migrate dev --create-only",
+    "migrate:local": "pnpm _env:dev -- npx --yes prisma migrate deploy",
+    "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 --"
   },

adminforth/commands/createApp/templates/readme.md.hbs

@@ -3,19 +3,19 @@
 Install dependencies:
 
 ```bash
-npm ci
+pnpm i
 ```
 
 Migrate the database:
 
 ```bash
-npm run migrate:local
+pnpm migrate:local
 ```
 
 Start the server:
 
 ```bash
-npm run dev
+pnpm dev
 ```
 
 {{#if prismaDbUrl}}
@@ -26,10 +26,10 @@ Open `schema.prisma` and change schema as needed: add new tables, columns, etc (
 Run the following command to generate a new migration and apply it instantly in local database:
 
 ```bash
-npm run makemigration -- --name <name_of_changes>
+pnpm makemigration -- --name <name_of_changes>
 ```
 
-Your colleagues will need to pull the changes and run `npm run migrateLocal` to apply the migration in their local database.
+Your colleagues will need to pull the changes and run `pnpm migrate:local` to apply the migration in their local database.
 {{/if}}
 
 ## Deployment tips

adminforth/commands/createApp/utils.js

@@ -362,12 +362,12 @@ async function installDependencies(ctx, cwd) {
   const isWindows = process.platform === 'win32';
 
   const nodeBinary = process.execPath; 
-  const npmPath = path.join(path.dirname(nodeBinary), isWindows ? 'npm.cmd' : 'npm');
+  const npmPath = path.join(path.dirname(nodeBinary), isWindows ? 'pnpm.cmd' : 'pnpm');
   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 } }),
+      await execAsync(`pnpm install`, { cwd, env: { PATH: process.env.PATH } }),
+      await execAsync(`pnpm install`, { cwd: customDir, env: { PATH: process.env.PATH } }),
     ]);
   } else {
     const res = await Promise.all([
@@ -387,11 +387,11 @@ function generateFinalInstructions(skipPrismaSetup, options) {
 
     instruction += `
   ${chalk.dim('// Generate and apply initial migration')}
-  ${chalk.dim('$')}${chalk.cyan(' npm run makemigration -- --name init && npm run migrate:local')}\n`;
+  ${chalk.dim('$')}${chalk.cyan(' pnpm makemigration -- --name init && pnpm migrate:local')}\n`;
 
   instruction += `
   ${chalk.dim('// Start dev server with tsx watch for hot-reloading')}
-  ${chalk.dim('$')}${chalk.cyan(' npm run dev')}\n
+  ${chalk.dim('$')}${chalk.cyan(' pnpm dev')}\n
 `;
 
   instruction += '😉 Happy coding!';

adminforth/commands/createPlugin/utils.js

@@ -158,8 +158,8 @@ async function installDependencies(ctx, cwd) {
   const customDir = ctx.customDir;
 
   await Promise.all([
-    await execa("npm", ["install", "--no-package-lock"], { cwd }),
-    await execa("npm", ["install"], { cwd: customDir }),
+    await execa("pnpm", ["install", "--no-package-lock"], { cwd }),
+    await execa("pnpm", ["install"], { cwd: customDir }),
   ]);
 }
 
@@ -168,15 +168,14 @@ function generateFinalInstructions() {
 
   instruction += `
   ${chalk.dim("// Build your plugin")}
-  ${chalk.cyan("$ npm run build")}\n`;
+  ${chalk.cyan("$ pnpm build")}\n`;
 
   instruction += `
   ${chalk.dim("// To test your plugin locally")}
-  ${chalk.cyan("$ npm link")}\n`;
-
+  ${chalk.cyan("$ pnpm link")}\n`;
   instruction += `
   ${chalk.dim("// In your AdminForth project")}
-  ${chalk.cyan("$ npm link " + chalk.italic("your-plugin-name"))}\n`;
+  ${chalk.cyan("$ pnpm link " + chalk.italic("your-plugin-name"))}\n`;
 
   instruction += "\n😉 Happy coding!";
 

adminforth/commands/postinstall.js

@@ -7,7 +7,7 @@ const spaPath = path.join(import.meta.dirname, 'dist', 'spa');
 
 if (fs.existsSync(spaPath)){ 
     console.log('Installing SPA dependencies...');
-    execSync('npm ci', { cwd: spaPath, stdio: 'inherit' });
+    execSync('pnpm i', { cwd: spaPath, stdio: 'inherit' });
     console.log('Installed spa dependencies');
 } else {
     console.log('SPA dependencies not found');

adminforth/documentation/docs/tutorial/001-gettingStarted.md

@@ -81,25 +81,25 @@ myadmin/
 CLI will suggest you a command to initialize the database with Prisma:
 
 ```bash
-npm run makemigration -- --name init
+pnpm makemigration -- --name init
 ```
 
 This will create a migration file in `migrations` and apply it to the database.
 
 In future, when you need to add new resources, you need to modify `schema.prisma` (add models, change fields, etc.). After doing any modification you need to create a new migration using next command:
 
 ```bash
-npm run makemigration -- --name init ; npm run migrate:local
+pnpm makemigration -- --name init ; pnpm migrate:local
 ```
 
-Other developers need to pull migration and run `npm run migrateLocal` to apply any unapplied migrations.
+Other developers need to pull migration and run `pnpm migrate:local` to apply any unapplied migrations.
 
 ## Run the Server
 
 Now you can run your app:
 
 ```bash
-npm start
+pnpm start
 ```
 
 Open http://localhost:3500 in your browser and (default credentials are `adminforth`/`adminforth` if you haven’t changed them).
@@ -173,7 +173,7 @@ model apartments {
 Run the following command to create a new migration:
 
 ```bash
-npm run makemigration -- --name add-apartments ; npm run migrate:local
+pnpm makemigration -- --name add-apartments ; pnpm migrate:local
 ```
 
 ### Step3. Create the `apartments` resource

adminforth/documentation/docs/tutorial/03-Customization/02-customFieldRendering.md

@@ -151,10 +151,10 @@ To install 3rd-party npm packages you should create npm package in the `custom`
 cd custom
 ```
 
-And simply do `npm install` for the package you need:
+And simply do `pnpm install` for the package you need:
 
 ```bash
-npm i <some package> -D
+pnpm i <some package> -D
 ```
 
 ## Editing values component

adminforth/documentation/docs/tutorial/03-Customization/03-virtualColumns.md

@@ -148,7 +148,7 @@ In this case you can use `insecureRawSQL` to write your own part of where clause
 However the vital concern that the SQL passed to DB as is, so if you substitute any user inputs it will not be escaped and can lead to SQL injection. To mitigate the issue we recommend using `sqlstring` package which will escape the inputs for you.
 
 ```bash
-npm i sqlstring
+pnpm i sqlstring
 ```
 
 Then you can use it like this:

adminforth/documentation/docs/tutorial/03-Customization/08-pageInjections.md

@@ -329,7 +329,7 @@ For this demo we will use text-analyzer package:
 
 ```bash 
 cd custom
-npm i text-analyzer
+pnpm i text-analyzer
 ```
 
 
@@ -396,7 +396,7 @@ Install used icon:
 
 ```sh
 cd custom
-npm i @iconify-prerendered/vue-mdi
+pnpm i @iconify-prerendered/vue-mdi
 ```
 
 ## List table row replace injection