Merge pull request #24 from Turbo87/pnpm

Replace npm with pnpm

Author: marcoieni

.github/workflows/ci.yml

@@ -9,6 +9,10 @@ on:
 
 permissions: {}
 
+env:
+  # renovate: datasource=npm depName=pnpm
+  PNPM_VERSION: 10.12.4
+
 jobs:
   test:
     name: Test
@@ -19,12 +23,17 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
+        with:
+          version: ${{ env.PNPM_VERSION }}
+
       - name: Install node dependencies
-        run: npm ci
+        run: pnpm install --frozen-lockfile
 
       - name: Test
         run: |
-          npm run test
+          pnpm test
 
   lint:
     name: Lint
@@ -35,12 +44,17 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
+        with:
+          version: ${{ env.PNPM_VERSION }}
+
       - name: Install node dependencies
-        run: npm ci
+        run: pnpm install --frozen-lockfile
 
       - name: Lint
         run: |
-          npm run lint
+          pnpm lint
 
   format:
     name: Format
@@ -51,11 +65,16 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
+        with:
+          version: ${{ env.PNPM_VERSION }}
+
       - name: Install Prettier
-        run: npm ci
+        run: pnpm install --frozen-lockfile
 
       - name: Format
-        run: npx prettier --check .
+        run: pnpm prettier --check .
 
   zizmor:
     name: Zizmor
@@ -74,22 +93,6 @@ jobs:
           # Instead, fail if there's a security issue.
           advanced-security: false
 
-  npm-install:
-    name: Lockfile up-to-date
-    runs-on: ubuntu-24.04
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-
-      - name: Check if package-lock.json is up-to-date
-        run: |
-          npm install
-
-          # Assert that the git diff is empty.
-          git diff --exit-code || (echo "Git diff is not empty. Please run 'npm install' and commit the changes." && exit 1)
-
   package:
     name: Package
     runs-on: ubuntu-24.04
@@ -99,16 +102,21 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Install pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
+        with:
+          version: ${{ env.PNPM_VERSION }}
+
       - name: Install node dependencies
-        run: npm ci
+        run: pnpm install --frozen-lockfile
 
       - name: Check is packaged
         run: |
           # Compile to single js files.
-          npm run package
+          pnpm package
 
           # Assert that the git diff is empty.
-          git diff --exit-code || (echo "Git diff is not empty. Please run 'npm run package' and commit the changes." && exit 1)
+          git diff --exit-code || (echo "Git diff is not empty. Please run 'pnpm package' and commit the changes." && exit 1)
 
   # This job tests the action directly by running it against a mock server.
   action-test:
@@ -200,7 +208,6 @@ jobs:
       - format
       - zizmor
       - package
-      - npm-install
       - rustfmt
       - action-test
       - clippy

.prettierignore

@@ -1,2 +1,3 @@
 # Ignore artifacts:
 dist
+pnpm-lock.yaml

CONTRIBUTING.md

@@ -18,7 +18,7 @@ You can't run this action locally as it requires a GitHub environment.
 To install node dependencies, run:
 
 ```sh
-npm install
+pnpm install
 ```
 
 ### Packaging
@@ -29,7 +29,7 @@ compile the TypeScript code and its dependencies into a single file
 in the `dist/` directory:
 
 ```sh
-npm run package
+pnpm package
 ```
 
 This approach is inspired by the [typescript-action](https://github.com/actions/typescript-action)
@@ -62,7 +62,7 @@ We use [Prettier](https://prettier.io/) to format TypeScript, Markdown, and YAML
 To format all files, run:
 
 ```sh
-npx prettier --write .
+pnpm prettier --write .
 ```
 
 ### Linting
@@ -72,7 +72,7 @@ We use [ESLint](https://eslint.org/) for linting TypeScript files.
 To check for linting errors, run:
 
 ```sh
-npx eslint
+pnpm eslint
 ```
 
 ### Testing
@@ -86,7 +86,7 @@ There are two types of tests running in [ci.yml](.github/workflows/ci.yml):
   To run these tests locally, run:
 
   ```sh
-  npm run test
+  pnpm test
   ```
 
 ## Crates.io Documentation