feat: add pnpm support

Author: Filipoliko

.github/actions/prepare-workspace/action.yml

@@ -5,12 +5,16 @@ runs:
   using: composite
   steps:
     - uses: actions/checkout@v4
+    - uses: pnpm/action-setup@v4
+      with:
+        version: 10
+        cache: true
     - uses: actions/setup-node@v4
       with:
         node-version-file: '.nvmrc'
         registry-url: 'https://registry.npmjs.org'
-        cache: 'npm'
+        cache: 'pnpm'
 
     - name: Install Dependencies
       shell: bash
-      run: npm ci
+      run: pnpm install --frozen-lockfile

.github/workflows/ci.yml

@@ -21,19 +21,19 @@ jobs:
       - uses: ./.github/actions/prepare-workspace
 
       - name: Run Lint
-        run: npm run lint
+        run: pnpm run lint
 
       - name: Run Stylelint
-        run: npm run stylelint
+        run: pnpm run stylelint
 
       - name: Run Tests
-        run: npm run test:all
+        run: pnpm run test:all
 
       - name: Run Bundle Size Test
-        run: npm run test:size
+        run: pnpm run test:size
 
       - name: Run Create IMA App Test
-        run: npm run test:create-ima-app
+        run: pnpm run test:create-ima-app
 
   release:
     if: github.ref_name == 'master' || github.ref_name == 'next'
@@ -50,7 +50,7 @@ jobs:
       - name: Release new versions
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm run release:publish
+        run: pnpm run release:publish
 
       - name: Create GitHub Releases
         uses: seznam/changeset-create-release@main

.github/workflows/pages-deploy.yml

@@ -13,15 +13,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 10
       - uses: actions/setup-node@v3
         with:
           node-version: 24
-          cache: npm
+          cache: pnpm
 
       - name: Install dependencies
-        run: npm ci
+        run: pnpm install --frozen-lockfile
       - name: Build website
-        run: npm run build:doc --workspaces --if-present
+        run: pnpm run -r --if-present build:doc
 
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus

.husky/pre-commit

@@ -1 +1 @@
-npx --no-install lint-staged
+lint-staged

.npmrc

@@ -1 +1,2 @@
 registry = "https://registry.npmjs.org/"
+shamefully-hoist = true

package.json

@@ -28,25 +28,24 @@
   ],
   "scripts": {
     "dev": "node ./utils/scripts/dev.js",
-    "build": "npm run build --workspaces --if-present",
-    "commit": "echo 'This command has been replaced with \"npm run changeset\"'",
+    "build": "pnpm run --recursive --if-present build",
+    "commit": "echo 'This command has been replaced with \"pnpm run changeset\"'",
     "changeset": "changeset add",
-    "postinstall": "npm run build",
     "lint": "eslint --cache --cache-location=node_modules/.cache/ './**/*.{js,jsx,ts,tsx,mjs}'",
     "prepare": "husky",
-    "release": "npm run release:prepare && npm run release:push",
-    "release:prepare": "npm run check:uncommited:changes && changeset version && npm i --package-lock-only --ignore-scripts",
-    "release:push": "git add .changeset package-lock.json packages/*/CHANGELOG.md packages/*/package.json && git commit -m 'Publish' && changeset tag && git push --follow-tags",
-    "release:devtools": "npm run publish-webstore --prefix ./packages/devtools",
-    "release:graduate": "npm run check:uncommited:changes && changeset pre exit && node utils/changesets/config-base-branch-replace.js master && changeset version && npm i --package-lock-only --ignore-scripts && npm run release:push",
+    "release": "pnpm run release:prepare && pnpm run release:push",
+    "release:prepare": "pnpm run check:uncommited:changes && changeset version && pnpm i --lockfile-only --ignore-scripts",
+    "release:push": "git add .changeset pnpm-lock.yaml packages/*/CHANGELOG.md packages/*/package.json && git commit -m 'Publish' && changeset tag && git push --follow-tags",
+    "release:devtools": "pnpm run --filter ./packages/devtools publish-webstore",
+    "release:graduate": "pnpm run check:uncommited:changes && changeset pre exit && node utils/changesets/config-base-branch-replace.js master && changeset version && pnpm i --lockfile-only --ignore-scripts && pnpm run release:push",
     "release:next:init": "changeset pre enter rc && node utils/changesets/config-base-branch-replace.js next",
     "release:publish": "changeset publish --no-git-tag",
     "stylelint": "stylelint --cache --cache-location=node_modules/.cache/ './**/*.{css,less}'",
     "test": "jest --changedSince `test -f '.changeset/pre.json' && echo 'next' || echo 'master'`",
     "test:all": "jest --colors",
     "test:create-ima-app": "utils/tests/testRunner.sh",
-    "test:size": "npm run test:size --workspaces --if-present",
-    "version": "npm run doc && node utils/version/create-ima-app-versions.js && git add docs packages/create-ima-app/template/common/package.json",
+    "test:size": "pnpm run --recursive --if-present test:size",
+    "version": "pnpm run doc && node utils/version/create-ima-app-versions.js && git add docs packages/create-ima-app/template/common/package.json",
     "check:uncommited:changes": "test \"`git status . --porcelain`\" && echo 'There are uncommitted changes. Aborting release.' && exit 1 || exit 0"
   },
   "lint-staged": {
@@ -88,7 +87,7 @@
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jest": "^29.1.0",
-    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-prettier": "5.5.4",
     "eslint-plugin-react": "^7.37.5",
     "fork-ts-checker-webpack-plugin": "^9.1.0",
     "fs-extra": "^11.3.2",
@@ -107,7 +106,7 @@
     "postcss-less": "6.0.0",
     "postcss-loader": "^8.2.0",
     "postcss-preset-env": "^10.4.0",
-    "prettier": "^3.6.2",
+    "prettier": "3.6.2",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "rollup": "^4.53.2",
@@ -126,8 +125,8 @@
     "webpack-cli": "^6.0.1",
     "yargs": "^18.0.0"
   },
