Switches from npm to pnpm (microsoft#79)

For faster node package installs - pnpm has a global cache and increased parallelism, similar to uv
markwaddle · Oct 2, 2024 · 60cac79 · 60cac79
1 parent 4c42025
commit 60cac79
Show file tree

Hide file tree

Showing 10 changed files with 12,425 additions and 20,769 deletions.
diff --git a/.github/workflows/workbench-app.yml b/.github/workflows/workbench-app.yml
@@ -26,19 +26,31 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Node.js version
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 9
+          run_install: false
+
+      - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "20.x"
+          node-version: 20
+          cache: 'pnpm'
+          cache-dependency-path: workbench-app/pnpm-lock.yaml
+
+      - name: pnpm install
+        working-directory: ./workbench-app
+        run: pnpm install
 
-      - name: npm install, build, and test
+      - name: pnpm build
         env:
           NODE_OPTIONS: "--max_old_space_size=8192"
+          VITE_SEMANTIC_WORKBENCH_AUTHORITY: ${{ secrets.VITE_SEMANTIC_WORKBENCH_AUTHORITY }}
+          VITE_SEMANTIC_WORKBENCH_CLIENT_ID: ${{ secrets.VITE_SEMANTIC_WORKBENCH_CLIENT_ID }}
+          VITE_SEMANTIC_WORKBENCH_SERVICE_URL: ${{ secrets.VITE_SEMANTIC_WORKBENCH_SERVICE_URL }}
         working-directory: ./workbench-app
-        run: |
-          npm install
-          npm run build --if-present
-          npm run test --if-present
+        run: pnpm run build
 
   build-main:
     runs-on: ubuntu-latest
@@ -49,22 +61,31 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Set up Node.js version
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 9
+          run_install: false
+
+      - name: Install Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "20.x"
+          node-version: 20
+          cache: 'pnpm'
+          cache-dependency-path: workbench-app/pnpm-lock.yaml
+
+      - name: pnpm install
+        working-directory: ./workbench-app
+        run: pnpm install
 
-      - name: npm install, build, and test
+      - name: pnpm build
         env:
           NODE_OPTIONS: "--max_old_space_size=8192"
           VITE_SEMANTIC_WORKBENCH_AUTHORITY: ${{ secrets.VITE_SEMANTIC_WORKBENCH_AUTHORITY }}
           VITE_SEMANTIC_WORKBENCH_CLIENT_ID: ${{ secrets.VITE_SEMANTIC_WORKBENCH_CLIENT_ID }}
           VITE_SEMANTIC_WORKBENCH_SERVICE_URL: ${{ secrets.VITE_SEMANTIC_WORKBENCH_SERVICE_URL }}
         working-directory: ./workbench-app
-        run: |
-          npm install
-          npm run build --if-present
-          npm run test --if-present
+        run: pnpm run build
 
       - name: Zip artifact for deployment
         if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }}

diff --git a/docs/SETUP_DEV_ENVIRONMENT.md b/docs/SETUP_DEV_ENVIRONMENT.md
@@ -79,6 +79,7 @@ Once you have nvm installed:
 ```
 nvm install 20 lts
 nvm use 20
+npm install -g pnpm
 ```
 
 ### Build the frontend

diff --git a/tools/run-app.sh b/tools/run-app.sh
@@ -17,5 +17,5 @@ fi
 
 echo "Starting the Semantic Workbench app, open https://localhost:4000 in your browser when ready"
 
-npm install
-npm start
+pnpm install
+pnpm start
diff --git a/workbench-app/Makefile b/workbench-app/Makefile
@@ -5,22 +5,21 @@ repo_root = $(shell git rev-parse --show-toplevel)
 .PHONY: clean
 clean:
 	$(rm) node_modules || $(true_expression)
-	npm cache clean --force
 
 .PHONY: install
 install:
-	npm install
+	pnpm install
 
 .PHONY: test
 test:
-	npm run type-check
+	pnpm run type-check
 
 .PHONY: format
 format:
-	npm run format
+	pnpm run format
 
 .PHONY: lint
 lint:
-	npm run lint
+	pnpm run lint
 
 include $(repo_root)/tools/makefiles/shell.mk
diff --git a/workbench-app/README.md b/workbench-app/README.md
@@ -2,7 +2,7 @@
 
 The Semantic Workbench app is a React/Typescript app integrated with the [Semantic Workbench](../service/README.md) backend service.
 
-Follow the [setup guide](../../../docs/SETUP_DEV_ENVIRONMENT.md) to configure your dev environment.
+Follow the [setup guide](../docs/SETUP_DEV_ENVIRONMENT.md) to configure your dev environment.
 
 ## Running Workbench App from VS Code
 
@@ -13,7 +13,7 @@ To run and/or debug in VS Code, View->Run, "app: semantic-workbench-app"
 In the [app directory](./)
 
 ```sh
-npm start
+pnpm start
 ```
 
 Note: you might be prompted for admin credentials, for the SSL certificates used by the app.
@@ -22,9 +22,9 @@ Note: you might be prompted for admin credentials, for the SSL certificates used
 
 ### Scripts
 
--   `npm start` - start dev server and open browser
--   `npm build` - build for production
--   `npm preview` - locally preview production build
+-   `pnpm start` - start dev server and open browser
+-   `pnpm build` - build for production
+-   `pnpm preview` - locally preview production build
 
 ### More info