chore(pnpm): swap npm out for pnpm

Author: Kathund

.github/workflows/ci-cd-20.18.3.yml

@@ -10,36 +10,69 @@ env:
   NODE_VERSION: "20.18.3"
 
 jobs:
+  pnpm:
+    name: install dependencies (pnpm)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: "10"
+
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'pnpm'
+
+      - name: Install node dependencies
+        run: pnpm i
+
   es-lint:
+    name: es-lint
+    needs: [pnpm]
     runs-on: ubuntu-latest
     steps:
       - name: Git checkout
         uses: actions/checkout@v4
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
+          cache: 'pnpm'
 
       - name: Install node dependencies
-        run: npm i
+        run: pnpm i
 
-      - name: es-lint
-        run: npm run lint
+      - name: Check es-lint
+        run: pnpm lint
 
   prettier:
+    name: prettier
+    needs: [pnpm]
     runs-on: ubuntu-latest
     steps:
       - name: Git checkout
         uses: actions/checkout@v4
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
+          cache: 'pnpm'
 
       - name: Install node dependencies
-        run: npm i
+        run: pnpm i
 
-      - name: Prettier
-        run: npm run prettier
+      - name: Check prettier
+        run: pnpm prettier

.github/workflows/ci-cd-latest.yml

@@ -10,36 +10,69 @@ env:
   NODE_VERSION: "latest"
 
 jobs:
+  pnpm:
+    name: install dependencies (pnpm)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: "latest"
+
+      - name: Use Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          cache: 'pnpm'
+
+      - name: Install node dependencies
+        run: pnpm i
+
   es-lint:
+    name: es-lint
+    needs: [pnpm]
     runs-on: ubuntu-latest
     steps:
       - name: Git checkout
         uses: actions/checkout@v4
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
+          cache: 'pnpm'
 
       - name: Install node dependencies
-        run: npm i
+        run: pnpm i
 
-      - name: es-lint
-        run: npm run lint
+      - name: Check es-lint
+        run: pnpm lint
 
   prettier:
+    name: prettier
+    needs: [pnpm]
     runs-on: ubuntu-latest
     steps:
       - name: Git checkout
         uses: actions/checkout@v4
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+
       - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:
           node-version: ${{ env.NODE_VERSION }}
+          cache: 'pnpm'
 
       - name: Install node dependencies
-        run: npm i
+        run: pnpm i
 
-      - name: Prettier
-        run: npm run prettier
+      - name: Check prettier
+        run: pnpm prettier

README.md

@@ -24,6 +24,7 @@ that went into it. Thank you!
 
 - Git
 - NodeJS >= 20.18.3
+- pnpm >= 10.0.0
 - A Minecraft account
 
 ### Setup Guide for NodeJS
@@ -32,9 +33,13 @@ To get started, clone down the repository using:
 
     git clone https://github.com/DuckySoLucky/hypixel-discord-chat-bridge.git
 
-Next go into the `hypixel-discord-chat-bridge` folder and install all the dependencies using NPM.
+If you don't already have pnpm installed, install it using:
 
-    npm install
+    npm install pnpm --gbloal
+
+Next go into the `hypixel-discord-chat-bridge` folder and install all the dependencies using PNPM.
+
+    pnpm install
 
 While the dependencies are being installed you can edit the configuration file. The configuration file is called `config.example.json`. It is pretty self explanatory, but
 if you need help with it, you can check out the [Configuration](#configuration) section. Once you are done editing, save it as another file by the name of `config.json`.