chore: use corepack & yarn v4 (#515)

Author: nihalgonsalves

.devcontainer/Dockerfile

@@ -0,0 +1,3 @@
+FROM mcr.microsoft.com/devcontainers/javascript-node:20
+
+RUN corepack enable

.devcontainer/devcontainer.json

@@ -0,0 +1,13 @@
+{
+  "name": "Node.js",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+    }
+  },
+  "onCreateCommand": "yarn install",
+  "remoteUser": "node"
+}

.github/workflows/check.yml

@@ -5,17 +5,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      # waiting on: https://github.com/actions/setup-node/issues/531
+      - run: corepack enable
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'npm'
+          cache: 'yarn'
       - name: run eslint
         run: |
-          npm ci
-          npm run build
-          npm run typecheck
-          npm run lint:check
-          npm run format:check
-          npm run sync
-        env:
-          CI: true
+          yarn install --immutable
+          yarn build
+          yarn typecheck
+          yarn lint:check
+          yarn format:check
+          yarn sync

.github/workflows/publish.yml

@@ -36,12 +36,15 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+      # waiting on: https://github.com/actions/setup-node/issues/531
+      - run: corepack enable
       - uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: 'https://registry.npmjs.org'
-          cache: 'npm'
-      - run: npm ci
+          cache: 'yarn'
+      - run: yarn install --immutable
       - env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        # yarn doesn't have an equivalent --provenance
         run: npm publish --provenance --access public

.github/workflows/sync.yml

@@ -12,12 +12,14 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ssh-key: ${{ secrets.ACTION_DEPLOY_KEY }}
+      # waiting on: https://github.com/actions/setup-node/issues/531
+      - run: corepack enable
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'npm'
-      - run: npm ci
-      - run: npm run sync
+          cache: 'yarn'
+      - run: yarn install --immutable
+      - run: yarn sync
       - name: git config
         run: |
           git config --local user.name "GitHub Actions"

.github/workflows/test.yml

@@ -5,19 +5,21 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+      # waiting on: https://github.com/actions/setup-node/issues/531
+      - run: corepack enable
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'npm'
+          cache: 'yarn'
       - name: Install deps, build, then clear deps
         run: |
-          npm ci
-          npm run build
+          yarn install --immutable
+          yarn build
           rm -rf node_modules
       - name: Test on Node 20
         run: |
           node -v
-          npm run test
+          node bin/test.js
       # Not using a matrix here since it's simpler
       # to just duplicate it and not spawn new instances
       - uses: actions/setup-node@v4
@@ -26,4 +28,4 @@ jobs:
       - name: Test on Node 18
         run: |
           node -v
-          npm run test
+          node bin/test.js

.gitignore

@@ -54,8 +54,15 @@ typings/
 # Output of 'npm pack'
 *.tgz
 
-# Yarn Integrity file
+# Yarn
 .yarn-integrity
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
 
 # dotenv environment variables file
 .env

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules