pagean 4.4.2 → 6.0.1

package/schemas/pageanrc.schema.json

@@ -1,214 +1,222 @@
 {
-    "$schema": "http://json-schema.org/draft-07/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.",
-    "type": "object",
-    "properties": {
-        "htmlhintrc": {
-            "description": "The path to the htmlhintrc file to use for the rendered HTML test (default ./.htmlhintrc)",
-            "type": "string"
-        },
-        "project": {
-            "description": "The name of the project being analyzed (for reports)",
+  "$schema": "http://json-schema.org/draft-07/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.",
+  "type": "object",
+  "properties": {
+    "htmlhintrc": {
+      "description": "The path to the htmlhintrc file to use for the rendered HTML test (default ./.htmlhintrc)",
+      "type": "string"
+    },
+    "project": {
+      "description": "The name of the project being analyzed (for reports)",
+      "type": "string"
+    },
+    "puppeteerLaunchOptions": {
+      "description": "Options passed to puppeteer when launching the browser, see https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#puppeteerlaunchoptions for the complete list.",
+      "type": "object",
+      "minProperties": 1
+    },
+    "reporters": {
+      "description": "Reporters to use when returning the results of the Pagean tests.",
+      "type": "array",
+      "items": {
+        "enum": [
+          "cli",
+          "html",
+          "json"
+        ]
+      },
+      "minItems": 1
+    },
+    "settings": {
+      "description": "The global test settings to apply to all tests, unless overridden for a specific URL.",
+      "$ref": "#/definitions/allTestSettings"
+    },
+    "urls": {
+      "description": "The collection of URLs to test, with any URL-specific test settings.",
+      "type": "array",
+      "items": {
+        "oneOf": [
+          {
+            "description": "The URL to be tested (without any URL-specific test settings).",
             "type": "string"
-        },
-        "puppeteerLaunchOptions": {
-            "description": "Options passed to puppeteer when launching the browser, see https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#puppeteerlaunchoptions for the complete list.",
+          },
+          {
+            "description": "An object specifying the URL and any URL-specific test settings.",
             "type": "object",
-            "minProperties": 1
-        },
-        "reporters": {
-            "description": "Reporters to use when returning the results of the Pagean tests.",
-            "type": "array",
-            "items": {
-                "enum": [
-                    "cli",
-                    "html",
-                    "json"
-                ]
+            "properties": {
+              "url": {
+                "description": "The URL to be tested.",
+                "type": "string"
+              },
+              "settings": {
+                "description": "URL-specific test settings.",
+                "$ref": "#/definitions/allTestSettings"
+              }
             },
-            "minItems": 1
-        },
-        "settings": {
-            "description": "The global test settings to apply to all tests, unless overridden for a specific URL.",
-            "$ref": "#/definitions/allTestSettings"
-        },
-        "urls": {
-            "description": "The collection of URLs to test, with any URL-specific test settings.",
-            "type": "array",
-            "items": {
-                "oneOf": [
-                    {
-                        "description": "The URL to be tested (without any URL-specific test settings).",
-                        "type": "string"
-                    },
-                    {
-                        "description": "An object specifying the URL and any URL-specific test settings.",
-                        "type": "object",
-                        "properties": {
-                            "url": {
-                                "description": "The URL to be tested.",
-                                "type": "string"
-                            },
-                            "settings": {
-                                "description": "URL-specific test settings.",
-                                "$ref": "#/definitions/allTestSettings"
-                            }
-                        },
-                        "additionalProperties": {
-                            "not": true,
-                            "errorMessage": "should NOT contain additional properties: ${0#}"
-                        },
-                        "required": [
-                            "url"
-                        ],
-                        "errorMessage": {
-                            "required": "should have required property url"
-                        }
-                    }
-                ],
-                "errorMessage": "should be either URL string or object with the appropriate properties"
+            "additionalProperties": {
+              "not": true,
+              "errorMessage": "must NOT contain additional properties: ${0#}"
             },
-            "minItems": 1
+            "required": [
+              "url"
+            ],
+            "errorMessage": {
+              "required": "must have required property 'url'"
+            }
+          }
+        ],
+        "errorMessage": "must be either URL string or object with the appropriate properties"
+      },
+      "minItems": 1
+    }
+  },
+  "additionalProperties": {
+    "not": true,
+    "errorMessage": "must NOT contain additional properties: ${0#}"
+  },
+  "required": [
+    "urls"
+  ],
+  "definitions": {
+    "detailedSetting": {
+      "description": "The complete set of test-specific settings for most tests.",
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "description": "Value indicating whether the test is enabled.",
+          "type": "boolean"
+        },
+        "failWarn": {
+          "description": "Value indicating whether the test should report failure as a warning.",
+          "type": "boolean"
         }
-    },
-    "additionalProperties": {
+      },
+      "additionalProperties": {
         "not": true,
-        "errorMessage": "should NOT contain additional properties: ${0#}"
+        "errorMessage": "must NOT contain additional properties: ${0#}"
+      },
+      "minProperties": 1
     },
-    "required": [
-        "urls"
-    ],
-    "definitions": {
-        "detailedSetting": {
-            "description": "The complete set of test-specific settings for most tests.",
-            "type": "object",
-            "properties": {
+    "simpleOrDetailedSetting": {
+      "oneOf": [
+        {
+          "description": "Value indicating whether the test is enabled (with other default settings).",
+          "type": "boolean"
+        },
+        {
+          "description": "The complete set of test-specific settings for a test.",
+          "$ref": "#/definitions/detailedSetting"
+        }
+      ],
+      "errorMessage": "must be either boolean or object with the appropriate properties"
+    },
+    "allTestSettings": {
+      "description": "The complete set of test-specific settings for all test.",
+      "type": "object",
+      "properties": {
+        "horizontalScrollbarTest": {
+          "$ref": "#/definitions/simpleOrDetailedSetting"
+        },
+        "consoleOutputTest": {
+          "$ref": "#/definitions/simpleOrDetailedSetting"
+        },
+        "consoleErrorTest": {
+          "$ref": "#/definitions/simpleOrDetailedSetting"
+        },
+        "renderedHtmlTest": {
+          "$ref": "#/definitions/simpleOrDetailedSetting"
+        },
+        "pageLoadTimeTest": {
+          "oneOf": [
+            {
+              "description": "Value indicating whether the test is enabled (with other default settings).",
+              "type": "boolean"
+            },
+            {
+              "description": "The complete set of test-specific settings for the pageLoadTimeTest test.",
+              "type": "object",
+              "properties": {
                 "enabled": {
-                    "description": "Value indicating whether the test is enabled.",
-                    "type": "boolean"
+                  "description": "Value indicating whether the test is enabled.",
+                  "type": "boolean"
                 },
                 "failWarn": {
-                    "description": "Value indicating whether the test should report failure as a warning.",
-                    "type": "boolean"
+                  "description": "Value indicating whether the test should report failure as a warning.",
+                  "type": "boolean"
+                },
+                "pageLoadTimeThreshold": {
+                  "description": "Maximum allowed time for page load before reporting an error.",
+                  "type": "integer",
+                  "minimum": 1
                 }
-            },
-            "additionalProperties": {
+              },
+              "additionalProperties": {
                 "not": true,
-                "errorMessage": "should NOT contain additional properties: ${0#}"
-            },
-            "minProperties": 1
+                "errorMessage": "must NOT contain additional properties: ${0#}"
+              },
+              "minProperties": 1
+            }
+          ],
+          "errorMessage": "must be either boolean or object with the appropriate properties"
         },
-        "simpleOrDetailedSetting": {
-            "oneOf": [
-                {
-                    "description": "Value indicating whether the test is enabled (with other default settings).",
-                    "type": "boolean"
-                },
-                {
-                    "description": "The complete set of test-specific settings for a test.",
-                    "$ref": "#/definitions/detailedSetting"
-                }
-            ],
-            "errorMessage": "should be either boolean or object with the appropriate properties"
+        "externalScriptTest": {
+          "$ref": "#/definitions/simpleOrDetailedSetting"
         },
-        "allTestSettings": {
-            "description": "The complete set of test-specific settings for all test.",
-            "type": "object",
-            "properties": {
-                "horizontalScrollbarTest": {
-                    "$ref": "#/definitions/simpleOrDetailedSetting"
-                },
-                "consoleOutputTest": {
-                    "$ref": "#/definitions/simpleOrDetailedSetting"
-                },
-                "consoleErrorTest": {
-                    "$ref": "#/definitions/simpleOrDetailedSetting"
+        "brokenLinkTest": {
+          "oneOf": [
+            {
+              "description": "Value indicating whether the test is enabled (with other default settings).",
+              "type": "boolean"
+            },
+            {
+              "description": "The complete set of test-specific settings for the brokenLinkTest test.",
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "description": "Value indicating whether the test is enabled.",
+                  "type": "boolean"
                 },
-                "renderedHtmlTest": {
-                    "$ref": "#/definitions/simpleOrDetailedSetting"
+                "failWarn": {
+                  "description": "Value indicating whether the test should report failure as a warning.",
+                  "type": "boolean"
                 },
-                "pageLoadTimeTest": {
-                    "oneOf": [
-                        {
-                            "description": "Value indicating whether the test is enabled (with other default settings).",
-                            "type": "boolean"
-                        },
-                        {
-                            "description": "The complete set of test-specific settings for the pageLoadTimeTest test.",
-                            "type": "object",
-                            "properties": {
-                                "enabled": {
-                                    "description": "Value indicating whether the test is enabled.",
-                                    "type": "boolean"
-                                },
-                                "failWarn": {
-                                    "description": "Value indicating whether the test should report failure as a warning.",
-                                    "type": "boolean"
-                                },
-                                "pageLoadTimeThreshold": {
-                                    "description": "Maximum allowed time for page load before reporting an error.",
-                                    "type": "integer",
-                                    "minimum": 1
-                                }
-                            },
-                            "additionalProperties": {
-                                "not": true,
-                                "errorMessage": "should NOT contain additional properties: ${0#}"
-                            },
-                            "minProperties": 1
-                        }
-                    ],
-                    "errorMessage": "should be either boolean or object with the appropriate properties"
+                "ignoredLinks": {
+                  "description": "Array of links that will be ignored (i.e. not checked).",
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "uniqueItems": true,
+                  "minItems": 0,
+                  "maxItems": 100
                 },
-                "externalScriptTest": {
-                    "$ref": "#/definitions/simpleOrDetailedSetting"
+                "checkWithBrowser": {
+                  "description": "Value indicating that links should be checked by loading in browser",
+                  "type": "boolean"
                 },
-                "brokenLinkTest": {
-                    "oneOf": [
-                        {
-                            "description": "Value indicating whether the test is enabled (with other default settings).",
-                            "type": "boolean"
-                        },
-                        {
-                            "description": "The complete set of test-specific settings for the brokenLinkTest test.",
-                            "type": "object",
-                            "properties": {
-                                "enabled": {
-                                    "description": "Value indicating whether the test is enabled.",
-                                    "type": "boolean"
-                                },
-                                "failWarn": {
-                                    "description": "Value indicating whether the test should report failure as a warning.",
-                                    "type": "boolean"
-                                },
-                                "ignoredLinks": {
-                                    "description": "Array of links that will be ignored (i.e. not checked).",
-                                    "type": "array",
-                                    "items": {
-                                        "type": "string"
-                                    },
-                                    "uniqueItems": true,
-                                    "minItems": 0,
-                                    "maxItems": 100
-                                }
-                            },
-                            "additionalProperties": {
-                                "not": true,
-                                "errorMessage": "should NOT contain additional properties: ${0#}"
-                            },
-                            "minProperties": 1
-                        }
-                    ],
-                    "errorMessage": "should be either boolean or object with the appropriate properties"
+                "ignoreDuplicates": {
+                  "description": "Value indicating that links should only be checked once",
+                  "type": "boolean"
                 }
-            },
-            "additionalProperties": {
+              },
+              "additionalProperties": {
                 "not": true,
-                "errorMessage": "should NOT contain additional properties: ${0#}"
-            },
-            "minProperties": 1
+                "errorMessage": "must NOT contain additional properties: ${0#}"
+              },
+              "minProperties": 1
+            }
+          ],
+          "errorMessage": "must be either boolean or object with the appropriate properties"
         }
+      },
+      "additionalProperties": {
+        "not": true,
+        "errorMessage": "must NOT contain additional properties: ${0#}"
+      },
+      "minProperties": 1
     }
-}
+  }
+}

package/.codeclimate.json

@@ -1,8 +0,0 @@
-{
-  "version": "2",
-  "plugins": {
-    "eslint": {
-      "enabled": false
-    }
-  }
-}

package/.depcheckrc.json

@@ -1,3 +0,0 @@
-{
-    "ignores": ["@aarongoldenthal/stylelint-config-standard"]
-}

package/.dockerignore

@@ -1,12 +0,0 @@
-.git/
-.vscode/
-Archive/
-coverage/
-node_modules/
-.dockerignore
-.gitignore
-.gitlab-ci.yml
-.npmignore
-*Dockerfile
-junit.xml
-pagean-results.*

package/.eslintrc.json

@@ -1,19 +0,0 @@
-{
-    "env": {
-        "browser": true
-    },
-    "extends": [ 
-        "@aarongoldenthal/eslint-config-standard",
-        "@aarongoldenthal/eslint-config-standard/jest-config",
-        "@aarongoldenthal/eslint-config-standard/node-config",
-        "@aarongoldenthal/eslint-config-standard/sonarjs-config"
-    ],
-    "ignorePatterns": [
-        ".vscode/",
-        "Archive/",
-        "node_modules/",
-        "coverage/",
-        "pagean-external-scripts/"
-    ],
-    "root": true
-}

package/.gitattributes

@@ -1,4 +0,0 @@
-* text=auto
-
-*.js text eol=lf
-*.handlebars eol=lf

package/.gitlab/gitlab-releaser.json

@@ -1,16 +0,0 @@
-{
-    "defaults": {
-        "name": "$$CHANGELOG",
-        "description": "$$CHANGELOG",
-        "assets": {
-            "links": [
-                {
-                    "name": "npm",
-                    "url": "https://www.npmjs.com/package/pagean",
-                    "type": "package"
-                }
-            ]
-        },
-        "milestones": [ "${CI_COMMIT_TAG}" ]
-    }
-}

package/.htmlhintrc

@@ -1,25 +0,0 @@
-{
-  "tagname-lowercase": true,
-  "attr-lowercase": true,
-  "attr-value-double-quotes": true,
-  "attr-value-not-empty": false,
-  "attr-no-duplication": true,
-  "doctype-first": true,
-  "tag-pair": true,
-  "empty-tag-not-self-closed": true,
-  "spec-char-escape": true,
-  "id-unique": true,
-  "src-not-empty": true,
-  "title-require": true,
-  "alt-require": true,
-  "doctype-html5": true,
-  "id-class-value": "false",
-  "style-disabled": false,
-  "inline-style-disabled": false,
-  "inline-script-disabled": false,
-  "space-tab-mixed-disabled": "space",
-  "id-class-ad-disabled": false,
-  "href-abs-or-rel": false,
-  "attr-unsafe-chars": true,
-  "head-script-disabled": true
-}

package/.markdownlint.json

@@ -1,13 +0,0 @@
-{
-  "default": true,
-  "header-style": { "style": "atx" },
-  "ul-style": { "style": "dash" },
-  "ul-indent": { "indent": 2 },
-  "line-length": false,
-  "no-duplicate-header": { "siblings_only": true } ,
-  "ol-prefix": { "style": "ordered" }, 
-  "no-inline-html": false,
-  "no-bare-urls": false,
-  "hr-style": { "style": "---" },
-  "fenced-code-language": false
-}

package/.pa11yci.json

@@ -1,5 +0,0 @@
-{
-    "urls": [
-        "./pagean-results.html"
-    ]
-}

package/.pageanrc.json

@@ -1,55 +0,0 @@
-{
-    "project": "Pagean",
-    "puppeteerLaunchOptions": {
-        "args": [
-            "--no-sandbox"
-        ]
-    },
-    "settings": {
-        "pageLoadTimeTest": {
-            "pageLoadTimeThreshold": 3
-        },
-        "brokenLinkTest": {
-            "failWarn": false
-        }
-    },
-    "urls": [
-        "tests/test-cases/consoleLog.html",
-        "tests/test-cases/dynamicContent.html",
-        "tests/test-cases/horizontalScrollbar.html",
-        "tests/test-cases/htmlError.html",
-        {
-            "url": "tests/test-cases/scriptError404.html",
-            "settings": {
-                "consoleOutputTest": false,
-                "externalScriptTest": false
-            }
-        },
-        {
-            "url": "tests/test-cases/slowLoad.html",
-            "settings": {
-                "pageLoadTimeTest": {
-                    "pageLoadTimeThreshold": 2
-                },
-                "externalScriptTest": false
-            }
-        },
-        {
-            "url": "tests/test-cases/externalScripts.html",
-            "settings": {
-                "consoleOutputTest": false,
-                "consoleErrorTest": false
-            }
-        },
-        {
-            "url": "tests/test-cases/brokenLinks.html",
-            "settings": {
-                "brokenLinkTest": {
-                    "ignoredLinks": [
-                        "https://this.url.is.ignored"
-                    ]
-                }
-            }
-        }
-    ]
-}

package/.stylelintrc.json

@@ -1,7 +0,0 @@
-{
-    "extends": "stylelint-config-standard",
-    "rules": {
-        "color-hex-length": "long",
-        "indentation": 4
-    }
-}