Switch to pnpm (#1702)

* Switch to pnpm

* Tweak github actions

* Update package.json

* Update jest.config.js

* Add tests

* Fix lint and tests

Author: RobbieTheWagner

.github/workflows/main.yml

@@ -15,12 +15,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: volta-cli/action@v1
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
         with:
-          node-version: 16.x
-      - run: yarn
-      - run: yarn test
+          version: 10
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: pnpm
+      - run: pnpm i
+      - run: pnpm test
 
   automerge:
     needs: [test]

.npmignore

@@ -20,6 +20,7 @@ tests/
 babel.config.js
 cypress.json
 index.html
+pnpm-lock.yaml
 rollup.config.js
 yarn.lock
 yarn-error.log

.release-it.js

@@ -2,7 +2,7 @@
 
 module.exports = {
   hooks: {
-    'after:bump': 'yarn build'
+    'after:bump': 'pnpm build'
   },
   plugins: {
     'release-it-lerna-changelog': {

CONTRIBUTING.md

@@ -2,22 +2,22 @@
 
 You will need:
 
-- [Yarn](https://yarnpkg.com/)
+- [pnpm](https://pnpm.io/)
 
 Windows users will need additional setup to enable build capabilities in NPM.
 From an administrative command window:
 
 ```sh
-    yarn global add windows-build-tools
+    pnpm global add windows-build-tools
 ```
 
 ## Getting started
 
 1. Fork the project
 2. Clone your forked project by running `git clone [email protected]:{
    YOUR_USERNAME }/tether.git`
-3. Run `yarn` to install node modules
-4. Test that you can build the source by running `yarn build` and ensure the `dist` directory appears.
+3. Run `pnpm` to install node modules
+4. Test that you can build the source by running `pnpm build` and ensure the `dist` directory appears.
 
 ## Writing code!
 
@@ -26,9 +26,9 @@ you can focus on writing relevant code. If there is a fix or feature you would l
 to contribute, we ask that you take the following steps:
 
 1. Most of the _editable_ code lives in the `src` directory while built code
-   will end up in the `dist` directory upon running `yarn build`.
+   will end up in the `dist` directory upon running `pnpm build`.
 
-2. Some examples are served out of the `examples` directory. Running `yarn start` will open the list in your browser and initiate a live-reloading session as you make changes.
+2. Some examples are served out of the `examples` directory. Running `pnpm start` will open the list in your browser and initiate a live-reloading session as you make changes.
 
 
 ## Opening Pull Requests
@@ -46,7 +46,7 @@ All PRs, that change code functionality, are required to have accompanying tests
 
 ### Acceptance Tests
 
-Acceptance tests are run using [`cypress`](https://github.com/cypress-io/cypress). A number of different testing configurations can be found in [`package.json`](/package.json), but you can simply run `yarn test:ci:watch` to build your latest changes and begin running the tests inside a Chrome browser instance.
+Acceptance tests are run using [`cypress`](https://github.com/cypress-io/cypress). A number of different testing configurations can be found in [`package.json`](/package.json), but you can simply run `pnpm test:ci:watch` to build your latest changes and begin running the tests inside a Chrome browser instance.
 
 ⚠️ The acceptance tests are set up to run on `localhost` port `9002`. If you'd like to change this port, make sure to change the `baseUrl` option inside of [`cypress.json`](/cypress.json), and change any references to port `9002` in [`package.json`](/package.json) accordingly.
 

RELEASE.md

@@ -31,7 +31,7 @@ Once the prep work is completed, the actual release is straight forward:
 * First, ensure that you have installed your projects dependencies:
 
 ```sh
-yarn install
+pnpm install
 ```
 
 * Second, ensure that you have obtained a

jest.config.js

@@ -28,5 +28,10 @@ module.exports = {
   // A map from regular expressions to paths to transformers
   transform: {
     '^.+\\.js$': 'babel-jest'
-  }
+  },
+
+  // Transform sinon ESM module (handle pnpm structure)
+  transformIgnorePatterns: [
+    'node_modules/(?!(.pnpm|sinon))'
+  ]
 };

package.json

@@ -18,65 +18,69 @@
   "main": "dist/js/tether.js",
   "module": "dist/js/tether.esm.js",
   "scripts": {
-    "build": "yarn clean && rollup -c",
+    "build": "pnpm clean && rollup -c",
     "changelog": "github_changelog_generator -u shipshapecode -p tether --since-tag v1.4.7",
     "clean": "rimraf dist",
     "cy:open": "./node_modules/.bin/cypress open",
     "cy:run": "./node_modules/.bin/cypress run",
     "lint:js": "eslint . --ext js",
-    "start": "yarn watch",
+    "start": "pnpm watch",
     "start-test-server": "http-server -p 9002",
-    "test": "yarn lint:js && yarn test:ci",
-    "test:ci": "yarn test:unit:ci && yarn test:cy:ci",
-    "test:cy:ci": "yarn build && start-server-and-test start-test-server http://localhost:9002 cy:run",
-    "test:cy:watch": "yarn build && start-server-and-test start-test-server http://localhost:9002 cy:open",
+    "test": "pnpm lint:js && pnpm test:ci",
+    "test:ci": "pnpm test:unit:ci && pnpm test:cy:ci",
+    "test:cy:ci": "pnpm build && start-server-and-test start-test-server http://127.0.0.1:9002 cy:run",
+    "test:cy:watch": "pnpm build && start-server-and-test start-test-server http://127.0.0.1:9002 cy:open",
     "test:unit:ci": "jest --coverage",
     "test:unit:watch": "jest --watch",
-    "watch": "yarn clean && rollup -c --environment DEVELOPMENT --watch"
+    "watch": "pnpm clean && rollup -c --environment DEVELOPMENT --watch"
   },
   "devDependencies": {
-    "@babel/core": "^7.27.4",
-    "@babel/preset-env": "^7.27.2",
+    "@babel/core": "^7.28.5",
+    "@babel/preset-env": "^7.28.5",
     "@testing-library/jest-dom": "^5.17.0",
-    "autoprefixer": "^10.4.21",
+    "autoprefixer": "^10.4.22",
     "babel-jest": "^29.7.0",
     "babel-plugin-rewire": "^1.2.0",
     "babel-plugin-transform-es2015-modules-commonjs": "^6.26.2",
-    "chai": "^5.2.0",
+    "chai": "^5.3.3",
     "cssnano": "^6.1.2",
     "cypress": "13.17.0",
     "eslint": "^8.57.1",
-    "eslint-plugin-jest": "^28.3.0",
+    "eslint-plugin-jest": "^28.14.0",
     "http-server": "^14.1.1",
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-expect-message": "^1.1.3",
     "jsdom": "^22.1.0",
     "mutationobserver-shim": "^0.3.7",
-    "postcss": "^8.5.5",
+    "postcss": "^8.5.6",
     "release-it": "^15.11.0",
     "release-it-lerna-changelog": "^5.0.0",
-    "rimraf": "^5.0.7",
+    "rimraf": "^5.0.10",
     "rollup": "^2.79.2",
     "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-browsersync": "^1.3.3",
     "rollup-plugin-eslint": "^7.0.0",
     "rollup-plugin-filesize": "^10.0.0",
     "rollup-plugin-license": "^3.6.0",
-    "rollup-plugin-sass": "^1.15.2",
+    "rollup-plugin-sass": "^1.15.3",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-visualizer": "^5.12.0",
-    "sinon": "^15.1.2",
-    "start-server-and-test": "^2.0.12"
+    "rollup-plugin-visualizer": "^5.14.0",
+    "sinon": "^15.2.0",
+    "start-server-and-test": "^2.1.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
   "engines": {
-    "node": ">= 16"
+    "node": ">= 18",
+    "pnpm": ">= 10"
   },
-  "volta": {
-    "node": "16.0.0",
-    "yarn": "1.22.10"
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "@parcel/watcher",
+      "core-js",
+      "cypress"
+    ]
   }
 }