Merge pull request #2148 from ably/npm-to-yarn-1.x

chore: migrate npm to Yarn 1 for inter-repo package manager consistency

.circleci/config.yml

@@ -15,28 +15,28 @@ executors:
       - image: cimg/node:18.12.0
 
 commands:
-  restore-npm-cache:
+  restore-yarn-cache:
     steps:
       - restore_cache:
-          name: Restore NPM Package Cache
+          name: Restore Yarn Package Cache
           keys:
-            - npm-packages-v2-{{ .Branch }}-{{ checksum "package-lock.json" }}
-            - npm-packages-v2-{{ .Branch }}-
-            - npm-packages-v2-
+            - yarn-packages-v2-{{ .Branch }}-{{ checksum "yarn.lock" }}
+            - yarn-packages-v2-{{ .Branch }}-
+            - yarn-packages-v2-
 
-  save-npm-cache:
+  save-yarn-cache:
     steps:
       - save_cache:
-          name: Save NPM Package Cache
-          key: npm-packages-v1-{{ .Branch }}-{{ checksum "package-lock.json" }}
+          name: Save Yarn Package Cache
+          key: yarn-packages-v1-{{ .Branch }}-{{ checksum "yarn.lock" }}
           paths:
-            - ~/.cache/npm
+            - ~/.cache/yarn
 
-  npm-install:
+  yarn-install:
     steps:
       - run:
           name: Dependencies
-          command: npm ci --prefer-offline --cache ~/.cache/npm
+          command: yarn install --frozen-lockfile
 
   build-nginx:
     steps:
@@ -70,13 +70,13 @@ jobs:
     resource_class: medium+
     steps:
       - checkout
-      - restore-npm-cache
-      - npm-install
+      - restore-yarn-cache
+      - yarn-install
       - persist_to_workspace:
           root: .
           paths:
             - node_modules
-      - save-npm-cache
+      - save-yarn-cache
 
   install-nginx:
     executor:
@@ -94,13 +94,13 @@ jobs:
           at: .
       - run:
           name: Run linting
-          command: npm run lint
+          command: yarn lint
       - run:
           name: Install JUnit coverage reporter
-          command: npm install jest-junit
+          command: yarn add jest-junit
       - run:
           name: Run tests
-          command: npm test -- --ci --collectCoverage=true --coverageDirectory=coverage --coverageReporters=html --runInBand --reporters=default --reporters=jest-junit
+          command: yarn test -- --ci --collectCoverage=true --coverageDirectory=coverage --coverageReporters=html --runInBand --reporters=default --reporters=jest-junit
           environment:
             JEST_JUNIT_OUTPUT_DIR: ./reports/junit/
       - store_test_results:
@@ -123,7 +123,7 @@ jobs:
             sudo cp buildpack/nginx /usr/local/bin/nginx
       - run:
           name: Build
-          command: npm run build
+          command: yarn build
       - run:
           name: Require redirects file to be generated
           command: test -f config/nginx-redirects.conf

.githooks/README.md

@@ -2,8 +2,8 @@
 
 These are recommended git hooks for your project.
 
-You can activate them by running `npm run repo-githooks` and deactivate them by running `npm run no-githooks`.
+You can activate them by running `yarn repo-githooks` and deactivate them by running `yarn no-githooks`.
 
-`npm run repo-githooks` will set your `core.hooksPath` to the correct folder, an example of running this without `npm` might be `git config core.hooksPath .githooks` - but as the specifics may change it might be more convenient to rely on `npm run repo-githooks`.
+`yarn repo-githooks` will set your `core.hooksPath` to the correct folder, an example of running this without `yarn` might be `git config core.hooksPath .githooks` - but as the specifics may change it might be more convenient to rely on `yarn repo-githooks`.
 
-`npm run no-githooks` can be substituted at any time for `git config --unset core.hooksPath`.
+`yarn no-githooks` can be substituted at any time for `git config --unset core.hooksPath`.

.githooks/post-checkout

@@ -1,5 +1,5 @@
 #!/bin/sh
 
-npm install
+yarn
 
 exit 0

.githooks/pre-commit

@@ -1,3 +1,3 @@
 #!/bin/sh
 
-npm run lint-staged
+yarn lint-staged

.tool-versions

