switch to pnpm (#378)

* switch to pnpm

it's much faster, uses less space on disk
(no gigantic node_modules) and has a readable
lock file

* fixup CI for linting and building

* more fixup

* cleanup dockerfile

.github/workflows/build-and-lint-on-pr.yaml

@@ -9,17 +9,23 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9
+          run_install: false
+
       - name: Set up node
         uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: npm
+          cache: 'pnpm'
 
       - name: Install dependencies
-        run: npm install
+        run: pnpm install
 
       - name: Build application
-        run: npm run build
+        run: pnpm run build
 
       - name: Check for ESLint warnings and errors
-        run: npm run lint
+        run: pnpm run lint

Dockerfile

@@ -1,19 +1,23 @@
 FROM node:20-alpine AS builder
 WORKDIR /usr/local/app
+RUN apk add pnpm
 
 COPY . .
-RUN npm ci && npm run build
+
+RUN rm -rf node_modules && \
+    pnpm install && pnpm run build
 
 FROM node:20-alpine
 
 WORKDIR /usr/local/app
+RUN apk add pnpm
 
 COPY --from=builder /usr/local/app/dist ./dist
 COPY package*.json server.js ./
 
-RUN npm install --ignore-scripts --save-exact express vite-express
+RUN pnpm install --ignore-scripts vite-express
 
 ENV PORT=8080
 EXPOSE 8080
 
-ENTRYPOINT ["sh", "-c", "./dist/vite-envs.sh && npm run prod"]
+ENTRYPOINT ["sh", "-c", "./dist/vite-envs.sh && npm run prod"]

Makefile

@@ -7,15 +7,15 @@ help:
 
 .PHONY: build
 build: ## Build the app
-	npm install
+	pnpm install
 
 build-docker-local:
 	docker build -t dapla-ctrl .
 
 .PHONY: run-dev 
 run-dev: ## Run the app in dev mode
-	npm run dev
+	pnpm run dev
 
 include .env.local
 run-docker-local:
-	docker run -it -p 8080:8080 -e VITE_JWKS_URI=${VITE_JWKS_URI} dapla-ctrl
+	docker run -it -p 8080:8080 -e VITE_JWKS_URI=${VITE_JWKS_URI} dapla-ctrl

README.md

@@ -38,13 +38,13 @@ powerful primitives for managing asynchrounous effects in a sane way with strong
    ```sh
    nix develop
    ```
-4. Install NPM packages
+4. Install PNPM packages
    ```sh
-   npm install
+   pnpm install
    ```
 5. Start the development server and access the application at http://localhost:3000
    ```sh
-   npm run dev
+   pnpm run dev
    ```
 
 ### Note about local development
@@ -64,7 +64,7 @@ If you don't want to use the Nix development environment you have to follow thes
 - Install nodemon (required to run the development server)
 
   ```sh
-  npm install -g nodemon
+  pnpm add -g nodemon
   ```
 
 - Set environment variables needed by the application:
@@ -78,13 +78,13 @@ If you don't want to use the Nix development environment you have to follow thes
 For ensuring code consistency and adhering to coding standards, our project utilizes ESLint and Prettier. To view linting warnings and errors in the console, it's recommended to run the following script during development:
 
 ```sh
-npm run lint
+pnpm run lint
 ```
 
 To automatically fix linting and formatting issues across all files, you can use the following scripts (Note: While these scripts resolve many ESLint warnings or errors, some issues may require manual intervention):
 
 ```sh
-npm run lint:fix && npm run lint:format
+pnpm run lint:fix && pnpm run lint:format
 ```
 
 ### IDE Support

flake.nix

@@ -22,6 +22,7 @@
             nodejs
             nodePackages.nodemon
             nodePackages.typescript-language-server
+            pnpm
             pandoc
           ];
         };