Switch to pnpm

Author: airhorns

.github/actions/setup-test-env/action.yml

@@ -1,14 +1,29 @@
-name: 'Setup test environment'
-description: ''
+name: "Setup test environment"
+description: ""
 inputs: {}
 outputs: {}
 runs:
-    using: "composite"
-    steps:
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v2
+  using: "composite"
+  steps:
+    - uses: pnpm/action-setup@v2
+      name: Install pnpm
       with:
-        node-version: ${{ matrix.node-version }}
-        cache: 'yarn'
-    - run: yarn install --frozen-lockfile
-      shell: "bash"
+        version: 8
+        run_install: false
+
+    - name: Get pnpm store directory
+      shell: bash
+      run: |
+        echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+    - uses: actions/cache@v3
+      name: Setup pnpm cache
+      with:
+        path: ${{ env.STORE_PATH }}
+        key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+        restore-keys: |
+          ${{ runner.os }}-pnpm-store-
+
+    - name: Install dependencies
+      shell: bash
+      run: pnpm install

.github/workflows/ci.yml

@@ -8,18 +8,18 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [16.x, 18.x, 20.x]
         os: [ubuntu-latest]
 
     steps:
       - uses: actions/checkout@v2
       - uses: ./.github/actions/setup-test-env
       - name: Build JS
-        run: yarn build
+        run: pnpm build
       - name: Run Tests
-        run: yarn run test
+        run: pnpm run test
       - name: Run Lint
-        run: yarn run lint
+        run: pnpm run lint
 
   automerge:
     needs: build

.github/workflows/release.yml

@@ -17,7 +17,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ./.github/actions/setup-test-env
       - name: Build all packages
-        run: yarn build
+        run: pnpm build
       - id: npm-publish
         name: Publish fastify-renderer
         uses: JS-DevTools/npm-publish@v1
@@ -30,4 +30,4 @@ jobs:
         if: ${{ steps.npm-publish.outputs.type != 'none' }}
         with:
           tag_name: ${{ steps.npm-publish.outputs.version }}
-          generate_release_notes: true
+          generate_release_notes: true

.gitignore

@@ -29,7 +29,7 @@ jspm_packages/
 # Output of 'npm pack'
 *.tgz
 
-# Yarn Integrity file
+# pnpm Integrity file
 .yarn-integrity
 
 # dotenv environment variables file

.swcrc

@@ -1,6 +1,47 @@
-# Contributing to fastify-renderer 
+# Contributing to fastify-renderer
 
 See below for information on how fastify-renderer's community is governed.
+
+## Development
+
+### Running a development server for a test app
+
+To run a local dev server that mounts the monorepo version of `fastify-render` in a test app, run
+
+```shell
+pnpm -F=simple-react dev
+```
+
+### Running tests
+
+You can run all the tests with:
+
+```shell
+pnpm test
+```
+
+You can run a specific test file with:
+
+```shell
+pnpm test packages/test-apps/simple-react/test/some-test-file.spec.ts
+```
+
+You can run a specific test case with:
+
+```shell
+pnpm test packages/test-apps/simple-react/test/some-test-file.spec.ts -- -t "the case name"
+```
+
+#### Debugging Playwright tests
+
+Playwright supports a handy debug environment variable:
+
+```shell
+PWDEBUG=1 pnpm test packages/test-apps/simple-react/test/some-test-file.spec.ts
+```
+
+This pops open a headful browser for running tests, and a UI for stepping through each execution element as it happens.
+
 ## Releases
 
 Bump the version with `npm version <minor|major|patch>` then commit the change to git. When your changes get pushed/merged to `main` on github, Github Actions will run the `release` workflow and automatically publish the release to NPM.

Contributing.md

@@ -22,6 +22,8 @@ Features:
 npm install fastify-renderer --save
 # Using yarn
 yarn install fastify-renderer
