feat: json $schema locally => ./node_modules/html-w3c-validator/schema/schema.json

There was an error thrown by `table` library to print validation results
when there were 2 (or more) errors, with one error with line/column
and the other error without specified line/column.

Fixes #6

.commitlintrc.json

@@ -1 +0,0 @@
-{ "extends": ["@commitlint/config-conventional"] }

.eslintrc.json

@@ -1,16 +1,18 @@
 {
-  "extends": ["conventions", "prettier"],
-  "plugins": ["prettier", "import", "unicorn"],
-  "parserOptions": {
-    "project": "./tsconfig.json"
-  },
-  "env": {
-    "node": true
-  },
-  "rules": {
-    "prettier/prettier": "error",
-    "import/extensions": ["error", "always"],
-    "unicorn/prevent-abbreviations": "error",
-    "unicorn/prefer-node-protocol": "error"
-  }
+  "root": true,
+  "extends": ["conventions"],
+  "plugins": ["promise", "unicorn"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parser": "@typescript-eslint/parser",
+      "plugins": ["@typescript-eslint"],
+      "parserOptions": {
+        "projectService": true
+      },
+      "rules": {
+        "@typescript-eslint/no-unnecessary-condition": "off"
+      }
+    }
+  ]
 }

.github/ISSUE_TEMPLATE/BUG.md

@@ -6,8 +6,8 @@ labels: "bug"
 ---
 
 <!--
-  Please provide a clear and concise description of what the bug is. Include
-  screenshots if needed. Please make sure your issue has not already been fixed.
+Please provide a clear and concise description of what the bug is.
+Include screenshots if needed. Please make sure your issue has not already been fixed.
 -->
 
 ## Steps To Reproduce

.github/workflows/build.yml

@@ -4,16 +4,16 @@ on:
   push:
     branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   build:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.2.2"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.1.0"
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -22,6 +22,6 @@ jobs:
         run: "npm clean-install"
 
       - name: "Build"
-        run: "npm run build"
+        run: "node --run build"
 
-      - run: "npm run build:typescript"
+      - run: "node --run build:typescript"

.github/workflows/lint.yml

@@ -4,16 +4,16 @@ on:
   push:
     branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   lint:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.2.2"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.1.0"
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -21,7 +21,6 @@ jobs:
       - name: "Install dependencies"
         run: "npm clean-install"
 
-      - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
-      - run: "npm run lint:editorconfig"
-      - run: "npm run lint:eslint"
-      - run: "npm run lint:prettier"
+      - run: "node --run lint:editorconfig"
+      - run: "node --run lint:eslint"
+      - run: "node --run lint:prettier"

.github/workflows/release.yml

@@ -2,7 +2,7 @@ name: "Release"
 
 on:
   push:
-    branches: [master]
+    branches: [main, beta]
 
 jobs:
   release:
@@ -13,13 +13,13 @@ jobs:
       pull-requests: "write"
       id-token: "write"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.2.2"
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.1.0"
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -28,15 +28,15 @@ jobs:
         run: "npm clean-install"
 
       - name: "Build"
-        run: "npm run build"
+        run: "node --run build"
 
-      - run: "npm run build:typescript"
+      - run: "node --run build:typescript"
 
       - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
         run: "npm audit signatures"
 
       - name: "Release"
-        run: "npm run release"
+        run: "node --run release"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yml

@@ -4,16 +4,16 @@ on:
   push:
     branches: [develop]
   pull_request:
-    branches: [master, develop]
+    branches: [main, develop]
 
 jobs:
   test:
     runs-on: "ubuntu-latest"
     steps:
-      - uses: "actions/checkout@v4.1.1"
+      - uses: "actions/checkout@v4.2.2"
 
       - name: "Setup Node.js"
-        uses: "actions/setup-node@v4.0.1"
+        uses: "actions/setup-node@v4.1.0"
         with:
           node-version: "lts/*"
           cache: "npm"
