refactor: migrate from npm to pnpm (#96)

* refactor: migrated from npm to pnpm

To improve package management and reduce load times, dependency management is now handled by pnpm

BREAKING CHANGE: npm commands will fail compared to previous commits

Author: flamingquaks

.github/workflows/build-on-every-push.yml

@@ -14,17 +14,36 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+        
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v4
+      with:
+        run_install: false
 
     - name: Setup Node.js
       uses: actions/setup-node@v4
       with:
         node-version: 20
-        
+        cache: 'pnpm'
+    
+    - name: Get pnpm store directory
+      shell: bash
+      run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+    
+    - uses: actions/cache@v4
+      name: Setup pnpm cache
+      with:
+          path: ${{ vars.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
     - name: Install dependencies
-      run: npm ci
-        
+      run: pnpm install
+
     - name: Build project
-      run: npm run build
+      run: pnpm run build
 
     - name: Upload UI Artifact
       uses: actions/upload-artifact@v4
@@ -43,14 +62,28 @@ jobs:
 
     steps:
     - uses: actions/checkout@v4
+
+    - name: Setup pnpm
+      uses: pnpm/action-setup@v4
+      with:
+        run_install: false
 
     - name: Setup Node.js
       uses: actions/setup-node@v4
       with:
         node-version: 20
+        cache: 'pnpm'
 
+    - uses: actions/cache@v4
+      name: Setup pnpm cache
+      with:
+          path: ${{ vars.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
     - name: Install dependencies
-      run: npm ci
+      run: pnpm install
 
     - name: Download UI Artifact
       uses: actions/download-artifact@v4

.github/workflows/deploy-pages.yml

@@ -18,17 +18,29 @@ jobs:
     build:
         runs-on: ubuntu-latest
         steps:
-            - name: Checkout
-              uses: actions/checkout@v4
-            - name: Setup Node
+            - uses: actions/checkout@v4
+
+            - name: Setup pnpm
+              uses: pnpm/action-setup@v4
+              with:
+                run_install: false
+            
+            - name: Setup Node.js
               uses: actions/setup-node@v4
               with:
                 node-version: 20
-                cache: npm
-            - name: Setup Pages
-              uses: actions/configure-pages@v5
-            - name: Install packages
-              run: npm ci
+                cache: 'pnpm'
+            
+            - uses: actions/cache@v4
+              name: Setup pnpm cache
+              with:
+                  path: ${{ vars.STORE_PATH }}
+                  key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+                  restore-keys: |
+                    ${{ runner.os }}-pnpm-store-
+
+            - name: Install dependencies
+              run: pnpm install
             - name: Build Pages
               run: |
                 npm run docs:build

.github/workflows/eslint.yml

@@ -28,12 +28,25 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          run_install: false
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 20
-      - name: Install Node Packages
-        run: npm install --save-dev
+          cache: 'pnpm'
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+            path: ${{ vars.STORE_PATH }}
+            key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+            restore-keys: |
+              ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install
       - name: Run ESLint
         run: npx eslint . --config .eslintrc.json --ext .js,.jsx,.ts,.tsx --format @microsoft/eslint-formatter-sarif --output-file eslint-results.sarif --debug
         continue-on-error: false

.vscode/settings.json

@@ -10,4 +10,5 @@
   "cSpell.enableFiletypes": [
     "cedarschema"
   ],
+  "npm.packageManager": "pnpm",
 }

cli/config-manage.ts

@@ -5,6 +5,10 @@ import prompt from 'prompt-sync'
 import { CONFIG_VERSION } from './config-version'
 import path from 'path'
 import figlet from 'figlet'
+import { fileURLToPath } from 'url'
+import { dirname } from 'path'
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
 const deployConfig = path.join(__dirname, '../bin/config.json')
 
 const prompter = prompt({ sigint: true })

cli/config.ts

@@ -1,5 +1,5 @@
 import { Command } from 'commander'
-import { CONFIG_VERSION } from './config-version'
+import * as CONFIG from './config-version'
 import figlet from 'figlet'
 
 const program = new Command()
@@ -15,7 +15,7 @@ program
   .description(
     'CLI utility for creating, viewing, and updating you GenAI Newsletter deployment configuration.'
   )
-  .version(CONFIG_VERSION)
+  .version(CONFIG.CONFIG_VERSION)
   .configureOutput({
     writeOut: (str) => {
       try {

cli/consts.ts

@@ -1,4 +1,4 @@
-import * as ansi from 'ansi-escape-sequences'
+import ansi from 'ansi-escape-sequences'
 
 interface FormattingOptions {
   bigHeader?: boolean