-  "overrides": {
-    "enzyme": {
+  "pnpm": {
+    "overrides": {
       "cheerio": "1.0.0-rc.12"
     }
   }

packages/cli/package.json

@@ -28,7 +28,8 @@
     "dev": "tsc -w --preserveWatchOutput",
     "lint": "eslint './**/*.{js,jsx,ts,tsx}'",
     "test": "jest -c jest.config.js",
-    "test:watch": "npm run test -- --watch"
+    "test:watch": "pnpm run test --watch",
+    "prepare": "pnpm run build"
   },
   "dependencies": {
     "@babel/generator": "^7.28.5",

packages/core/package.json

@@ -54,10 +54,11 @@
     "build": "node ../plugin-cli/dist/bin/ima-plugin.js build",
     "link": "node ../plugin-cli/dist/bin/ima-plugin.js link",
     "lint": "eslint './**/*.{js,jsx,ts,tsx}'",
-    "test": "npm run test:jest && npm run test:size",
+    "test": "pnpm run test:jest && pnpm run test:size",
     "test:jest": "jest -c jest.config.js",
     "test:size": "size-limit",
-    "preversion": "npm test"
+    "preversion": "pnpm run test",
+    "prepare": "pnpm run build"
   },
   "dependencies": {
     "@esmj/task": "^0.5.2",

packages/create-ima-app/bin/create-ima-app.js

@@ -55,5 +55,6 @@ if (nodeMajorVersion > MAX_NODE_VERSION) {
 // Run create script
 create(
   process.argv[2],
-  process.argv.includes('--typescript') || process.argv.includes('-ts')
+  process.argv.includes('--typescript') || process.argv.includes('-ts'),
+  process.argv.includes('--pnpm')
 );

packages/create-ima-app/scripts/create.js

@@ -10,7 +10,7 @@ import fsExtra from 'fs-extra/esm';
 
 import { info, error, mergePkgJson } from './utils.js';
 
-export async function create(projDir, useTS) {
+export async function create(projDir, useTS, usePNPM) {
   const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
   info(
@@ -74,16 +74,19 @@ export async function create(projDir, useTS) {
   pkgJson.name = projName;
   await fs.promises.writeFile(pkgJsonPath, JSON.stringify(pkgJson, null, 2));
 
-  // Run npm install
+  // Determine package manager
+  const pkgManager = usePNPM ? 'pnpm' : 'npm';
+
+  // Run package manager install
   info(
     `Running ${chalk.magenta(
-      'npm install'
+      `${pkgManager} install`
     )} inside app directory, this might take a while...`
   );
 
   console.log(chalk.dim('      Press CTRL+C to cancel.\n'));
 
-  const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
+  const npm = process.platform === 'win32' ? `${pkgManager}.cmd` : pkgManager;
   spawnSync(npm, ['install'], {
     stdio: 'inherit',
     cwd: appRoot,
@@ -97,24 +100,24 @@ export async function create(projDir, useTS) {
 
 From there you can run several commands:
 
-  ${chalk.blue('npm run test')}
+  ${chalk.blue(`${pkgManager} run test`)}
     To run test runners.
 
-  ${chalk.blue('npm run lint')}
+  ${chalk.blue(`${pkgManager} run lint`)}
     To run eslint on your application source files.
 
-  ${chalk.blue('npm run dev')}
+  ${chalk.blue(`${pkgManager} run dev`)}
     To start development server.
 
-  ${chalk.blue('npm run build')}
+  ${chalk.blue(`${pkgManager} run build`)}
     To build the application.
 
-  ${chalk.blue('npm run start')}
+  ${chalk.blue(`${pkgManager} run start`)}
     To start IMA.js application server.
 
 We suggest that you start with:
 
   ${chalk.blue('cd')} ${projDir}
-  ${chalk.blue('npm run dev')}
+  ${chalk.blue(`${pkgManager} run dev`)}
 `);
 }