@@ -22,7 +22,7 @@ jobs:
         run: "npm clean-install"
 
       - name: "Build"
-        run: "npm run build"
+        run: "node --run build"
 
       - name: "Test"
-        run: "npm run test"
+        run: "node --run test"

.husky/commit-msg

@@ -1,3 +0,0 @@
-#!/usr/bin/env sh
-
-npm run lint:commit -- --edit

.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-
-npm run lint:staged
-npm run build:typescript

.lintstagedrc.json

@@ -1,6 +0,0 @@
-{
-  "**/*": ["editorconfig-checker", "prettier --write --ignore-unknown"],
-  "**/*.{js,jsx,ts,tsx}": [
-    "eslint --fix --max-warnings 0 --report-unused-disable-directives"
-  ]
-}

.npmrc

@@ -1,2 +1,2 @@
-save-exact=true
-provenance=true
+save-exact = true
+provenance = true

.releaserc.json

@@ -1,18 +1,8 @@
 {
-  "branches": ["master"],
+  "branches": ["main", { "name": "beta", "prerelease": true }],
   "plugins": [
-    [
-      "@semantic-release/commit-analyzer",
-      {
-        "preset": "conventionalcommits"
-      }
-    ],
-    [
-      "@semantic-release/release-notes-generator",
-      {
-        "preset": "conventionalcommits"
-      }
-    ],
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
     "@semantic-release/npm",
     "@semantic-release/github"
   ]

.vscode/extensions.json

@@ -1,8 +0,0 @@
-{
-  "recommendations": [
-    "editorconfig.editorconfig",
-    "esbenp.prettier-vscode",
-    "dbaeumer.vscode-eslint",
-    "davidanson.vscode-markdownlint"
-  ]
-}

.vscode/settings.json

@@ -1,14 +0,0 @@
-{
-  "typescript.tsdk": "node_modules/typescript/lib",
-  "typescript.preferences.importModuleSpecifierEnding": "js",
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "prettier.configPath": ".prettierrc.json",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll": "explicit"
-  },
-  "eslint.options": {
-    "ignorePath": ".gitignore"
-  },
-  "prettier.ignorePath": ".gitignore"
-}

README.md

@@ -66,7 +66,7 @@ npm install --save-dev html-w3c-validator start-server-and-test
 
 ```jsonc
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/main/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "./node_modules/html-w3c-validator/schema/schema.json",
 
   // URLs to validate.
   "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
@@ -82,7 +82,7 @@ npm install --save-dev html-w3c-validator start-server-and-test
 ## Usage
 
 ```sh
