Merge pull request #520 from gadget-inc/pnpm

pnpm

Author: airhorns

.envrc

@@ -0,0 +1,3 @@
+use flake
+
+source_env_if_exists .envrc.local

.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

@@ -0,0 +1,33 @@
+{
+  description = "fastify-renderer development environment";
+
+  inputs = {
+    flake-utils.url = "github:numtide/flake-utils";
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+  };
+
+  outputs = { self, flake-utils, nixpkgs }:
+    (flake-utils.lib.eachSystem [
+      "x86_64-linux"
+      "x86_64-darwin"
+      "aarch64-darwin"
+    ]
+      (system: nixpkgs.lib.fix (flake:
+        let
+          pkgs = nixpkgs.legacyPackages.${system};
+        in
+        rec {
+
+          packages =
+            rec {
+              bash = pkgs.bash;
+              nodejs = pkgs.nodejs-18_x;
+              pnpm = pkgs.nodePackages.pnpm;
+            };
+
+          devShell = pkgs.mkShell {
+            packages = builtins.attrValues packages;
+          };
+        }
+      )));
+}