build: migrate to yarn v3 (#597)

.github/actions/install/action.yml

@@ -11,23 +11,61 @@ inputs:
 runs:
   using: composite
   steps:
+    - name: ⚙️ Enable Corepack
+      run: corepack enable
+      shell: bash
+
     - name: Cache prep
-      id: yarn-cache-dir-path
-      run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+      id: yarn-config
+      run: |
+        echo "CACHE_FOLDER=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
+        echo "node-version="node-$(node --version)"" >> $GITHUB_OUTPUT
       shell: bash
+      env:
+        YARN_ENABLE_GLOBAL_CACHE: 'false'
+
+    - name: Restore yarn cache
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.yarn-config.outputs.CACHE_FOLDER }}
+        key: yarn-download-cache-${{ hashFiles('**/yarn.lock', '.yarnrc.yml') }}
+        restore-keys: |
+          yarn-download-cache-
+
+    - name: Restore node_modules
+      id: yarn-nm-cache
+      uses: actions/cache@v3
+      with:
+        path: node_modules
+        key: yarn-nm-cache-${{ runner.os }}-${{ steps.yarn-config.outputs.node-version }}-${{ github.ref }}-${{ hashFiles('**/yarn.lock', '.yarnrc.yml') }}
 
-    - name: Cache yarn
+    - name: Restore yarn install state
+      id: yarn-install-state-cache
       uses: actions/cache@v3
       with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: cache-${{ inputs.node-version }}-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+        path: .yarn/
+        key: yarn-install-state-cache-${{ runner.os }}-${{ steps.yarn-config.outputs.node-version }}-${{ github.ref }}-${{ hashFiles('**/yarn.lock', '.yarnrc.yml') }}
 
     - name: Install dependencies in production mode
       if: ${{ inputs.prod-context == 'true' }}
-      run: yarn install --immutable --immutable-cache --check-cache --frozen-lockfile --prod
+      run: yarn install --immutable --check-cache --prod
       shell: bash
+      env:
+        # Overrides/align yarnrc.yml options (v3, v4) for a CI context
+        YARN_ENABLE_GLOBAL_CACHE: 'false' # Use local cache folder to keep downloaded archives
+        YARN_NM_MODE: 'hardlinks-local' # Reduce node_modules size
+        YARN_INSTALL_STATE_PATH: '.yarn/install-state.gz' # Might speed up resolution step when node_modules present
+        # Other environment variables
+        HUSKY: '0' # By default do not run HUSKY install
 
     - name: Install dependencies in integration mode
       if: ${{ inputs.prod-context == 'false' }}
-      run: yarn install --immutable --immutable-cache --check-cache --frozen-lockfile
+      run: yarn install --immutable --check-cache
       shell: bash
+      env:
+        # Overrides/align yarnrc.yml options (v3, v4) for a CI context
+        YARN_ENABLE_GLOBAL_CACHE: 'false' # Use local cache folder to keep downloaded archives
+        YARN_NM_MODE: 'hardlinks-local' # Reduce node_modules size
+        YARN_INSTALL_STATE_PATH: '.yarn/install-state.gz' # Might speed up resolution step when node_modules present
+        # Other environment variables
+        HUSKY: '0' # By default do not run HUSKY install

.github/linters/.cspell.json

@@ -1,12 +1,11 @@
 {
     "ignorePaths": [
-	"CHANGELOG.md",
+	    "CHANGELOG.md",
         "**/node_modules/**",
         "**/.git/**",
-        ".vscode",
         "megalinter",
-        "yarn.lock",
-        "report"
+        "**/yarn.lock",
+        "**/.yarnrc.yml"
     ],
     "language": "en",
     "noConfigSearch": true,
@@ -18,10 +17,13 @@
         "Cherfaoui",
         "Colladon",
         "Commitlint",
+        "Corepack",
+        "corepack",
         "FORCEIGNORE",
         "FORCEINCLUDE",
         "FULLNAME",
         "Flexi",
+        "hardlinks",
         "Iframe",
         "METAFILE",
         "Mehdi",
@@ -141,6 +143,7 @@
         "weblinks",
         "wlens",
         "xmlbuilder",
+        "yarnrc",
         "\u00c0gain"
     ]
 }

.github/workflows/on-pull-request.yml

@@ -25,6 +25,11 @@ jobs:
           fetch-depth: 0
 
       - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Setup dependencies, cache and install
         uses: ./.github/actions/install
 
       - name: Lint commits
@@ -53,11 +58,14 @@ jobs:
           node-version: 16
           registry-url: https://registry.npmjs.org/
 
+      - name: Setup dependencies, cache and install
+        uses: ./.github/actions/install
+
       - name: Check outdated dependencies
-        run: yarn outdated
+        run: npm outdated
 
       - name: Audit dependencies
-        run: yarn audit
+        run: yarn npm audit
 
   megalinter:
     runs-on: ubuntu-latest
@@ -147,7 +155,7 @@ jobs:
 
       - name: Install dependencies in production mode
         working-directory: ./plugin
-        run: yarn install --immutable --immutable-cache --check-cache --frozen-lockfile --prod
+        run: yarn workspaces focus --all --production
         shell: bash
 
       - name: Install build dependencies
@@ -164,6 +172,7 @@ jobs:
       - name: Install plugin
         working-directory: ./plugin
         run: |
+          yarn set version classic
           sfdx plugins:link .
           sfdx plugins
 

.gitignore

@@ -1,10 +1,13 @@
 /node_modules
 /reports
 /lib
+/.nyc_output
+/.yarn/cache
+install-state.gz
 *-debug.log
 *-error.log
 sfdx-git-delta-*.tgz
-/.nyc_output
+package.tgz
 stderr*.txt
 stdout*.txt
 # stryker temp files

.husky/pre-push

@@ -6,4 +6,4 @@ yarn pack
 yarn test:unit:coverage
 yarn test:nut
 yarn analysis force-app
-yarn outdated || true
+npm outdated || true

.yarnrc.yml

@@ -0,0 +1,7 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-workspace-tools.cjs
+    spec: "@yarnpkg/plugin-workspace-tools"
+
+yarnPath: .yarn/releases/yarn-3.5.1.cjs

package.json

@@ -76,7 +76,7 @@
     "@oclif/dev-cli": "^1.26.10",
     "@oclif/plugin-help": "^5.2.9",
     "@oclif/test": "^2.3.20",
-    "@salesforce/cli-plugins-testkit": "^3.3.6",
+    "@salesforce/cli-plugins-testkit": "^3.4.0",
     "@salesforce/dev-config": "^4.0.1",
     "@salesforce/ts-sinon": "^1.4.6",
     "@stryker-mutator/core": "^6.4.2",
@@ -114,5 +114,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "packageManager": "[email protected]"
 }