Update Node.js support to 18-20 from 12-16, dependencies, documentation, some practices

.github/workflows/tests.yml

@@ -1,34 +1,20 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests.
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Build and lint
-
 on:
   push:
-    branches: # Run actions when code is committed to these branches
+    branches:
       - master
+      - main
   pull_request:
-    branches: # Run actions when a PR is pushed based on one of these branches
-      - master
 
 jobs:
-  checkout_and_test:
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        include:
-          - node-version: 12.x
-          - node-version: 14.x
-          - node-version: 16.x
-
+        node-version: [14, 16, 18, 20]
     steps:
-      - name: Checkout code from ${{ github.repository }}
-        uses: actions/checkout@v2
-      - name: Setup node
-        uses: actions/setup-node@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - name: Install dependencies
-        run: npm ci
-      - name: Run tests
-        run: npm test
+      - run: npm ci
+      - run: npm test

Gruntfile.js

@@ -20,7 +20,7 @@ module.exports = function (grunt) {
 		jshint: {
 			all: ['Gruntfile.js', 'lib/**/*.js', 'test/**/*.js'],
 			options: {
-				es3: false,
+				esversion: 6,
 				indent: 4,
 				latedef: false,
 				maxcomplexity: 5,
@@ -50,6 +50,5 @@ module.exports = function (grunt) {
 	grunt.registerTask('lint', ['jshint']);
 	grunt.registerTask('test', ['mochaTest']);
 	grunt.registerTask('default', ['lint', 'test']);
-	grunt.registerTask('ci', ['lint', 'test']);
 
 };

MIGRATION.md

@@ -1,11 +1,16 @@
 # Migration Guide
 
-Pa11y's API changes between major versions. This is a guide to help you make the switch when this happens.
+This package's API and/or supported set of environments changes between major versions. This is a guide to help you update your project to use a new major version.
 
-## Migrating from 2.x to 3.x
+## Migrating to 4 from 3
 
-Pa11y Webservice Client 3.x only supports Node.js v12 and higher, you'll need to upgrade to be able to use it.
+1. Upgrade to Node.js 14 or above.
+1. Upgrade npm to version 8 or above, or to a version of your preferred package manager that is interchangeable with such a version of npm.
 
-## Migrating from 1.x to 2.x
+## Migrating to 3 from 2
 
-Pa11y Webservice Client 2.x only supports Node.js v8.0.0 and higher, you'll need to upgrade to be able to use it.
+1. Upgrade to Node.js 12 or above. 
+
+## Migrating to 2 from 1
+
+1. Upgrade to Node.js 8 or above.

README.md

@@ -9,21 +9,21 @@ This is a Node.js client library for [Pa11y Webservice][pa11y-webservice].
 
 ## Installing
 
-Install Pa11y Webservice Node.js Client with npm:
+Add this client to your project with your preferred package manager. For example, to install it as a development dependency with npm:
 
 ```sh
-$ npm install pa11y-webservice-client-node
+npm install --save-dev pa11y-webservice-client-node
 ```
 
 ## Usage
 
-For more information on the actual webservice endpoints and resource types, [read the documentation][wiki-web-service].
+For information about Pa11y Webservice's endpoints and resource types, [read the documentation][wiki-web-service].
 
 ```js
-var createClient = require('pa11y-webservice-client-node');
+const createClient = require('pa11y-webservice-client-node');
 
-// Create client with the base URL of the web-service
-var client = createClient('http://localhost:3000/');
+// Create client with the base URL of your instance of Pa11y Webservice
+const client = createClient('http://localhost:3000/');
 
 // Create a task
 client.tasks.create({
@@ -53,8 +53,8 @@ client.tasks.results({}, function (err, results) {
 
 // Get results for all tasks within a date range
 client.tasks.results({
-    from: '2013-01-01',
-    to: '2013-01-31'
+    from: '2023-01-01',
+    to: '2023-01-31'
 }, function (err, results) {
     // results  =  array of objects representing results, or null if an error occurred
 });
@@ -102,8 +102,8 @@ client.task('5231c687bbdf0f94fa000007').results({}, function (err, results) {
 
 // Get results for a task within a date range
 client.task('5231c687bbdf0f94fa000007').results({
-    from: '2013-01-01',
-    to: '2013-01-31'
+    from: '2023-01-01',
+    to: '2023-01-31'
 }, function (err, results) {
     // results  =  array of objects representing results, or null if an error occurred
 });
@@ -130,50 +130,54 @@ client.task('5231c687bbdf0f94fa000007').result('523c0ee0ca452f0000000009').get({
 
 ## Contributing
 
-There are many ways to contribute to Pa11y Webservice Node.js Client, we cover these in the [contributing guide](CONTRIBUTING.md) for this repo.
+There are many ways to contribute to Pa11y Webservice Node.js Client; we cover these in this repo's [contributing guide](CONTRIBUTING.md).
 
-If you're ready to contribute some code, you'll need to clone the repo locally and run `npm install`. You'll also need [Grunt][grunt] to be installed globally in order to run tests, you can do this with `npm install -g grunt-cli`.
-
-Now you'll be able to run the following commands:
+If you'd like to contribute code, get started by cloning the repo and running `npm install`. Now you'll be able to run the following commands. Please use these build tools to avoid your contribution being delayed by a lint error or a failing test:
 
 ```sh
-$ grunt       # Run the lint and test tasks together
-$ grunt lint  # Run JSHint with the correct config
-$ grunt test  # Run unit tests
+# Lint your contribution
+grunt lint
 ```
 
-Code with lint errors or failing tests will not be accepted, please use the build tools outlined above.
+```sh
+# Test your contribution
+grunt test
+```
 
-For users with push-access, don't commit to the master branch. Code should be in `develop` until it's ready to be released.
+```sh
+# Lint and test with a single command
+grunt
+```
 
 ## Support and Migration
 
-Major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version.
+We maintain a [migration guide](MIGRATION.md) to help you migrate between major versions.
 
-We also maintain a [migration guide](MIGRATION.md) to help you migrate.
+A previous major version of this client will be supported for a minimum of 6 months from its final minor release. During this time bugs will continue to be fixed and released in the form of patch versions. If you're opening an issue related to this project, please mention the specific version that the issue affects.
 
-| :grey_question: | Major Version | Last Release | Node.js Versions | Support End Date |
-| :-------------- | :------------ | :----------- | :--------------- | :--------------- |
-| :heart:         | 3             | N/A          | 12+              | N/A              |
-| :hourglass:     | 2             | 2.0.0        | 8+               | 2022-05-26       |
-| :skull:         | 1             | 1.2.1        | 0.10+            | 2020-01-05       |
+The following table lists the major versions available and, for each previous major version, its end-of-support date, and its final minor version released.
 
-If you're opening issues related to these, please mention the version that the issue relates to.
+| Major version | Last release | Node.js required | End of support                           |
+| :------------ | :----------- | :--------------- | :--------------------------------------- |
+| 4             | 4.0.0        | 14+              | :white_check_mark: Current major version |
+| 3             | 3.0.0        | 12+              | 2023-11-01                               |
+| 2             | 2.0.0        | 8+               | 2022-05-26                               |
+| 1             | 1.2.1        | 0.10+            | 2020-01-05                               |
 
 ## License
 
 Licensed under the [GNU General Public License 3.0](LICENSE.txt).<br/>
-Copyright &copy; 2013–2019, Team Pa11y
+Copyright &copy; 2013–2023, Team Pa11y
 
 [gpl]: http://www.gnu.org/licenses/gpl-3.0.html
 [grunt]: http://gruntjs.com/
 [pa11y-webservice]: https://github.com/pa11y/pa11y-webservice
 [wiki-web-service]: https://github.com/pa11y/pa11y-webservice/wiki/Web-Service-Endpoints
-[info-build]: https://github.com/pa11y/pa11y-webservice-client-node/actions/workflows/build-and-test.yml
+[info-build]: https://github.com/pa11y/pa11y-webservice-client-node/actions/workflows/tests.yml
 [info-license]: LICENSE
 [info-node]: package.json
 [info-npm]: https://www.npmjs.com/package/pa11y-webservice-client-node
-[shield-build]: https://github.com/pa11y/pa11y-webservice-client-node/actions/workflows/build-and-test.yml/badge.svg
+[shield-build]: https://github.com/pa11y/pa11y-webservice-client-node/actions/workflows/tests.yml/badge.svg
 [shield-license]: https://img.shields.io/badge/license-LGPL%203.0-blue.svg
 [shield-node]: https://img.shields.io/node/v/pa11y-webservice-client-node.svg
 [shield-npm]: https://img.shields.io/npm/v/pa11y-webservice-client-node.svg