-npm run test:html-w3c-validator
+node --run test:html-w3c-validator
 ```
 
 Example of output (in case of success):

example/.html-w3c-validatorrc.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "./node_modules/html-w3c-validator/schema/schema.json",
   "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
   "files": ["./build/index.html", "./build/about.html"]
 }

example/package.json

@@ -6,8 +6,8 @@
     "test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\""
   },
   "devDependencies": {
-    "serve": "14.2.1",
-    "start-server-and-test": "2.0.3",
+    "serve": "14.2.4",
+    "start-server-and-test": "2.0.8",
     "html-w3c-validator": "file:.."
   }
 }

package.json

@@ -25,6 +25,7 @@
   "bin": "build/index.js",
   "files": [
     "build",
+    "./schema/schema.json",
     "!**/*.test.js",
     "!**/*.map"
   ],
@@ -33,56 +34,44 @@
     "provenance": true
   },
   "engines": {
-    "node": ">=16.0.0",
-    "npm": ">=9.0.0"
+    "node": ">=16.0.0"
   },
   "scripts": {
     "build": "swc ./src --out-dir ./build --strip-leading-paths --delete-dir-on-start",
     "build:typescript": "tsc",
     "start": "node --enable-source-maps build/index.js",
-    "lint:commit": "commitlint",
     "lint:editorconfig": "editorconfig-checker",
     "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
     "lint:prettier": "prettier . --check",
-    "lint:staged": "lint-staged",
     "test": "node --enable-source-maps --test",
-    "release": "semantic-release",
-    "postinstall": "husky"
+    "release": "semantic-release"
   },
   "dependencies": {
     "chalk": "5.3.0",
     "clipanion": "3.2.1",
     "log-symbols": "6.0.0",
-    "ora": "8.0.1",
+    "ora": "8.1.1",
     "read-pkg": "9.0.1",
-    "table": "6.8.1"
+    "table": "6.8.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "18.6.0",
-    "@commitlint/config-conventional": "18.6.0",
-    "@swc/cli": "0.3.6",
-    "@swc/core": "1.3.107",
-    "@tsconfig/strictest": "2.0.2",
-    "@types/node": "20.11.16",
+    "@swc/cli": "0.5.0",
+    "@swc/core": "1.9.1",
+    "@tsconfig/strictest": "2.0.5",
+    "@types/node": "22.9.0",
     "@types/sinon": "17.0.3",
-    "@typescript-eslint/eslint-plugin": "6.20.0",
-    "@typescript-eslint/parser": "6.20.0",
-    "editorconfig-checker": "5.1.2",
-    "eslint": "8.56.0",
-    "eslint-config-conventions": "13.1.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-import": "2.29.1",
-    "eslint-plugin-prettier": "5.1.3",
-    "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-unicorn": "50.0.1",
-    "execa": "8.0.1",
-    "husky": "9.0.10",
-    "lint-staged": "15.2.1",
-    "pinst": "3.0.0",
-    "prettier": "3.2.4",
-    "semantic-release": "23.0.0",
-    "serve": "14.2.1",
-    "sinon": "17.0.1",
-    "typescript": "5.3.3"
+    "@typescript-eslint/eslint-plugin": "8.13.0",
+    "@typescript-eslint/parser": "8.13.0",
+    "editorconfig-checker": "6.0.0",
+    "eslint": "8.57.1",
+    "eslint-config-conventions": "16.0.1",
+    "eslint-plugin-promise": "7.1.0",
+    "eslint-plugin-unicorn": "55.0.0",
+    "execa": "9.5.1",
+    "prettier": "3.3.3",
+    "semantic-release": "23.1.1",
+    "serve": "14.2.4",
+    "sinon": "19.0.2",
+    "typescript": "5.6.3"
   }
 }

schema/schema.json

@@ -1,14 +1,12 @@
 {
-  "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/main/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "html-w3c-validator://config/schema.json",
   "title": "html-w3c-validator configuration schema",
   "type": "object",
   "properties": {
     "$schema": {
-      "description": "JSON Schema URI",
-      "type": "string",
-      "format": "uri",
-      "default": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/main/schema/html-w3c-validatorrc-schema.json"
+      "description": "JSON Schema",
+      "type": "string"
     },
     "urls": {
       "description": "URLs to validate.",

src/HTMLValidatorCommand.ts

@@ -66,7 +66,7 @@ export class HTMLValidatorCommand extends Command {
         configData = await fs.promises.readFile(configPath, {
           encoding: "utf-8",
         })
-      } catch (error) {
+      } catch {
         throw new Error(
           `No config file found at ${configPath}. Please create "${CONFIG_FILE_NAME}".`,
         )
@@ -143,7 +143,7 @@ export class HTMLValidatorCommand extends Command {
                 html = await fs.promises.readFile(htmlPath, {
                   encoding: "utf-8",
                 })
-              } catch (error) {
+              } catch {
                 throw new Error(
                   `No file found at "${htmlPath}". Please check the path.`,
                 )
@@ -184,10 +184,17 @@ export class HTMLValidatorCommand extends Command {
                   row.push(chalk.red(message.type))
                 }
                 row.push(message.message)
-                if (message.extract != null) {
+                if (
+                  message.extract != null &&
+                  message.lastLine != null &&
+                  message.firstColumn != null &&
+                  message.lastColumn != null
+                ) {
                   row.push(
                     `line: ${message.lastLine}, column: ${message.firstColumn}-${message.lastColumn}`,
                   )
+                } else {
+                  row.push("")
                 }
                 messagesTable.push(row)
               }

src/__test__/HTMLValidatorCommand.test.ts

@@ -40,8 +40,8 @@ await test("html-w3c-validator", async (t) => {
         { recursive: true, force: true },
       )
       await execa("npm", ["install"])
-      const { exitCode } = await execa("npm", [
-        "run",
+      const { exitCode } = await execa("node", [
+        "--run",
         "test:html-w3c-validator",
       ])
       assert.strictEqual(exitCode, 0)
@@ -52,8 +52,8 @@ await test("html-w3c-validator", async (t) => {
     "succeeds and validate the html correctly (example without working directory)",
     async () => {
       const logs: string[] = []
-      sinon.stub(console, "log").value((log: string) => {
-        logs.push(log)
+      sinon.stub(console, "log").value((...log: string[]) => {
+        logs.push(...log)
       })
       const consoleLogSpy = sinon.spy(console, "log")
       const stream = new PassThrough()
@@ -63,7 +63,7 @@ await test("html-w3c-validator", async (t) => {
         stderr: stream,
       })
       stream.end()
-      assert.strictEqual(exitCode, 0)
+      assert.strictEqual(exitCode, 0, logs.join("\n"))
       assert.strictEqual(
         consoleLogSpy.calledWith(
           logSymbols.success,
@@ -88,8 +88,8 @@ await test("html-w3c-validator", async (t) => {
     async () => {
       const workingDirectory = path.join(FIXTURES_PATH, "success")
       const logs: string[] = []
-      sinon.stub(console, "log").value((log: string) => {
-        logs.push(log)
+      sinon.stub(console, "log").value((...log: string[]) => {
+        logs.push(...log)
       })
       const consoleLogSpy = sinon.spy(console, "log")
       const stream = new PassThrough()
@@ -102,7 +102,7 @@ await test("html-w3c-validator", async (t) => {
         },
       )
       stream.end()
-      assert.strictEqual(exitCode, 0)
+      assert.strictEqual(exitCode, 0, logs.join("\n"))
       assert.strictEqual(
         consoleLogSpy.calledWith(logSymbols.success, "./build/index.html"),
         true,
@@ -116,6 +116,53 @@ await test("html-w3c-validator", async (t) => {
     },
   )
 
+  await t.test(
+    "fails by validating the html correctly with 2 errors: one with line/column, the other without (GitHub issue #6)",
+    async () => {
+      const workingDirectory = path.join(FIXTURES_PATH, "issue-6")
+      const errors: string[] = []
+      sinon.stub(console, "error").value((error: string) => {
+        errors.push(error)
+      })
+      const consoleErrorSpy = sinon.spy(console, "error")
+      const stream = new PassThrough()
+      const exitCode = await cli.run(
+        [`--current-working-directory=${workingDirectory}`],
+        {
+          stdin: process.stdin,
+          stdout: stream,
+          stderr: stream,
+        },
+      )
+      stream.end()
+      assert.strictEqual(exitCode, 1)
+      const messagesTable = [
+        [
+          chalk.red("error"),
+          "The character encoding was not declared. Proceeding using “windows-1252”.",
+          "",
+        ],
+        [
+          chalk.yellow("warning"),
+          "Consider adding a “lang” attribute to the “html” start tag to declare the language of this document.",
+          "line: 2, column: 16-7",
+        ],
+      ]
+      assert.strictEqual(
+        consoleErrorSpy.calledWith(
+          chalk.bold.red("Error:") + " HTML validation (W3C) failed!",
+        ),
+        true,
+        errors.join("\n"),
+      )
+      assert.strictEqual(
+        consoleErrorSpy.calledWith(table(messagesTable)),
+        true,
+        errors.join("\n"),
+      )
+    },
+  )
+
   await t.test("fails with not found config", async () => {
     const workingDirectory = path.join(FIXTURES_PATH, "error-config-not-found")
     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)

src/__test__/fixtures/error-config-invalid-files-and-urls/.html-w3c-validatorrc.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "../../../../schema/schema.json",
   "urls": [],
   "files": []
 }

src/__test__/fixtures/error-config-invalid-files/.html-w3c-validatorrc.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "../../../../schema/schema.json",
   "files": "Invalid"
 }

src/__test__/fixtures/error-config-invalid-severities-empty/.html-w3c-validatorrc.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "../../../../schema/schema.json",
   "files": ["./index.html"],
   "severities": []
 }

src/__test__/fixtures/error-config-invalid-severities/.html-w3c-validatorrc.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "../../../../schema/schema.json",
   "files": ["./index.html"],
   "severities": ["errors-invalid"]
 }

src/__test__/fixtures/error-config-invalid-urls/.html-w3c-validatorrc.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "../../../../schema/schema.json",
   "urls": "Invalid"
 }

src/__test__/fixtures/error-invalid-files-paths-to-check/.html-w3c-validatorrc.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "../../../../schema/schema.json",
   "files": ["./index.html"]
 }

src/__test__/fixtures/error-invalid-w3c-html/.html-w3c-validatorrc.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "../../../../schema/schema.json",
   "files": ["./build/index.html", "./build/about.html"]
 }

src/__test__/fixtures/issue-6/.html-w3c-validatorrc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "../../../../schema/schema.json",
+  "files": ["./build/index.html"],
+  "severities": ["info", "warning", "error"]
+}

src/__test__/fixtures/issue-6/build/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<title>Have We Stopped Killing Yet?</title>
+<link rel=icon href=favicon.ico>
+<link rel=stylesheet href=setup/default.css>
+<meta name=viewport content="initial-scale=1,width=device-width">
+<meta property="og:image" content="https://mirrors.meiert.org/havewestoppedkillingyet.org/media/redrum.png">
+<h1>Have We Stopped Killing Yet?</h1>
+<p><strong>No.</strong>
+<p>This is <a href=https://meiert.com/en/blog/on-taking-life/>unacceptable</a>.
+<p>We don’t need arms and armies and industrial slaughterhouses.
+<p>We need respect for life.
+<p>Everyone can <em>do something</em>. Speaking up is doing something. <a href=https://meiert.com/en/><img src=https://hell.meiert.org/core/png/meiert-logo-80x80-alt.png alt="Jens Oliver Meiert"></a>

src/__test__/fixtures/success/.html-w3c-validatorrc.json

@@ -1,4 +1,4 @@
 {
-  "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json",
+  "$schema": "../../../../schema/schema.json",
   "files": ["./build/index.html", "./build/about.html"]
 }

src/validateHTML.ts

@@ -7,9 +7,9 @@ export interface ValidationMessage {
   subType?: "warning" | "fatal" | "internal" | "io" | "schema"
   message: string
   extract?: string
-  lastLine: number
-  firstColumn: number
-  lastColumn: number
+  lastLine?: number
+  firstColumn?: number
+  lastColumn?: number
 }
 
 export interface ValidateHTMLResult {
@@ -30,7 +30,7 @@ export const validateHTML = async (
     },
   })
   if (!response.ok) {
-    throw new Error(`Failed to validate HTML`)
+    throw new Error(response.statusText)
   }
   const result = (await response.json()) as ValidateHTMLResult
   return result

tsconfig.json

@@ -9,6 +9,6 @@
     "rootDir": "./src",
     "noEmit": true,
     "exactOptionalPropertyTypes": false,
-    "checkJs": false,
-  },
+    "checkJs": false
+  }
 }