Release/3.1.0

.github/workflows/ci.yml

@@ -11,19 +11,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [ '16' ]
+        node-version:   ['18.18.2', '20.5.1']
     steps:
       - uses: actions/checkout@v3
+      - uses: volta-cli/action@v4
+        with:
+            node-version: '${{ matrix.node-version }}'
+            yarn-version: '1.22.19'
       - uses: actions/cache@v3
         id: cache
         with:
           path: node_modules
-          key: ${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
-      - uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node }}
-          registry-url: https://registry.npmjs.org/
-      - run: npm install -g npm@^6
+          key: ${{ matrix.node-version }}-${{ hashFiles('**/yarn.lock') }}
       - if: steps.cache.outputs.cache-hit != 'true'
-        run: npm ci
-      - run: npm test
+        run: yarn install
+      - run: yarn test

CHANGELOG.md

@@ -2,10 +2,20 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+[4.0.0] - 2023-11-02
+-------------------------
+##### Removed
+- Support for NodeJS 16.
+
+##### Changed
+- Updated dependencies.
+- Switched to installation with **yarn** instead of npm.
+- Added support for modern npm versions.
+
 [3.0.1] - 2023-07-11
 -------------------------
 ##### Added
-- Support for linux/arm64
+- Support for linux/arm64.
 
 [3.0.0] - 2023-07-10
 -------------------------

README.md

@@ -17,8 +17,7 @@ Live demo web application (meant for testing purposes only) that uses Enketo Val
 
 ## Prerequisites
 
-1. install nodeJS 16
-2. if npm is not version 6, downgrade with `npm i -g npm@6` (but you could check first if still necessary)
+1. install Node 18 or 20 and Yarn 1 ("classic")
 2. (if necessary) install build tools for native modules with `apt-get install build-essential`
 3. (if necessary) install puppeteer (headless Chrome) prerequisites as mentioned [here](https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#chrome-headless-doesnt-launch-on-unix), e.g. for Ubuntu/Debian do `apt-get install ca-certificates fonts-liberation libappindicator3-1 libasound2 libatk-bridge2.0-0 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgbm1 libgcc1 libglib2.0-0 libgtk-3-0 libnspr4 libnss3 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 lsb-release wget xdg-utils`
 
@@ -83,7 +82,7 @@ const result = validator.validate( xformStr, options );
 ## Develop
 
 1. Clone repo and install [prerequisites](#prerequisites).
-2. Run `npm install`. If there is an error the first thing to do is to run `rm -R node_modules` and retry especially after changing Node versions or after earlier crashes during installation.
+2. Run `yarn install`. If there is an error the first thing to do is to run `rm -R node_modules` and retry especially after changing Node versions or after earlier crashes during installation.
 3. Run via command line, e.g. `./validate test/xform/xpath-fails.xml` or `./validate --help`.
 
 ## How it works