@@ -1,2 +1,3 @@
 ruby 3.0.0
 nodejs 18.12.0
+yarn 1.22.19

README.md

@@ -13,7 +13,7 @@ This is a static site generated using [Gatsby](https://www.gatsbyjs.com/) and do
 
 ## Run
 
-Install node & npm.
+Install node & yarn.
 
 If you use [ASDF](https://github.com/asdf-vm/asdf) or compatible tooling to manage your Ruby runtime versions, we have included a [`.tool-versions`](.tool-versions) file - where the dependencies within can be installed with `asdf install` from the project root.
 
@@ -24,37 +24,35 @@ brew install [email protected]
 RUBY_CONFIGURE_OPTS="--with-openssl-dir=$(brew --prefix [email protected])" asdf install ruby
 ```
 
-Note that if you `brew install`ed your asdf installation instead of `git clone`ing it, npm [may not be installed correctly](https://youtrack.jetbrains.com/issue/WEB-51052).
-
-`npm i`
+`yarn`
 
 If Gatsby CLI is not already installed:
 
-`npm install -g gatsby-cli`
+`yarn global add gatsby-cli`
 
 **Environment variables setup**
 
 If you have not yet [set up your local .env.development environment variables](#environment-variables), run:
 
-`npm run develop:env-setup`
+`yarn develop:env-setup`
 
 **Editors:**
 
-`npm run edit`
+`yarn edit`
 
 **Developers:**
 
 To develop locally run:
 
-`npm run develop`
+`yarn develop`
 
 Visit `localhost:8000` for homepage.
 
 Visit `localhost:8000/docs/${relativePath}` for documentation pages, e.g. `localhost:8000/docs/client-lib-development-guide/documentation-formatting-guide`.
 
 To build and serve locally:
 
-`npm run rebuild`
+`yarn rebuild`
 
 Visit `localhost:8000` for homepage.
 
@@ -114,7 +112,7 @@ We have selected folder-level README files instead of the alternative of a dedic
 
 ## Optional Setup Steps
 
-If you would like to run linting and tests automatically before every commit and run npm install automatically after every branch checkout, run `npm run repo-githooks`. If you would like to remove this behaviour, run `npm run no-githooks`.
+If you would like to run linting and tests automatically before every commit and run yarn install automatically after every branch checkout, run `yarn repo-githooks`. If you would like to remove this behaviour, run `yarn no-githooks`.
 
 To understand the data ingestion and parsing steps, please check the READMEs in the [/data folder](./data/README.md).
 

content/asset-tracking/example-apps.textile

@@ -105,7 +105,7 @@ blang[javascript].
   3. Then, build the SDK:
 
   ```[sh]
-  npm run build
+  yarn build
   ```
 
   4. Change into the @examples/subscribing-example-app@ directory and install the example app's dependencies:

content/tutorials/encryption.textile

@@ -539,13 +539,13 @@ blang[nodejs].
   Execute the following to start the subscription in first window
 
   ```[sh]
-    npm run app:subscribe
+    yarn app:subscribe
   ```
 
   Execute the following to publish a message in the second window
 
   ```[sh]
-    npm run app:publish
+    yarn app:publish
   ```
 
   Go back to your first terminal window and you should see the message in your terminal.

content/tutorials/peer-to-peer-vue.textile

@@ -666,7 +666,7 @@ And run the APIs
 
 ```[sh]
 $ cd api
-$ npm run start
+$ yarn start
 ```
 
 h2. Next Steps

how-tos/pub-sub/README.md

@@ -11,8 +11,8 @@ Try out the [live demo](https://ably.com/docs/how-to/pub-sub) of this how to.
 - Fork or clone the [Documentation](https://github.com/ably/docs).
 - Sign up for an account on [Ably](https://ably.com/sign-up?utm_source=ably-docs&utm_medium=github&utm_campaign=pub-sub) and get an API KEY.
 - Rename `.env.example` to `.env` and fill in your API KEY in the `VITE_ABLY_KEY` environment variable.
-- Run `npm` to install dependencies.
-- Run `npm run dev` and go to http://localhost:5173
+- Run `yarn` to install dependencies.
+- Run `yarn dev` and go to http://localhost:5173
 
 ## Runtime Requirements