Merge pull request #81 from gadget-inc/pnpm

Switch to using pnpm for development

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

@@ -1,16 +1,16 @@
-name: 'Setup test environment'
-description: ''
+name: "Setup test environment"
+description: ""
 inputs: {}
 outputs: {}
 runs:
-    using: "composite"
-    steps:
+  using: "composite"
+  steps:
     - uses: cachix/install-nix-action@v20
     - run: nix flake check
       shell: bash
-    - name: Add Gadget yarn registry
+    - name: Add Gadget npm registry
       shell: nix develop -c bash -eo pipefail -l {0}
       run: npm config set @gadget-client:registry https://registry.gadget.dev/npm
-    - name: Install dependencies with yarn install
+    - name: Install dependencies with pnpm
       shell: nix develop -c bash -eo pipefail -l {0}
-      run: yarn install
+      run: pnpm install

.github/workflows/test.yml

@@ -12,13 +12,17 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: ./.github/actions/setup-test-env
-      - run: yarn build
+      - run: pnpm build
+        shell: nix develop -c bash -eo pipefail -l {0}
       - run: test/test.sh
-      - run: yarn jest
+        shell: nix develop -c bash -eo pipefail -l {0}
+      - run: pnpm jest
+        shell: nix develop -c bash -eo pipefail -l {0}
 
   lint:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: ./.github/actions/setup-test-env
-      - run: yarn lint
+      - run: pnpm lint
+        shell: nix develop -c bash -eo pipefail -l {0}

Contributing.md

@@ -1,12 +1,12 @@
 # Testing
 
-Gotta build the package, which you can do once with `yarn build`, or watch your local development directory and rebuild when things change with `yarn watch`.
+Gotta build the package, which you can do once with `pnpm build`, or watch your local development directory and rebuild when things change with `pnpm watch`.
 
-Then gotta use it somewhere, which tends to be easiest in a project. I use `yarn link` for this.
+Then gotta use it somewhere, which tends to be easiest in a project. I use `pnpm link` for this.
 
 # Releasing
 
-Releases are managed automatically by Github Actions. To create a new release, follow these setps:
+Releases are managed automatically by Github Actions. To create a new release, follow these steps:
 
-1. Run `npm version minor|major|patch`. This will change the version in the package.json and create a new git commit changing it. 
+1. Run `npm version minor|major|patch`. This will change the version in the package.json and create a new git commit changing it.
 2. Push this commit to the `main` branch. CI will run the tests, then run the release workflow, which publishes to NPM, create a Github release, and creates a git tag for the version.

flake.nix

@@ -22,9 +22,7 @@
             rec {
               bash = pkgs.bash;
               nodejs = pkgs.nodejs-18_x;
-              yarn = pkgs.yarn.override {
-                inherit nodejs;
-              };
+              pnpm = pkgs.nodePackages.pnpm;
             };
 
           devShell = pkgs.mkShell {

package.json

@@ -22,14 +22,15 @@
     "LICENSE.txt"
   ],
   "scripts": {
+    "preinstall": "npx only-allow pnpm",
     "build": "rm -rf pkg && tsc && chmod +x pkg/wds.bin.js pkg/wds-bench.bin.js",
-    "prepublishOnly": "yarn run build",
+    "prepublishOnly": "pnpm run build",
     "watch": "tsc -w",
     "typecheck": "tsc --noEmit",
-    "lint": "yarn run lint:prettier && yarn run lint:eslint",
-    "lint:prettier": "node --max-old-space-size=4096 node_modules/.bin/prettier --check \"src/**/*.{js,ts,tsx}\"",
-    "lint:eslint": "node --max-old-space-size=4096 node_modules/.bin/eslint --quiet --ext ts,tsx src",
-    "lint:fix": "node --max-old-space-size=4096 node_modules/.bin/prettier --write --check \"src/**/*.{js,ts,tsx}\" && eslint --ext ts,tsx --fix src",
+    "lint": "pnpm run lint:prettier && pnpm run lint:eslint",
+    "lint:prettier": "NODE_OPTIONS=\"--max-old-space-size=4096\" prettier --check \"src/**/*.{js,ts,tsx}\"",
+    "lint:eslint": "NODE_OPTIONS=\"--max-old-space-size=4096\" eslint --quiet --ext ts,tsx src",
+    "lint:fix": "NODE_OPTIONS=\"--max-old-space-size=4096\" prettier --write --check \"src/**/*.{js,ts,tsx}\" && eslint --ext ts,tsx --fix src",
     "prerelease": "gitpkg publish",
     "test": "jest"
   },