Migrate to yarn

.github/workflows/psammead-change-scanner.yml

@@ -17,7 +17,7 @@ jobs:
           persist-credentials: false
 
       - name: Install Node Modules
-        run: npm run ci:packages
+        run: yarn ci:packages
 
       - name: Change Scanner
-        run: npm run changeScanner
+        run: yarn changeScanner

.github/workflows/psammead-chromaticqa.yml

@@ -27,7 +27,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - name: Install Node Modules
-        run: npm run ci:packages
+        run: yarn ci:packages
 
       - name: Chromatic UI Tests
         if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == 'bbc/psammead' }}

.github/workflows/psammead-deploy-storybook.yml

@@ -18,8 +18,8 @@ jobs:
 
       - name: Install Node Modules and Build
         run: |
-          npm run ci:packages
-          npm run build:storybook
+          yarn ci:packages
+          yarn build:storybook
           git config --global user.name "simorgh-bbc"
           git config --global user.email "[email protected]"
 

.github/workflows/psammead-manual-talos.yml

@@ -22,7 +22,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - name: Install Node Modules
-        run: npm install
+        run: yarn install
 
       - name: Run Talos
         run: |

.github/workflows/psammead-publish.yml

@@ -22,10 +22,10 @@ jobs:
           scope: '@bbc'
 
       - name: Install Node Modules
-        run: npm run ci:packages
+        run: yarn ci:packages
 
       - name: Publish to NPM
-        run: npm run publish
+        run: yarn publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}
 

.github/workflows/psammead-storybook-preview.yml

@@ -22,8 +22,8 @@ jobs:
       - name: Install Node Modules and Build
         if: github.event.pull_request.closed != true # Run this step for all PR events except `closed`
         run: |
-          npm run ci:packages
-          npm run build:storybook
+          yarn ci:packages
+          yarn build:storybook
 
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v1

