Merge branch 'main' into mxdvl/constants

.github/workflows/CI.yml

@@ -27,11 +27,20 @@ jobs:
       - name: Setup node
         uses: guardian/actions-setup-node@main
 
+      - name: Cache .pnpm-store
+        uses: actions/[email protected]
+        with:
+          path: ~/.pnpm-store
+          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - name: Install pnpm
+        run: curl -f https://get.pnpm.io/v6.16.js | node - add --global pnpm@6
+
       - name: Install dependencies
-        uses: bahmutov/npm-install@v1
+        run: pnpm install
 
       - name: Run unit tests
-        run: 'yarn test --coverage --ci'
+        run: pnpm test:ci
 
       - name: Report coverage
         uses: coverallsapp/github-action@master
@@ -48,11 +57,20 @@ jobs:
       - name: Setup node
         uses: guardian/actions-setup-node@main
 
+      - name: Cache .pnpm-store
+        uses: actions/[email protected]
+        with:
+          path: ~/.pnpm-store
+          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - name: Install pnpm
+        run: curl -f https://get.pnpm.io/v6.16.js | node - add --global pnpm@6
+
       - name: Install dependencies
-        uses: bahmutov/npm-install@v1
+        run: pnpm install
 
       - name: Lint files
-        run: yarn lint
+        run: pnpm lint
   types:
     name: Types
     needs: [docs]
@@ -64,11 +82,20 @@ jobs:
       - name: Setup node
         uses: guardian/actions-setup-node@main
 
+      - name: Cache .pnpm-store
+        uses: actions/[email protected]
+        with:
+          path: ~/.pnpm-store
+          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - name: Install pnpm
+        run: curl -f https://get.pnpm.io/v6.16.js | node - add --global pnpm@6
+
       - name: Install dependencies
-        uses: bahmutov/npm-install@v1
+        run: pnpm install
 
       - name: Check types
-        run: yarn tsc
+        run: pnpm tsc
   build:
     name: Build
     needs: [docs]
@@ -82,11 +109,20 @@ jobs:
         with:
           node-version: ${{ env.NODE_VERSION }}
 
+      - name: Cache .pnpm-store
+        uses: actions/[email protected]
+        with:
+          path: ~/.pnpm-store
+          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - name: Install pnpm
+        run: curl -f https://get.pnpm.io/v6.16.js | node - add --global pnpm@6
+
       - name: Install dependencies
-        uses: bahmutov/npm-install@v1
+        run: pnpm install
 
       - name: Build package
-        run: yarn build
+        run: pnpm build
 
       - name: Save build
         if: github.ref == 'refs/heads/main'
@@ -109,8 +145,17 @@ jobs:
       - name: Setup node
         uses: guardian/actions-setup-node@main
 
+      - name: Cache .pnpm-store
+        uses: actions/[email protected]
+        with:
+          path: ~/.pnpm-store
+          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+
+      - name: Install pnpm
+        run: curl -f https://get.pnpm.io/v6.16.js | node - add --global pnpm@6
+
       - name: Install dependencies
-        uses: bahmutov/npm-install@v1
+        run: pnpm install
 
       - name: Fetch build
         uses: actions/download-artifact@v2

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn npm-run-all 'precommit:*'
+pnpm npm-run-all 'precommit:*'

.husky/pre-push

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn npm-run-all 'prepush:*'
+pnpm npm-run-all 'prepush:*'

.vscode/settings.json

@@ -12,7 +12,7 @@
 		"source.organizeImports": false
 	},
 	"eslint.format.enable": true,
-	"eslint.packageManager": "yarn",
+	"eslint.packageManager": "pnpm",
 	"typescript.tsdk": "node_modules/typescript/lib",
 	"cSpell.words": [
 		"Prebid",

README.md

@@ -24,7 +24,7 @@
 [![Generic badge](https://img.shields.io/badge/google-chat-259082.svg)](https://chat.google.com/room/AAAAPL2MBvE)
 
 ```bash
-yarn add @guardian/commercial-core
+pnpm add @guardian/commercial-core
 ```
 
 or
@@ -43,8 +43,11 @@ If your target environment does not support that, make sure you transpile this p
 
 ### Requirements
 
-1. [Node 14](https://nodejs.org/en/download/) ([nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm) recommended)
-2. [Yarn](https://classic.yarnpkg.com/en/docs/install/)
+1. [Node 14](https://nodejs.org/en/download/) ([nvm][] or [fnm][] recommended)
+2. [PNPM](https://pnpm.io/installation)
+
+[nvm]: https://github.com/nvm-sh/nvm
+[fnm]: https://github.com/Schniz/fnm
 
 ### Releasing
 

package.json

@@ -23,9 +23,11 @@
     "compile:common": "tsc --project ./tsconfig.build.json --outDir ./dist/cjs --module CommonJS",
     "compile:esm": "tsc --project ./tsconfig.build.json --outDir ./dist/esm",
     "lint": "eslint .",
+		"preinstall": "npx only-allow pnpm",
     "precommit:lint": "lint-staged",
     "prepush:test": "jest --verbose --runInBand --onlyChanged",
     "test": "jest",
+		"test:ci": "jest --coverage --ci",
     "tsc": "tsc --noEmit",
     "validate": "npm-run-all tsc lint test build",
     "prepare": "husky install"
@@ -42,6 +44,7 @@
   "devDependencies": {
     "@commitlint/cli": "^13",
     "@commitlint/config-conventional": "^13",
+    "@guardian/consent-management-platform": "^8",
     "@guardian/eslint-config-typescript": "^0.7",
     "@guardian/libs": "^3",
     "@guardian/prettier": "^0.7",