[WTF-2349]: Migrate widget-tools repo to pnpm (#132)

## This PR contains

-   [ ] Bug fix
-   [ ] Feature
-   [x] Refactor
-   [ ] Documentation
-   [ ] Other (describe)

## What is the purpose of this PR?

Pnpm is an alternative package manager that has leaves a smaller
footprint when installing dependencies. It also has great workspaces
support which makes it easer to depend on other projects in the same
monorepo as well as synchronizing dependencies between them. Another
benefit is that other teams at Mendix use it to manage monorepos, so
this move unifies our way of working.

## Relevant changes

- Lockfiles have been replaced
- Top-level scripts have been moved to the packages level, minimizing
risk of dependencies colliding due to nestedness.
- Cheerio has been added to resolutions to allow enzyme tests to
continue to function
- CI scripts have been updated to use pnpm

## What should be covered while testing?

- CI actions continue to function as expected
- Widgets continue to use the pwt unhindered

Author: weirdwater

.github/workflows/CreateGWRelease.yml

@@ -23,16 +23,22 @@ jobs:
         with:
           submodules: false
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda #v4.1.0
+        with:
+          version: 10
+
       - name: "Defining node version"
-        uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 # v2
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version-file: ".nvmrc"
+          cache: 'pnpm'
 
       - name: "Installing dependencies"
-        run: npm install
+        run: pnpm install
 
       - name: "Creating GW release and MR"
-        run: "npm run release:gw"
+        run: "pnpm --dir packages/release-tools run release:gw"
         env:
           GH_USERNAME: ${{ secrets.GH_USERNAME }}
           GH_EMAIL: ${{ secrets.GH_EMAIL }}

.github/workflows/CreatePWTRelease.yml

@@ -23,16 +23,22 @@ jobs:
         with:
           submodules: false
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda #v4.1.0
+        with:
+          version: 10
+
       - name: "Defining node version"
-        uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 # v2
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version-file: ".nvmrc"
+          cache: 'pnpm'
 
       - name: "Installing dependencies"
-        run: npm install
+        run: pnpm install
 
       - name: "Creating PWT release and MR"
-        run: "npm run release:pwt"
+        run: "pnpm --dir packages/release-tools run release:pwt"
         env:
           GH_USERNAME: ${{ secrets.GH_USERNAME }}
           GH_EMAIL: ${{ secrets.GH_EMAIL }}

.github/workflows/PublishNpm.yml

@@ -16,30 +16,32 @@ jobs:
         uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 # v2
         with:
           submodules: false
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda #v4.1.0
+        with:
+          version: 10
+
       - name: "Defining Environment Variables"
         id: variables
         run: echo "::set-output name=tag::$(git tag --points-at HEAD)"
+
       - name: "Defining node version"
-        uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 # v2
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version-file: ".nvmrc"
-      - name: "Installing root dependencies"
-        working-directory: ./
-        run: npm install
-      - name: "Installing pluggable-widgets-tools dependencies"
-        working-directory: ./packages/pluggable-widgets-tools
-        if: contains(steps.variables.outputs.tag, 'pluggable-widgets-tools-v')
-        run: npm install
+          cache: 'pnpm'
+
       - name: "Installing generator-widget dependencies"
-        working-directory: ./packages/generator-widget
-        if: contains(steps.variables.outputs.tag, 'generator-widget-v')
-        run: npm install
+        run: pnpm install
+
       - name: "Targeting Pluggable Widgets Tools"
         if: contains(steps.variables.outputs.tag, 'pluggable-widgets-tools-v')
         uses: JS-DevTools/npm-publish@0f451a94170d1699fd50710966d48fb26194d939 # v1
         with:
           package: "./packages/pluggable-widgets-tools/package.json"
           token: ${{ secrets.NPM_TOKEN }}
+
       - name: "Targeting Pluggable Widgets Generator"
         if: contains(steps.variables.outputs.tag, 'generator-widget-v')
         uses: JS-DevTools/npm-publish@0f451a94170d1699fd50710966d48fb26194d939 # v1

.github/workflows/ShaCheck.yml

@@ -15,6 +15,7 @@ jobs:
         uses: actions/checkout@ec3a7ce113134d7a93b817d10a8272cb61118579 # v2
         with:
           submodules: false
+
       - name: "Ensure SHA pinned actions"
         uses: zgosalvez/github-actions-ensure-sha-pinned-actions@0b552a197e44b819629237e065d781f5ca691460 # v1.1.1
         with:

.github/workflows/TestPWTCommands.yml

@@ -27,9 +27,10 @@ jobs:
         with:
           filters: |
             packages:
-              - 'packages/**/*'
+              - 'packages/generator-widget/*'
+              - 'packages/pluggable-widgets-tools/*'
             tests:
-              - 'tests/**/*'
+              - 'packages/command-tests/*'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -38,24 +39,35 @@ jobs:
         env:
           cache-name: cache-node-modules
         with:
-          path: ~/.npm
+          path: ~/.pnpm-store
           key: ${{ runner.os }}-${{ matrix.node }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda #v4.1.0
+        if: matrix.node == 16
+        with:
+          version: 8
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda #v4.1.0
+        if: matrix.node == 18
+        with:
+          version: 10
+
       - name: "Defining node version"
-        uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 # v2
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version: ${{ matrix.node == 18 && '18.15.0' || matrix.node }}
+          cache: 'pnpm'
 
       - name: "Installing dependencies"
-        working-directory: ./
         if: steps.filter.outputs.packages == 'true' || steps.filter.outputs.tests == 'true'
-        run: npm install
+        run: pnpm install
 
       - name: Increase number of watchers
         if: (steps.filter.outputs.packages == 'true' || steps.filter.outputs.tests == 'true') && startsWith(matrix.os, 'ubuntu')
         run: echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
 
       - name: "Testing PWT commands"
-        working-directory: ./
+        working-directory: ./packages/command-tests
         if: steps.filter.outputs.packages == 'true' || steps.filter.outputs.tests == 'true'
-        run: npm run test:pwt:commands
+        run: pnpm test

.github/workflows/UnitTests.yml

@@ -33,30 +33,29 @@ jobs:
         env:
           cache-name: cache-node-modules
         with:
-          path: ~/.npm
+          path: ~/.pnpm-store
           key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
 
+      - name: Setup pnpm
+        uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda #v4.1.0
+        with:
+          version: 10
+
       - name: "Defining node version"
-        uses: actions/setup-node@1f8c6b94b26d0feae1e387ca63ccbdc44d27b561 # v2
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version-file: ".nvmrc"
+          cache: 'pnpm'
 
       - name: "Installing dependencies"
-        working-directory: ./
         if: steps.filter.outputs.packages == 'true'
-        run: npm install
+        run: pnpm install
 
-      - name: "Running pluggable-widgets-tools unit tests"
-        working-directory: ./packages/pluggable-widgets-tools
-        if: steps.filter.outputs.packages == 'true'
-        run: npm run test
-
-      - name: "Running generator-widget unit tests"
-        working-directory: ./packages/generator-widget
+      - name: "Running unit tests"
         if: steps.filter.outputs.packages == 'true'
-        run: npm run test
+        run: pnpm -r test
 
       - name: "Linting generator-widget"
         working-directory: ./packages/generator-widget
         if: steps.filter.outputs.packages == 'true'
-        run: npm run lint
+        run: pnpm run lint

.gitignore

@@ -10,4 +10,5 @@ node_modules
 mxproject
 coverage
 
-# tests
+# Packed packages
+mendix-*.tgz