Switch to pnpm (#354)

.github/actions/setup-pnpm/action.yml

@@ -0,0 +1,23 @@
+# See also https://github.com/actions/cache/blob/main/examples.md#node---npm
+
+name: Setup pnpm
+runs:
+  using: composite
+  steps:
+    - name: Install pnpm
+      uses: pnpm/action-setup@v2
+      with:
+        version: 7
+
+    - name: Get pnpm store directory
+      id: pnpm-cache-dir
+      shell: bash
+      run: echo "dir=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+    - name: Setup pnpm cache
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.pnpm-cache-dir.outputs.dir }}
+        key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          ${{ runner.os }}-pnpm-store-

.github/workflows/lint-format.yml

@@ -25,11 +25,11 @@ jobs:
         with:
           node-version: 16
 
-      - name: Setup NPM cache
-        uses: ./.github/actions/setup-npm-cache
+      - name: Setup pnpm
+        uses: ./.github/actions/setup-pnpm
 
       - name: Install dependencies
-        run: npm ci && npm install --global concurrently
+        run: pnpm install && pnpm add --global concurrently
 
       - name: Lint & Format
-        run: concurrently --prefix none --group "npm:lint" "npm:format"
+        run: concurrently --prefix none --group "pnpm:lint" "pnpm:format"

.github/workflows/release.yml

@@ -31,13 +31,13 @@ jobs:
           node-version: 16
           registry-url: https://registry.npmjs.org
 
-      - name: Setup NPM cache
-        uses: ./.github/actions/setup-npm-cache
+      - name: Setup pnpm
+        uses: ./.github/actions/setup-pnpm
 
       - name: Install dependencies
-        run: npm ci
+        run: pnpm install
 
       - name: Publish to NPM
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm publish
+        run: pnpm publish

.github/workflows/test.yml

@@ -48,14 +48,14 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
 
-      - name: Setup NPM cache
-        uses: ./.github/actions/setup-npm-cache
+      - name: Setup pnpm
+        uses: ./.github/actions/setup-pnpm
 
       - name: Install dependencies
-        run: npm ci && npm install --global concurrently
+        run: pnpm install && pnpm add --global concurrently
 
       - name: Build & Test
-        run: concurrently --prefix none --group "npm:build" "npm:test"
+        run: concurrently --prefix none --group "pnpm:build" "pnpm:test"
 
       - name: Submit coverage
         uses: coverallsapp/github-action@master

.prettierignore

@@ -1,3 +1,3 @@
 dist
 coverage
-pacakge-lock.json
+pnpm-lock.yaml

CONTRIBUTING.md

@@ -10,7 +10,7 @@ updated.
 
 ## Code Format & Linting
 
-Code format and lint checks are performed locally when committing to ensure the changes align with the configured rules of this repository. This happens with the help of the tools [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) and [lint-staged](https://github.com/okonet/lint-staged) which are automatically installed and configured on `npm install` (no further steps required).
+Code format and lint checks are performed locally when committing to ensure the changes align with the configured rules of this repository. This happens with the help of the tools [simple-git-hooks](https://github.com/toplenboren/simple-git-hooks) and [lint-staged](https://github.com/okonet/lint-staged) which are automatically installed and configured on `pnpm install` (no further steps required).
 
 In case of problems, a corresponding message is displayed in your terminal.
 Please fix them and then run the commit command again.
@@ -20,5 +20,5 @@ Please fix them and then run the commit command again.
 Tests can be executed with the following command:
 
 ```bash
-npm test
+pnpm test
 ```

index.js

@@ -1,5 +1,5 @@
 /*
- * While in local development, make sure you've run `npm run build` first.
+ * While in local development, make sure you've run `pnpm run build` first.
  */
 
 // eslint-disable-next-line @typescript-eslint/no-var-requires

index.mjs

@@ -1,5 +1,5 @@
 /*
- * While in local development, make sure you've run `npm run build` first.
+ * While in local development, make sure you've run `pnpm run build` first.
  */
 
 import concurrently from './dist/src/index.js';