+# Using pnpm
+pnpm install fastify-renderer
 ```
 
 ## Registering the plugin

README.md

@@ -2,18 +2,15 @@
   "name": "workspace",
   "private": true,
   "description": "Simple, high performance client side app renderer for Fastify.",
-  "workspaces": [
-    "packages/fastify-renderer",
-    "packages/test-apps/*"
-  ],
   "scripts": {
-    "watch": "yarn workspace fastify-renderer watch",
-    "build": "yarn workspaces run build",
-    "typecheck": "yarn workspaces run typecheck",
+    "watch": "pnpm -F=fastify-renderer watch",
+    "build": "pnpm -r  build",
+    "typecheck": "pnpm -r typecheck",
     "lint": "eslint \"packages/**/*.{js,ts,tsx}\"",
     "lint:fix": "prettier --loglevel warn --write \"packages/**/*.{ts,tsx}\" && eslint \"packages/**/*.{ts,tsx}\" --quiet --fix",
-    "release": "yarn workspace fastify-renderer publish",
-    "prerelease": "yarn workspace fastify-renderer run gitpkg publish",
+    "release": "pnpm -F=fastify-renderer publish",
+    "preinstall": "npx only-allow pnpm",
+    "prerelease": "pnpm -F=fastify-renderer run gitpkg publish",
     "test": "jest --forceExit -w=1",
     "test:debug": "cross-env FR_DEBUG_SERVE=1 node --inspect-brk ./node_modules/.bin/jest --forceExit"
   },
@@ -37,18 +34,30 @@
     "node": ">= 12.0.0"
   },
   "dependencies": {
-    "fastify-renderer": "*"
-  },
-  "resolutions": {
-    "react": "0.0.0-experimental-4ead6b530",
-    "react-dom": "0.0.0-experimental-4ead6b530",
-    "@types/react": "17.0.4",
-    "@types/react-dom": "17.0.4"
+    "fastify-renderer": "workspace:*"
   },
   "devDependencies": {
     "cross-env": "^7.0.3",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^3.4.1",
+    "eslint-plugin-react": "^7.31.7",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "expect-playwright": "^0.8.0",
     "fs-extra": "^10.1.0",
+    "jest": "^28.1.3",
     "playwright-chromium": "^1.25.0",
-    "wds": "^0.12.0"
+    "prettier": "^2.7.1",
+    "prettier-plugin-organize-imports": "^2.3.4",
+    "wds": "^0.18.1"
+  },
+  "pnpm": {
+    "overrides": {
+      "react": "0.0.0-experimental-4ead6b530",
+      "react-dom": "0.0.0-experimental-4ead6b530",
+      "@types/react": "17.0.4",
+      "@types/react-dom": "17.0.4"
+    }
   }
 }

package.json

@@ -0,0 +1,17 @@
+{
+  "jsc": {
+    "parser": {
+      "syntax": "typescript",
+      "tsx": true,
+      "decorators": true,
+      "dynamicImport": true,
+      "externalHelpers": true
+    },
+    "target": "es2022"
+  },
+  "module": {
+    "type": "commonjs",
+    // turn on lazy imports for maximum reboot performance
+    "lazy": true
+  }
+}

packages/fastify-renderer/.swcrc

@@ -59,10 +59,10 @@
   "dependencies": {
     "@opentelemetry/api": "^1.4.0",
     "@vitejs/plugin-react-refresh": "^1.3.6",
-    "fastify-accepts": "^2.1.0",
+    "@fastify/accepts": "^3.0.0",
+    "@fastify/static": "^5.0.0",
     "fastify-express": "^0.3.3",
     "fastify-plugin": "^3.0.1",
-    "fastify-static": "^4.6.1",
     "http-errors": "^1.8.1",
     "middie": "^5.4.0",
     "path-to-regexp": "^6.2.1",
@@ -77,8 +77,8 @@
     "react-dom": "experimental"
   },
   "devDependencies": {
-    "@swc/core": "^1.3.9",
-    "@swc/jest": "^0.2.26",
+    "@swc/core": "^1.3.95",
+    "@swc/jest": "^0.2.29",
     "@types/connect": "^3.4.35",
     "@types/jest": "^26.0.24",
     "@types/node": "^14.17.20",
@@ -88,20 +88,12 @@
     "@typescript-eslint/eslint-plugin": "^5.40.0",
     "@typescript-eslint/parser": "^5.40.0",
     "cheerio": "^1.0.0-rc.12",
-    "eslint": "^7.32.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-prettier": "^3.4.1",
-    "eslint-plugin-react": "^7.31.7",
-    "eslint-plugin-react-hooks": "^4.6.0",
     "fastify": "^3.29.0",
     "gitpkg": "^1.0.0-beta.2",
     "jest": "^28.1.3",
     "jest-playwright-preset": "^2.0.0",
     "npm-run-all": "^4.1.5",
     "pino-pretty": "^4.8.0",
-    "prettier": "^2.7.1",
-    "prettier-plugin-organize-imports": "^2.3.4",
     "react": "0.0.0-experimental-4ead6b530",
     "react-dom": "0.0.0-experimental-4ead6b530",
     "rimraf": "^3.0.2",