pagean 10.1.5 → 11.0.0

package/lib/tests.js

@@ -1,22 +1,24 @@
-'use strict';
-
+/* eslint-disable capitalized-comments -- "v8 ignore" statements for code
+   executed in browser are case sensitive. */
 /**
  * Pagean tests.
  *
  * @module tests
  */
-const { HTMLHint } = require('htmlhint');
 
-const { testResultStates, pageanTest } = require('./test-utils');
-const fileUtils = require('./external-file-utils');
-const { isFailedResponse } = require('./link-utils');
+import { HTMLHint } from 'htmlhint';
+
+import * as fileUtils from './external-file-utils.js';
+import { pageanTest, testResultStates } from './test-utils.js';
+import { isFailedResponse } from './link-utils.js';
 
 const msPerSec = 1000;
 
 /**
  * Tests the current page for the existence of a horizontal scroll bar.
  *
- * @param {object} context Test execution context.
+ * @param   {object}        context Test execution context.
+ * @returns {Promise<void>}
  * @static
  */
 const horizontalScrollbarTest = async (context) => {
@@ -24,13 +26,14 @@ const horizontalScrollbarTest = async (context) => {
         'should not have a horizontal scrollbar',
         // eslint-disable-next-line no-shadow -- less intuitive
         async (context) => {
-            // istanbul ignore next: injects script causing puppeteer error, see #48
             const scrollbar = await context.page.evaluate(() => {
+                /* v8 ignore start: executed in browser */
                 document.scrollingElement.scrollLeft = 1;
                 // The scrollLeft value may not end up exactly 1. But, any
                 // value greater than 0 indicates the presence of a horizontal
                 // scrollbar.
                 return document.scrollingElement.scrollLeft > 0;
+                /* v8 ignore stop */
             });
             return {
                 result:
@@ -104,7 +107,8 @@ const consoleErrorTest = (context) => {
 /**
  * Tests the current page for any HTML lint issues.
  *
- * @param {object} context Test execution context.
+ * @param   {object}        context Test execution context.
+ * @returns {Promise<void>}
  * @static
  */
 const renderedHtmlTest = async (context) => {
@@ -136,7 +140,8 @@ const renderedHtmlTest = async (context) => {
 /**
  * Tests the current page for load time.
  *
- * @param {object} context Test execution context.
+ * @param   {object}        context Test execution context.
+ * @returns {Promise<void>}
  * @static
  */
 // eslint-disable-next-line max-lines-per-function -- exceeded due to formatting
@@ -148,9 +153,9 @@ const pageLoadTimeTest = async (context) => {
         async (context) => {
             const { pageLoadTimeThreshold } = context.testSettings;
             const name = `should load page within ${pageLoadTimeThreshold} sec`;
-            // istanbul ignore next: injects script causing puppeteer error, see #48
             const performanceTiming = JSON.parse(
                 await context.page.evaluate(() =>
+                    /* v8 ignore next: executed in browser */
                     JSON.stringify(window.performance)
                 )
             );
@@ -179,7 +184,8 @@ const pageLoadTimeTest = async (context) => {
  * Tests the current page for any external JavaScript files and
  * downloads the files for further analysis.
  *
- * @param {object} context Test execution context.
+ * @param   {object}        context Test execution context.
+ * @returns {Promise<void>}
  * @static
  */
 // eslint-disable-next-line max-lines-per-function -- exceeded due to formatting
@@ -188,8 +194,8 @@ const externalScriptTest = async (context) => {
         'should not have external scripts',
         // eslint-disable-next-line no-shadow -- less intuitive
         async (context) => {
-            // istanbul ignore next: injects script causing puppeteer error, see #48
             const scripts = await context.page.evaluate(() =>
+                /* v8 ignore next: executed in browser */
                 [...document.querySelectorAll('script[src]')].map((s) => s.src)
             );
 
@@ -221,7 +227,8 @@ const externalScriptTest = async (context) => {
 /**
  * Tests the current page for any broken links (external or within the page).
  *
- * @param {object} context Test execution context.
+ * @param   {object}        context Test execution context.
+ * @returns {Promise<void>}
  * @static
  */
 // eslint-disable-next-line max-lines-per-function -- exceeded due to formatting
@@ -230,8 +237,8 @@ const brokenLinkTest = async (context) => {
         'should not have broken links',
         // eslint-disable-next-line no-shadow -- less intuitive
         async (context) => {
-            // istanbul ignore next: injects script causing puppeteer error, see #48
             const links = await context.page.evaluate(() =>
+                /* v8 ignore next: executed in browser */
                 [...document.querySelectorAll('a[href]')].map((a) => a.href)
             );
 
@@ -272,10 +279,12 @@ const brokenLinkTest = async (context) => {
     );
 };
 
-module.exports.consoleErrorTest = consoleErrorTest;
-module.exports.consoleOutputTest = consoleOutputTest;
-module.exports.horizontalScrollbarTest = horizontalScrollbarTest;
-module.exports.pageLoadTimeTest = pageLoadTimeTest;
-module.exports.renderedHtmlTest = renderedHtmlTest;
-module.exports.externalScriptTest = externalScriptTest;
-module.exports.brokenLinkTest = brokenLinkTest;
+export {
+    consoleErrorTest,
+    consoleOutputTest,
+    horizontalScrollbarTest,
+    pageLoadTimeTest,
+    renderedHtmlTest,
+    externalScriptTest,
+    brokenLinkTest
+};

package/lib/utils.js

@@ -0,0 +1,45 @@
+/**
+ * Miscellaneous utilities.
+ *
+ * @module utils
+ */
+
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { readFile } from 'node:fs/promises';
+
+/**
+ * The file containing the current module, using the CJS global name.
+ *
+ * @type {string}
+ */
+// eslint-disable-next-line no-underscore-dangle -- match CJS name
+const __filename = fileURLToPath(import.meta.url);
+
+/**
+ * The directory containing the current module, using the CJS global name.
+ *
+ * @type {string}
+ */
+// eslint-disable-next-line no-underscore-dangle -- match CJS name
+const __dirname = dirname(__filename);
+
+/**
+ * Reads a JSON file and returns the parsed data.
+ *
+ * @param   {string}          path The path to the JSON file to read.
+ * @returns {Promise<object>}      The parsed JSON data.
+ */
+const readJson = async (path) => {
+    const data = await readFile(path, 'utf8');
+    return JSON.parse(data);
+};
+
+/**
+ * The package.json file for this project.
+ *
+ * @type {object}
+ */
+const pkg = await readJson(join(__dirname, '..', 'package.json'));
+
+export { __dirname, __filename, readJson, pkg };

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "pagean",
-  "version": "10.1.5",
+  "version": "11.0.0",
   "description": "Pagean is a web page analysis tool designed to automate tests requiring web pages to be loaded in a browser window (e.g. horizontal scrollbar, console errors)",
   "bin": {
     "pagean": "./bin/pagean.js",
     "pageanrc-lint": "./bin/pageanrc-lint.js"
   },
+  "type": "module",
   "scripts": {
     "hooks:pre-commit": "npm run lint && npm run prettier:check",
     "hooks:pre-push": "npm audit --audit-level=high && npm test",
@@ -19,7 +20,8 @@
     "start": "node ./bin/pagean.js",
     "start:lint": "node ./bin/pageanrc-lint.js",
     "start:lint-all": "npm run start:lint && npm run start:lint static-server.pageanrc.json && npm run start:lint ./lib/default-config.json",
-    "test": "jest --ci --config jest.config.json"
+    "test": "vitest run --coverage",
+    "test:no-coverage": "vitest run"
   },
   "repository": {
     "type": "git",
@@ -37,7 +39,7 @@
   "author": "Aaron Goldenthal <npm@aarongoldenthal.com>",
   "license": "MIT",
   "engines": {
-    "node": "^18.12.0 || >=20.0.0"
+    "node": "^18.12.0 || ^20.9.0 || >=22.0.0"
   },
   "files": [
     "index.js",
@@ -52,29 +54,29 @@
   "homepage": "https://gitlab.com/gitlab-ci-utils/pagean",
   "devDependencies": {
     "@aarongoldenthal/eslint-config-standard": "^27.0.1",
-    "@aarongoldenthal/stylelint-config-standard": "^17.0.1",
-    "bin-tester": "^5.0.0",
+    "@aarongoldenthal/stylelint-config-standard": "^18.0.0",
+    "@vitest/coverage-v8": "^1.6.0",
+    "bin-tester": "^6.0.0",
     "eslint": "^8.57.0",
-    "jest": "^29.7.0",
-    "jest-junit": "^16.0.0",
     "markdownlint-cli2": "^0.13.0",
     "prettier": "^3.2.5",
-    "strip-ansi": "^6.0.1",
-    "stylelint": "^16.3.1"
+    "strip-ansi": "^7.1.0",
+    "stylelint": "^16.5.0",
+    "vitest": "^1.6.0"
   },
   "dependencies": {
-    "ajv": "^8.12.0",
+    "ajv": "^8.13.0",
     "ajv-errors": "^3.0.0",
     "axios": "^1.6.8",
-    "ci-logger": "^6.0.0",
-    "commander": "^12.0.0",
+    "ci-logger": "^7.0.0",
+    "commander": "^12.1.0",
     "cssesc": "^3.0.0",
     "handlebars": "^4.7.8",
     "htmlhint": "^1.1.4",
     "kleur": "^4.1.5",
-    "normalize-url": "^6.1.0",
-    "protocolify": "^3.0.0",
-    "puppeteer": "^22.6.5",
+    "normalize-url": "^8.0.1",
+    "protocolify": "^4.0.0",
+    "puppeteer": "^22.9.0",
     "xml2js": "^0.6.2"
   }
 }

package/schemas/pageanrc.schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "https://json-schema.org/draft/2019-09/schema#",
   "$id": "https://gitlab.com/gitlab-ci-utils/pagean/-/raw/master/schemas/pageanrc.schema.json",
   "title": "Pagean Configuration File Schema",
   "description": "The JSON schema definition for pageanrc configuration files.",