Merge pull request #611 from BloomBooks/BL_harden_deps_pnpm

yarn -> pnpm, volta -> vite+ (BL-16115)

Author: hatton

.github/workflows/build-and-deploy.yml

@@ -16,36 +16,40 @@ jobs:
             - name: Checkout repository
               uses: actions/checkout@v3
 
+            - name: Install Vite+ (manages Node.js and pnpm)
+              uses: voidzero-dev/setup-vp@v1
+              with:
+                  version: 0.1.24
+                  node-version-file: .node-version
+                  cache: true
+
             - name: Install dependencies
-              run: |
-                  if [ "${{ github.ref }}" == "refs/heads/master" ]; then
-                    yarn upgrade bloom-player@alpha --network-timeout 1000000000
-                  else
-                    yarn install --frozen-lockfile --network-timeout 1000000000
-                  fi
+              # On master, build:ci:alpha bumps bloom-player to the latest alpha, so we
+              # don't upgrade it here too. Other branches use the locked version.
+              run: vp install --frozen-lockfile
 
             - name: Upload translations to Crowdin
               if: github.ref == 'refs/heads/release'
               # Push any new code-based strings to Crowdin
-              run: yarn crowdin-dangerous-upload
+              run: vp run crowdin-dangerous-upload
               env:
                   BLOOM_CROWDIN_TOKEN: ${{ secrets.BLOOM_CROWDIN_TOKEN }}
 
             - name: Download translations from Crowdin
-              run: yarn crowdin-download
+              run: vp run crowdin-download
               env:
                   BLOOM_CROWDIN_TOKEN: ${{ secrets.BLOOM_CROWDIN_TOKEN }}
 
             - name: Build
               run: |
                   if [ "${{ github.ref }}" == "refs/heads/master" ]; then
-                    yarn build:ci:alpha
+                    vp run build:ci:alpha
                   else
-                    yarn build:ci
+                    vp run build:ci
                   fi
 
             - name: Run tests
-              run: yarn test:ci
+              run: vp run test:ci
 
             - name: Deploy to S3 - alpha.bloomlibrary.org
               if: github.ref == 'refs/heads/master'

.gitignore

@@ -2,8 +2,6 @@
 
 # dependencies
 /node_modules
-/.pnp
-.pnp.js
 
 # testing
 /coverage
@@ -19,8 +17,7 @@
 .env.production.local
 
 npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+pnpm-debug.log*
 
 \.nyc_output/
 
@@ -29,11 +26,6 @@ public/bloom-player/
 debug.log
 *.orig
 
-# we're not using zero-installs yet
-.yarn/*
-
-.yarnrc.yml
-
 # Translations handling:
 # First ignore everything in translations
 src/translations/*

.husky/pre-commit

@@ -1,5 +1,5 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn pretty-quick --staged
-yarn lint-staged
+pnpm exec pretty-quick --staged
+pnpm exec lint-staged

.node-version

@@ -0,0 +1 @@
+22.22.3

README.md

@@ -1,4 +1,4 @@
-A web site ([bloomlibrary.org](https://bloomlibrary.org)) for sharing literacy materials, especially templates for translation into minority languages.
+A crowd-sourced web site ([bloomlibrary.org](https://bloomlibrary.org)) for sharing literacy materials, especially templates for translation into minority languages.
 
 Language speakers find books in their own language, and book creators find shellbooks to translate. They upload these to share them with the world.
 
@@ -8,17 +8,16 @@ Language speakers find books in their own language, and book creators find shell
 
 
 ## Get dependencies
-You'll need nodejs and yarn.  Please install [volta](https://github.com/volta-cli/volta) so that you automatically use the correct version of nodejs and yarn that this project requires, as specified in `package.json`.
-Finally, run `yarn` in a command line (e.g. in VSCode) to install the library dependencies.
+This project uses [Vite+](https://viteplus.dev) (the `vp` CLI) to manage the Node.js runtime and the pnpm package manager, so you don't need to install those separately. Install `vp` (see the [Vite+ docs](https://viteplus.dev)), then run `vp install` in a command line (e.g. in VSCode). That selects the correct Node.js version (from `.node-version`) and the pinned pnpm (from `package.json`), and installs the library dependencies.
 
 ## Run locally
-To run the site locally, do `yarn dev`
+To run the site locally, do `vp run dev`
 
 ## Storybook
-To see various components/scenarios, do `yarn storybook`
+To see various components/scenarios, do `vp run storybook`
 
 ## Unit Tests
-To run the unit tests, do `yarn test`
+To run the unit tests, do `vp run test`
 
 
 ### Pointing to Prod, Dev, or Local
@@ -33,8 +32,8 @@ BloomLibrary depends upon on the [bloom-player](https://github.com/BloomBooks/bl
 This is installed as a normal dependency. However, sometimes during the development process you may wish to run your own local build of bloom-player.
 
 If you need to do that, there are a couple options:
-### A) yarn link
-One option is to ```yarn link``` ([docs](https://classic.yarnpkg.com/lang/en/docs/cli/link/)) to the local bloom-player source code on the same computer.
+### A) pnpm link
+One option is to ```pnpm link``` ([docs](https://pnpm.io/cli/link)) to the local bloom-player source code on the same computer.
 
 ### B) manual copy
 Another option is to manually copy the bloom-player's `/dist` folder build to BloomLibrary's `node_modules/bloom-player/dist`.

index.html

@@ -85,8 +85,8 @@ <h1>
       You can add webfonts, meta tags, or analytics to this file.
       The build step will place the bundled scripts into the <body> tag.
 
-      To begin the development, run `npm start` or `yarn start`.
-      To create a production bundle, use `npm run build` or `yarn build`.
+      To begin the development, run `vp run dev`.
+      To create a production bundle, use `vp run build`.
 
       (The phony onclick is a bizarre workaround for an IOS bug.)
     -->