Bump to Yarn v4

.github/workflows/build-test.yml

@@ -14,13 +14,21 @@ jobs:
         node-version: [16.x, 18.x]
     steps:
     - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+    - name: Install Corepack via Node
+      uses: actions/setup-node@v4
+      with:
+        node-version-file: '.nvmrc'
+    - name: Install Yarn
+      run: corepack enable
+    - name: Install Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-    - run: yarn
+    - name: Install dependencies via Yarn
+      run: yarn --immutable
     - run: yarn build
     - run: yarn test
+
   all-jobs-pass:
     name: All jobs pass
     runs-on: ubuntu-20.04

.github/workflows/publish-docs.yml

@@ -23,17 +23,19 @@ jobs:
         run: exit 1
       - name: Checkout the repository
         uses: actions/checkout@v4
-      - name: Use Node.js
+      - name: Install Corepack via Node
         uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
-          cache: 'yarn'
+      - name: Install Yarn
+        run: corepack enable
+      - name: Install dependencies via Yarn
+        run: yarn --immutable
       - uses: actions/cache@v3
         id: restore-build
         with:
           path: |
             ./dist
-            ./node_modules/.yarn-state.yml
           key: ${{ github.sha }}
       - name: Deploy to `${{ inputs.destination_dir }}` directory of `gh-pages` branch
         uses: peaceiris/actions-gh-pages@de7ea6f8efb354206b205ef54722213d99067935

.github/workflows/publish-release.yml

@@ -28,17 +28,17 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ref: ${{ github.sha }}
-      - name: Setup Node.js
+      - name: Install Corepack via Node
         uses: actions/setup-node@v4
         with:
-          node-version-file: ".nvmrc"
+          node-version-file: '.nvmrc'
+      - name: Install Yarn
+        run: corepack enable
       - uses: MetaMask/action-publish-release@v3
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Install
-        run: |
-          yarn install
-          yarn build
+      - run: yarn --immutable
+      - run: yarn build
       - uses: actions/cache@v3
         id: restore-build
         with:
@@ -53,6 +53,12 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ref: ${{ github.sha }}
+      - name: Install Corepack via Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+      - name: Install Yarn
+        run: corepack enable
       - uses: actions/cache@v3
         id: restore-build
         with:
@@ -73,6 +79,12 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ref: ${{ github.sha }}
+      - name: Install Corepack via Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+      - name: Install Yarn
+        run: corepack enable
       - uses: actions/cache@v3
         id: restore-build
         with:

.gitignore

@@ -2,3 +2,13 @@ node_modules
 build
 dist
 *.tgz
+
+# yarn v3 (w/o zero-install)
+# See: https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.yarn/plugins/@yarnpkg/plugin-allow-scripts.cjs

@@ -0,0 +1,9 @@
+/* eslint-disable */
+//prettier-ignore
+module.exports = {
+name: "@yarnpkg/plugin-allow-scripts",
+factory: function (require) {
+var plugin=(()=>{var a=Object.create,l=Object.defineProperty;var i=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var p=Object.getPrototypeOf,c=Object.prototype.hasOwnProperty;var u=e=>l(e,"__esModule",{value:!0});var f=e=>{if(typeof require!="undefined")return require(e);throw new Error('Dynamic require of "'+e+'" is not supported')};var g=(e,o)=>{for(var r in o)l(e,r,{get:o[r],enumerable:!0})},m=(e,o,r)=>{if(o&&typeof o=="object"||typeof o=="function")for(let t of s(o))!c.call(e,t)&&t!=="default"&&l(e,t,{get:()=>o[t],enumerable:!(r=i(o,t))||r.enumerable});return e},x=e=>m(u(l(e!=null?a(p(e)):{},"default",e&&e.__esModule&&"default"in e?{get:()=>e.default,enumerable:!0}:{value:e,enumerable:!0})),e);var k={};g(k,{default:()=>d});var n=x(f("@yarnpkg/shell")),y={hooks:{afterAllInstalled:async()=>{let e=await(0,n.execute)("yarn run allow-scripts");e!==0&&process.exit(e)}}},d=y;return k;})();
+return plugin;
+}
+};

.yarnrc.yml

@@ -0,0 +1,17 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+enableScripts: false
+
+enableTelemetry: 0
+
+logFilters:
+  - code: YN0004
+    level: discard
+
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-allow-scripts.cjs
+    spec: "https://raw.githubusercontent.com/LavaMoat/LavaMoat/main/packages/yarn-plugin-allow-scripts/bundles/@yarnpkg/plugin-allow-scripts.js"

README.md

@@ -21,7 +21,11 @@ You can contribute to the API specs using the following steps.
 
 1. Edit the API specs in the `openrpc.yaml` file.
    See the [OpenRPC](https://open-rpc.org/) docs for more information on how to format the specs.
-2. Run `yarn install` if you haven't previously set up the repository.
+2. If you haven't previously set up the repository:
+   1. Install [Node.js](https://nodejs.org) 18
+     - If you are using [nvm](https://github.com/creationix/nvm#installation) (recommended) running `nvm install` will install the latest version and running `nvm use` will automatically choose the right node version for you.
+   2. Install [Yarn](https://yarnpkg.com) v4 via [Corepack](https://github.com/nodejs/corepack?tab=readme-ov-file#how-to-install)
+   3. Run `yarn install` to install dependencies and run any required post-install scripts
 3. Run `yarn run build` to re-generate the output file: `dist/build/openrpc.json`.
 4. To view the result, paste that file's contents into the
    [OpenRPC playground](https://playground.open-rpc.org/).

package.json

@@ -24,6 +24,8 @@
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
+    "@lavamoat/allow-scripts": "^3.0.4",
+    "@lavamoat/preinstall-always-fail": "^2.0.0",
     "@open-rpc/meta-schema": "^1.14.2",
     "@open-rpc/schema-utils-js": "^1.16.1",
     "@types/jest": "^29.2.6",
@@ -36,5 +38,11 @@
     "ts-jest": "^29.0.5",
     "typescript": "~4.8.4"
   },
-  "version": "0.11.0"
+  "version": "0.11.0",
+  "packageManager": "yarn@4.7.0",
+  "lavamoat": {
+    "allowScripts": {
+      "@lavamoat/preinstall-always-fail": false
+    }
+  }
 }