AXON-1209: Migration: npm → Yarn v4 (Berry)

.github/PULL_REQUEST_TEMPLATE.md

@@ -29,8 +29,8 @@ In particular, if you're making changes not covered by tests - please describe t
 
 Basic checks:
 
-- [ ] `npm run lint`
-- [ ] `npm run test`
+- [ ] `yarn lint`
+- [ ] `yarn test`
 
 Advanced checks: 
 - [ ] If Atlassian employee & Bitbucket changes: did you test with DC in mind? [See Instructions](https://www.loom.com/share/71e5d17734a547f68fd6128be6cd760e?sid=835e58a7-1240-498d-b2d7-fa7fdf8ffa36)

.github/workflows/build.yaml

@@ -21,19 +21,25 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'npm'
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Cache Yarn dependencies
+        uses: actions/cache@v4
+        with:
+          path: .yarn/cache
+          key: yarn-cache-${{ hashFiles('yarn.lock') }}
+          restore-keys: yarn-cache-
 
       - name: Install dependencies
-        run: |
-          npm ci --no-audit
+        run: yarn install --immutable
 
       - name: Run vulnerability audit
-        # "There is no Vulnerability in Media Viewer after 48.5.4. since it was fixed by patching, but npm audit still reports it.",
-        # So that switched to audit-ci with allowlist
-        run: npx audit-ci --config=".audit-ci.json"
+        run: yarn npm audit --recursive --no-deprecations
 
       - name: Run linter
-        run: npm run lint
+        run: yarn lint
 
   ci-matrix:
     needs: [lint]
@@ -63,22 +69,31 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'npm'
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Cache Yarn dependencies
+        uses: actions/cache@v4
+        with:
+          path: .yarn/cache
+          key: yarn-cache-${{ hashFiles('yarn.lock') }}
+          restore-keys: yarn-cache-
 
       - name: Install dependencies
-        run: npm ci --no-audit
+        run: yarn install --immutable
 
       - name: Run unit tests
         if: matrix.kind == 'unit'
-        run: npm run test
+        run: yarn test
 
       - name: Build and package the extension
         if: matrix.kind == 'e2e'
-        run: npm run extension:package
+        run: yarn extension:package
 
       - name: Generate SSL certs for E2E test
         if: matrix.kind == 'e2e'
-        run: npm run test:e2e:sslcerts
+        run: yarn test:e2e:sslcerts
 
       - name: Fetch E2E image
         if: matrix.kind == 'e2e'
@@ -88,7 +103,7 @@ jobs:
 
       - name: Run E2E (${{ matrix.target }})
         if: matrix.kind == 'e2e'
-        run: npm run test:e2e:docker
+        run: yarn test:e2e:docker
         env:
           TARGET: ${{ matrix.target }}
 

.github/workflows/release-nightly.yaml

@@ -36,25 +36,34 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'npm'
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Cache Yarn dependencies
+        uses: actions/cache@v4
+        with:
+          path: .yarn/cache
+          key: yarn-cache-${{ hashFiles('yarn.lock') }}
+          restore-keys: yarn-cache-
 
       - name: Set version in package.json
-        run: npm version $PACKAGE_VERSION --no-git-tag-version --allow-same-version -f
+        run: yarn version $PACKAGE_VERSION --immediate
 
       - name: Install dependencies
-        run: npm ci --no-audit
+        run: yarn install --immutable
 
       - name: Build and package the extension for pre-release
-        run: npm run extension:package:prerelease
+        run: yarn extension:package:prerelease
 
       - name: Run linter
-        run: npm run lint
+        run: yarn lint
 
       - name: Run unit tests
-        run: npm run test:nocoverage
+        run: yarn test:nocoverage
 
       - name: Generate SSL certs for E2E test
-        run: npm run test:e2e:sslcerts
+        run: yarn test:e2e:sslcerts
 
       - name: Fetch E2E image
         run: |

.github/workflows/release.yaml

@@ -43,25 +43,34 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20
-          cache: 'npm'
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Cache Yarn dependencies
+        uses: actions/cache@v4
+        with:
+          path: .yarn/cache
+          key: yarn-cache-${{ hashFiles('yarn.lock') }}
+          restore-keys: yarn-cache-
 
       - name: Set version in package.json
-        run: npm version $PACKAGE_VERSION --no-git-tag-version --allow-same-version -f
+        run: yarn version $PACKAGE_VERSION --immediate
 
       - name: Install dependencies
-        run: npm ci --no-audit
+        run: yarn install --immutable
 
       - name: Build and package the extension
-        run: npm run extension:package
+        run: yarn extension:package
 
       - name: Run linter
-        run: npm run lint
+        run: yarn lint
 
       - name: Run unit tests
-        run: npm run test:nocoverage
+        run: yarn test:nocoverage
 
       - name: Generate SSL certs for E2E test
-        run: npm run test:e2e:sslcerts
+        run: yarn test:e2e:sslcerts
 
       - name: Fetch E2E image
         run: |

.gitignore

@@ -7,7 +7,13 @@ node_modules
 launch.json
 *.vsix
 .yo-*
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
 yarn-error.log
+
 *.pem
 *.crt
 *.p12

.vscode/launch.json.example

@@ -20,7 +20,7 @@
             "envFile": "${workspaceFolder}/.env"
         },
         {
-            // This configuration requires npm run dev to be running externally
+            // This configuration requires yarn dev to be running externally
             // It will pick up the re-compiled extension code but not hot-swap it 
             "name": "Extension (watch/external)",
             "type": "extensionHost",

.vscodeignore

@@ -1,57 +1,81 @@
-# Allowed:
+# ---- ALLOWED ----
 # build/
 # resources/
 # images/
 # LICENSE
 
-__mocks__/
-__tests__/
-.generated/
-e2e/
-.npm/
+# ---- IGNORED ----
 
-# Don't package anything from here specifically:
-resources/rovo-dev/
+# Source code
+src/**
+
+# Test
+testsutil/**
+__mocks__/**
+__tests__/**
+e2e/**
+coverage/**
+test-results/**
+.vscode-test/**
+*.test.ts
+*.test.tsx
+*.spec.ts
+*.spec.tsx
 
+# Build configs
+webpack.*
+tsconfig.json
+tsconfig.notest.json
+eslint.config.mjs
+jest.config.ts
+jest.react.config.ts
+jest.unit.config.ts
+playwright.config.js
+.prettierignore
+.nvmrc
+
+# Dev files
 .env
 .env.example
-.nvmrc
-.prettierignore
+.devcontainer/**
+.github/**
+.vscode/**
+.readme/**
+devhtml/**
+scripts/**
+.gitignore
+bitbucket-pipelines.yml
 CODEOWNERS
-changelog.md
 nightlyver.sh
-package.json
-readme.md
-eslint.config.mjs
-tsconfig.json
-tsconfig.notest.json
 vscode-stylenames.txt
-.devcontainer/
-.github/
-coverage/
-scripts/
-test-results/
-
-.vscode/
-.vscode-test/
-out/test/
+.eslintcache
+
+# node_modules
+node_modules/**
+!node_modules/@vscode/codicons/dist/**
+
+# Yarn cache and internals
+.yarn/**
+!.yarn/releases
+!.yarn/plugins
+.yarnrc.yml
+yarn.lock
+
+# Source maps
+**/*.map
 out/**/*.map
-src/
-testsutil/
-.gitignore
-bitbucket-pipelines.yml
+build/**/*.map
+
+# Certificates
 *.pem
 *.crt
 *.p12
 *.vsix
 *.orig
-node_modules/
-!node_modules/@vscode/codicons/dist/**
-webpack.*
-build/**/*.map
-.readme/
-devhtml/
-jest.config.ts
-jest.react.config.ts
-jest.unit.config.ts
-playwright.config.js
+
+# Generated files
+.generated/**
+.npm/**
+
+# Don't package anything from here specifically:
+resources/rovo-dev/**

.yarnrc.yml

@@ -0,0 +1,12 @@
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+npmAuditExcludePackages:
+# This package isnt used directly in the code but remains as a dependency of @atlaskit/media-viewer package for internal support reasons
+# TODO: Remove this once @atlaskit/media-viewer is updated to a version that doesn't depend on this package
+# See https://asecurityteam.atlassian.net/browse/PBAC-2014
+
+  - pdfjs-dist
+
+nodeLinker: node-modules

README.md

@@ -90,7 +90,7 @@ https://support.atlassian.com/bitbucket-cloud/docs/use-the-atlassian-for-vs-code
 
 Running and debugging the extension:
 
--   Atlassian for VS Code is a node project, as such you'll need to run `npm install` before building.
+-   Atlassian for VS Code is a node project, as such you'll need to run `yarn install` before building.
 -   To debug the extension from within VS Code you'll need a `launch.json`.
     ** An example `launch.json` that will be suitable for most users is included as `.vscode/launch.json.example`.
     ** To use the example file simply copy it to `launch.json`.
@@ -119,7 +119,7 @@ VSCode provides some very helpful [documentation](https://code.visualstudio.com/
 To run `atlascode` in such a way, please follow the VSCode documentation:
 
 -   Install [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) VSCode Extension
--   Run `npm install` like you normally would
+-   Run `yarn install` like you normally would
 -   In VSCode, choose `Dev Containers: Rebuild and Reopen in Container` from the command pallette
 -   Wait for the VSCode to re-open in the container evnironment - you'll be able to see the difference in the header/search bar
 -   Proceed to run or debug the extension as usual - it will now be running as it would in remote execution
@@ -133,7 +133,7 @@ Note: for advanced use-cases, it is possible to run scripts in dev containers vi
 ## Tests
 
 ```
-npm run test
+yarn test
 ```
 
 ## Contributions

e2e/Dockerfile

@@ -3,7 +3,7 @@ FROM node:23-slim
 # Install dependencies and xvfb
 RUN apt-get update \
     && apt-get install -y wget gpg xauth curl git \
-    && npm install --global playwright@1.56.1 \
+    && yarn global add playwright@1.56.1 \
     && npx playwright install --with-deps chromium
 
 # install code-server