.github/workflows/psammead-unit-tests.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Install Node Modules
         run: |
           echo ${GITHUB_REF##*/}
-          npm run ci:packages
+          yarn ci:packages
 
       - name: Setup Code Climate Test Coverage
         # Only run if the workflow started from bbc/psammead i.e. not a fork.
@@ -53,7 +53,7 @@ jobs:
           ./cc-test-reporter before-build
 
       - name: Unit Tests
-        run: npm run test:ci
+        run: yarn test:ci
 
       - name: Report Code Climate Test Coverage
         # Only run if the workflow started from bbc/psammead i.e. not a fork.

.yarnrc

@@ -0,0 +1 @@
+version=1.22.10

.yeoman/README.md

@@ -6,7 +6,7 @@ We are expecting the Psammead component library to expand in size. To ensure a u
 
 ## How to use it?
 
-Run `npm run create:package`.
+Run `yarn create:package`.
 
 CLI will prompt user to enter their desired pacakge name, description of package and author details.
 

.yeoman/src/fs-actions/index.js

@@ -2,7 +2,7 @@ const shell = require('shelljs');
 
 exports.install = () =>
   new Promise((resolve, reject) => {
-    const response = shell.exec('npm install --quiet');
+    const response = shell.exec('yarn install --silent');
     if (response.code === 0) {
       resolve(response.output);
     } else {

.yeoman/src/fs-actions/index.test.js

@@ -6,13 +6,13 @@ jest.mock('shelljs', () => ({
 }));
 
 describe('File system actions', () => {
-  it('should successfully npm install', () => {
+  it('should successfully yarn install', () => {
     shell.exec.mockReturnValue({ code: 0, output: 'success' });
 
     expect(fsActions.install()).toEqual(Promise.resolve('success'));
   });
 
-  it('should unsuccessfully npm install', () => {
+  it('should unsuccessfully yarn install', () => {
     shell.exec.mockReturnValue({ code: 99, output: 'error' });
 
     expect(fsActions.install()).toEqual(Promise.reject('error'));

CHANGELOG.md

@@ -3,6 +3,7 @@
 <!-- prettier-ignore -->
 | Version | Description |
 |---------|-------------|
+| 4.0.98 | [PR#4335](https://github.com/bbc/psammead/pull/4335) switch to yarn for package management |
 | 4.0.97 | [PR#4330](https://github.com/bbc/psammead/pull/4330) Talos - Bump Dependencies - @bbc/psammead-episode-list |
 | 4.0.96 | [PR#4307](https://github.com/bbc/psammead/pull/4307) Talos - Bump Dependencies - @bbc/psammead-radio-schedule |
 | 4.0.95 | [PR#4306](https://github.com/bbc/psammead/pull/4306) Talos - Bump Dependencies - @bbc/psammead-brand, @bbc/psammead-bulletin, @bbc/psammead-episode-list, @bbc/psammead-media-player, @bbc/psammead-most-read, @bbc/psammead-radio-schedule, @bbc/psammead-timestamp-container |

CONTRIBUTING.md

@@ -1,7 +1,9 @@
 # Contributing
 
 ## Documentation index
+
 Please familiarise yourself with our:
+
 - [Code of conduct](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md)
 - [Code Standards and Ways of Working](https://github.com/bbc/psammead/blob/latest/Code-Standards-and-Ways-of-Working.md)
 - [Contributing guidelines](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md) (you are here)
@@ -21,14 +23,12 @@ We appreciate all forms of contribution - not just code. Contribution can includ
 
 Psammead's "Definition of Done" is not only when a package is published but when all the Psammead packages that consume that package are updated. We use [Talos (package bumping bot)](https://github.com/bbc/psammead/blob/latest/scripts/talos/README.md) to automate much of this bumping process.
 
-
 Fundamentally, Psammead components are intended to be:
 
 Presentational (most of them, we do have other kinds of packages)
 GEL-Compliant
 Accessible
 
-
 ### What does that mean?
 
 #### Presentational
@@ -50,17 +50,19 @@ Finally, Psammead components are built and tested against the [BBC News assistiv
 ## Developing with Psammead
 
 ### Create a new package
+
 It is autogenerated via:
+
 ```
-npm run create:package
+yarn create:package
 ```
 
 ### Edit existing packages
 
 1. Find a Psammead component you wish you to work on, in your project from the [directory of available packages](https://github.com/bbc/psammead/tree/latest/packages), or by running `npx lerna list` inside the repo.
 2. To install the package in your local development, run:
    ```
-   npm install @bbc/psammead-<component_name>
+   yarn add @bbc/psammead-<component_name>
    ```
 3. See the README for the respective the Psammead component, to see the required props, usage example and use-cases for it.
 
@@ -71,11 +73,13 @@ When making changes to a package locally if you want to pull those changes into
 Run the following command to link all psammead packages up regardless of dependency version:
 
 ```
-npm run install:packages --force-local
+yarn install:packages --force-local
 ```
 
 ## The package publish, deprecation, and alpha publication process
+
 <!-- TODO: Add this, also consider where to mention npm linking, either here or in the packages README -->
+
 ### Alpha Components
 
 #### Description
@@ -104,4 +108,3 @@ The accepted uses of an Alpha Component are:
 - The alpha component **CAN NOT** be used in a live/production page.
 - Any P1 bugs that come out of the a11y swarm need to be fixed before the component comes out of Alpha and goes live, P2 and lower can be fixed after.
 - For functional issues the functionality must work on the biggest browsers on the services it's released on. This can be worked out by looking at a combination of our [browser support](https://github.com/bbc/psammead#bar_chart-support-levels) and browser usage statistics for different services.
-

Code-Standards-and-Ways-of-Working.md

@@ -78,8 +78,8 @@ Storybook publishes components in an iframe within the Storybook UI, this will b
 
 If you have a PR that is not yet merged and you need to preview this on another device, you can do so in Storybook via tunnelling:
 
-- Install packages ‘npm run install:packages’
-- Run storybook ‘npm run storybook’
+- Install packages ‘yarn install:packages’
+- Run storybook ‘yarn storybook’
 - Run your tunnelling tool on the Storybook port
 - In Storybook [open the component in another tab](#open-the-component-in-a-tab)
 

README.md

@@ -42,44 +42,52 @@ NB there is further documentation colocated with relevant packages and code. The
 git clone [email protected]:bbc/psammead.git
 ```
 
+#### Install Yarn
+
+The Psammead project uses Yarn for package management. It is recommended to install Yarn through the npm package manager, which comes bundled with Node.js when you install it on your system. To install Yarn, run this command:
+
+```
+npm install --global yarn
+```
+
 ### :hammer: Setup Local Environment
 
 ```
-cd psammead && npm run install:packages
+cd psammead && yarn install:packages
 ```
 
-N.B. When merging branches, the `npm run install:packages` command should be favoured over `npm install`. [More details available here](https://github.com/bbc/psammead/pull/264).
+N.B. When merging branches, the `yarn install:packages` command should be favoured over `yarn install`. [More details available here](https://github.com/bbc/psammead/pull/264).
 
 ### :runner: Run tests
 
-Install dependencies locked to `package-lock.json`:
+Install dependencies locked to `yarn.lock`:
 
 ```
-npm run ci:packages
+yarn ci:packages
 ```
 
-(NB: You can't reliably run the jest tests when the packages are linked locally, as they may have been linked across breaking changes. Running `npm run ci:packages` resets all links. To update snapshots within unit tests, run `npm run test:unit -- -u`.)
+(NB: You can't reliably run the jest tests when the packages are linked locally, as they may have been linked across breaking changes. Running `yarn ci:packages` resets all links. To update snapshots within unit tests, run `yarn test:unit -- -u`.)
 
 Run the component tests:
 
 ```
-npm test
+yarn test
 ```
 
-This runs Jest across any packages matching this glob pattern: `packages/components/**/*.test.jsx`. It also runs each package's `npm test` command if it is defined
+This runs Jest across any packages matching this glob pattern: `packages/components/**/*.test.jsx`. It also runs each package's `yarn test` command if it is defined
 
 ### :runner: Run Storybook
 
 ```
-npm run storybook
+yarn storybook
 ```
 
 NB, we've defined global styles (normalize, box-sizing, Reith font) in the [Storybook config](https://github.com/bbc/psammead/blob/latest/.storybook/config.js) so that components render as expected.
 
 ### :construction_worker: Build Packages/Components
 
 ```
-npm run build
+yarn build
 ```
 
 ### :computer: Developing with Psammead
@@ -158,7 +166,7 @@ The access value is [restricted by NPM](https://docs.npmjs.com/misc/config#acces
 The Psammead Storybook is hosted on GitHub pages at http://bbc.github.io/psammead. It is currently deployed via a local script that builds Storybook to the `gh-pages` git branch which is used by GitHub pages.
 
 ```
-npm run deploy-storybook
+yarn deploy-storybook
 ```
 
 NB, this automatically pushes to the 'gh-pages' branch, which deploys to the live GitHub pages site. Please only run this script on the `latest` branch.

lerna.json

@@ -1,11 +1,10 @@
 {
+  "npmClient": "yarn",
   "command": {
     "bootstrap": {
-      "npmClientArgs": ["--no-package-lock"]
+      "npmClientArgs": ["--no-lockfile"]
     }
   },
-  "packages": [
-    "packages/*/*"
-  ],
+  "packages": ["packages/*/*"],
   "version": "independent"
 }