1
1
mirror of https://github.com/theoludwig/html-w3c-validator.git synced 2025-05-21 23:21:29 +02:00

21 Commits

Author SHA1 Message Date
e3cd809e56 fix: only show error messages related to configured severities 2023-08-09 17:04:03 +02:00
284b9fb057 test: add automated tests 2023-08-09 16:51:34 +02:00
1ae47aa197 feat: add --current-working-directory option 2023-08-09 15:36:05 +02:00
d4424036c5 fix: update dependencies to latest 2023-08-09 15:01:28 +02:00
82e32f26ff chore: simplify .swcrc config 2023-07-22 12:28:45 +02:00
5abdb8a1f1 style: fix prettier issues
All checks were successful
Build / build (push) Successful in 48s
Lint / lint (push) Successful in 44s
Test / test (push) Successful in 40s
2023-07-18 23:53:21 +02:00
aab0c3f502 build(deps): update latest 2023-07-18 23:17:31 +02:00
5fa068b9f8 chore: remove unneeded @types/tap dependency 2023-07-02 15:33:41 +02:00
c7bf82135b chore: enable source maps for easier debugging 2023-07-02 15:23:04 +02:00
eb970f1823 BREAKING CHANGE: change default validator severities: "warning" and "error" 2023-07-02 13:07:45 +02:00
29203985e4 feat: ability to specify the severity of the validator
fixes #4
2023-07-02 13:05:33 +02:00
a8841b24fd perf: ignore test files in published package (reduce package size) 2023-07-02 12:27:18 +02:00
bda82b39a3 fix: update author - Théo LUDWIG 2023-07-02 12:22:39 +02:00
f7a4edc46a build(deps): update latest 2023-07-02 12:19:45 +02:00
67806866ee refactor: usage of node:test instead of tap 2023-07-02 12:18:21 +02:00
3d24ffe971 feat: add npm package provenance
Ref: https://github.blog/2023-04-19-introducing-npm-package-provenance/
2023-05-13 16:21:58 +02:00
e818556c5b build(deps): update latest 2023-05-13 16:19:21 +02:00
2cb7967bc7 build(deps): update latest 2023-04-02 21:27:42 +02:00
943b3d1fd6 fix: update dependencies to latest 2023-01-10 22:15:14 +01:00
6ca7722fcf perf: run validations in parallel
fixes #3
2022-10-20 23:46:36 +02:00
3a44eca5b1 fix: only consider errors (excluding warning/info messages) 2022-10-20 23:30:41 +02:00
47 changed files with 7457 additions and 19852 deletions

View File

@ -1,6 +1,6 @@
<!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
## What changes this PR introduce?
# What changes this PR introduce?
## List any relevant issue numbers

View File

@ -10,16 +10,18 @@ jobs:
build:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: 'actions/checkout@v3.5.3'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: 'lts/*'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Install dependencies'
run: 'npm clean-install'
- name: 'Build'
run: 'npm run build'
- run: 'npm run build:typescript'

View File

@ -10,19 +10,19 @@ jobs:
lint:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: 'actions/checkout@v3.5.3'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: 'lts/*'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Install dependencies'
run: 'npm clean-install'
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
- run: 'npm run lint:editorconfig'
- run: 'npm run lint:markdown'
- run: 'npm run lint:typescript'
- run: 'npm run lint:eslint'
- run: 'npm run lint:prettier'

View File

@ -7,24 +7,34 @@ on:
jobs:
release:
runs-on: 'ubuntu-latest'
permissions:
contents: 'write'
issues: 'write'
pull-requests: 'write'
id-token: 'write'
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: 'actions/checkout@v3.5.3'
with:
fetch-depth: 0
persist-credentials: false
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: 'lts/*'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Install dependencies'
run: 'npm clean-install'
- name: 'Build'
run: 'npm run build'
- run: 'npm 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'
env:

View File

@ -10,16 +10,16 @@ jobs:
test:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: 'actions/checkout@v3.5.3'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
- name: 'Setup Node.js'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: 'lts/*'
cache: 'npm'
- name: 'Install'
run: 'npm install'
- name: 'Install dependencies'
run: 'npm clean-install'
- name: 'Build'
run: 'npm run build'

View File

@ -0,0 +1,3 @@
{
"files": ["./example/build/index.html", "./example/build/about.html"]
}

View File

@ -1,4 +0,0 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npm run lint:commit -- --edit

View File

@ -1,5 +0,0 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"
npm run lint:staged
npm run build

11
.markdownlint-cli2.jsonc Normal file
View File

@ -0,0 +1,11 @@
{
"config": {
"extends": "markdownlint/style/prettier",
"relative-links": true,
"default": true,
"MD033": false
},
"globs": ["**/*.{md,mdx}"],
"ignores": ["**/node_modules"],
"customRules": ["markdownlint-rule-relative-links"]
}

View File

@ -1,6 +0,0 @@
{
"default": true,
"MD013": false,
"MD033": false,
"MD041": false
}

1
.npmrc
View File

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

1
.prettierignore Normal file
View File

@ -0,0 +1 @@
fixtures

15
.swcrc
View File

@ -1,22 +1,13 @@
{
"sourceMaps": true,
"jsc": {
"parser": {
"syntax": "typescript",
"decorators": true,
"dynamicImport": true
},
"transform": {
"legacyDecorator": true,
"decoratorMetadata": true
},
"target": "es2022",
"loose": true
"target": "es2022"
},
"module": {
"type": "es6",
"strict": false,
"strictMode": true,
"lazy": false,
"noInterop": false
"type": "es6"
}
}

9
.taprc
View File

@ -1,9 +0,0 @@
ts: false
jsx: false
flow: false
check-coverage: false
coverage: false
timeout: 120000
files:
- 'build/**/*.test.js'

View File

@ -3,7 +3,6 @@
"editorconfig.editorconfig",
"esbenp.prettier-vscode",
"dbaeumer.vscode-eslint",
"davidanson.vscode-markdownlint",
"ms-azuretools.vscode-docker"
"davidanson.vscode-markdownlint"
]
}

View File

@ -6,5 +6,9 @@
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll": true
}
},
"eslint.options": {
"ignorePath": ".gitignore"
},
"prettier.ignorePath": ".gitignore"
}

View File

@ -60,7 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
contact@divlo.fr.
<contact@theoludwig.fr>.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the

View File

@ -2,6 +2,14 @@
Thanks a lot for your interest in contributing to **html-w3c-validator**! 🎉
## Code of Conduct
**html-w3c-validator** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
## Open Development
All work on **html-w3c-validator** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
## Types of contributions
- Reporting a bug.
@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **html-w3c-validator**! 🎉
## Pull Requests
- **Please first discuss** the change you wish to make via [issue](https://github.com/Divlo/html-w3c-validator/issues) before making a change. It might avoid a waste of your time.
- **Please first discuss** the change you wish to make via [issue](https://github.com/theoludwig/html-w3c-validator/issues) before making a change. It might avoid a waste of your time.
- Ensure your code respect linting.
@ -21,26 +29,4 @@ If you're adding new features to **html-w3c-validator**, please include tests.
## Commits
The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases.
### Types
Types define which kind of changes you made to the project.
| Types | Description |
| -------- | ------------------------------------------------------------------------------------------------------------ |
| feat | A new feature. |
| fix | A bug fix. |
| docs | Documentation only changes. |
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). |
| refactor | A code change that neither fixes a bug nor adds a feature. |
| perf | A code change that improves performance. |
| test | Adding missing tests or correcting existing tests. |
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm). |
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
| chore | Other changes that don't modify src or test files. |
| revert | Reverts a previous commit. |
### Scopes
Scopes define what part of the code changed.
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.

View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) Divlo
Copyright (c) Théo LUDWIG
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@ -11,9 +11,9 @@
<a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
<a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
<br />
<a href="https://github.com/Divlo/html-w3c-validator/actions/workflows/build.yml"><img src="https://github.com/Divlo/html-w3c-validator/actions/workflows/build.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/Divlo/html-w3c-validator/actions/workflows/lint.yml"><img src="https://github.com/Divlo/html-w3c-validator/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/Divlo/html-w3c-validator/actions/workflows/test.yml"><img src="https://github.com/Divlo/html-w3c-validator/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/theoludwig/html-w3c-validator/actions/workflows/build.yml"><img src="https://github.com/theoludwig/html-w3c-validator/actions/workflows/build.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/theoludwig/html-w3c-validator/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/html-w3c-validator/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
<a href="https://github.com/theoludwig/html-w3c-validator/actions/workflows/test.yml"><img src="https://github.com/theoludwig/html-w3c-validator/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
<br />
<a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
@ -59,7 +59,7 @@ npm install --save-dev html-w3c-validator start-server-and-test
"start": "serve \"./build\"",
// Command to validate your HTML pages
"test:html-w3c-validator": "start-server-and-test \"start\" \"http://localhost:3000\" \"html-w3c-validator\""
"test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\""
}
}
```
@ -68,10 +68,13 @@ npm install --save-dev html-w3c-validator start-server-and-test
```jsonc
{
"urls": ["http://localhost:3000/", "http://localhost:3000/about"],
"urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
// You can also specify HTML files instead of URLs
"files": ["./index.html", "./about.html"]
"files": ["./index.html", "./about.html"],
// Specify the severities of the validator (default: ["warning", "error"])
"severities": ["info", "warning", "error"]
}
```
@ -84,8 +87,8 @@ npm run test:html-w3c-validator
Example of output (in case of success):
```txt
✔ Validating http://localhost:3000/
✔ Validating http://localhost:3000/about
✔ Validating http://127.0.0.1:3000/
✔ Validating http://127.0.0.1:3000/about
Success: HTML validation (W3C) passed! 🎉
```

View File

@ -1,4 +1,4 @@
{
"urls": ["http://localhost:3000/", "http://localhost:3000/about"],
"urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"],
"files": ["./build/index.html", "./build/about.html"]
}

View File

@ -1,4 +1,4 @@
<!DOCTYPE html>
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />

View File

@ -1,4 +1,4 @@
<!DOCTYPE html>
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />

2245
example/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -2,12 +2,12 @@
"name": "example",
"private": true,
"scripts": {
"start": "serve \"./build\"",
"test:html-w3c-validator": "start-server-and-test \"start\" \"http://localhost:3000\" \"html-w3c-validator\""
"start": "serve ./build",
"test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\""
},
"devDependencies": {
"serve": "13.0.2",
"start-server-and-test": "1.14.0",
"serve": "14.2.0",
"start-server-and-test": "2.0.0",
"html-w3c-validator": "file:.."
}
}

24010
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -4,16 +4,16 @@
"public": true,
"description": "CLI for validating multiple html pages using validator.w3.org.",
"type": "module",
"author": "Divlo <contact@divlo.fr>",
"author": "Théo LUDWIG <contact@theoludwig.fr>",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/Divlo/html-w3c-validator.git"
"url": "https://github.com/theoludwig/html-w3c-validator.git"
},
"bugs": {
"url": "https://github.com/Divlo/html-w3c-validator/issues"
"url": "https://github.com/theoludwig/html-w3c-validator/issues"
},
"homepage": "https://github.com/Divlo/html-w3c-validator#readme",
"homepage": "https://github.com/theoludwig/html-w3c-validator#readme",
"keywords": [
"cli",
"html-validator",
@ -22,64 +22,71 @@
],
"main": "build/index.js",
"bin": "build/index.js",
"files": [
"build",
"!**/*.test.js",
"!**/*.map"
],
"publishConfig": {
"access": "public",
"provenance": true
},
"engines": {
"node": ">=16.0.0",
"npm": ">=8.0.0"
"npm": ">=9.0.0"
},
"files": [
"build"
],
"scripts": {
"build": "rimraf ./build && swc ./src --out-dir ./build && tsc",
"build": "rimraf ./build && swc ./src --out-dir ./build",
"build:typescript": "tsc",
"start": "node --enable-source-maps build/index.js",
"lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
"lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
"lint:markdown": "markdownlint-cli2",
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
"lint:prettier": "prettier . --check",
"lint:staged": "lint-staged",
"test": "tap",
"release": "semantic-release",
"postinstall": "husky install",
"prepublishOnly": "pinst --disable",
"postpublish": "pinst --enable"
"test": "node --enable-source-maps --test build/",
"release": "semantic-release"
},
"dependencies": {
"chalk": "5.0.1",
"clipanion": "3.1.0",
"html-validator": "6.0.0",
"ora": "6.1.0",
"read-pkg": "7.1.0",
"table": "6.8.0"
"chalk": "5.3.0",
"clipanion": "3.2.1",
"html-validator": "6.0.1",
"log-symbols": "5.1.0",
"ora": "7.0.1",
"read-pkg": "8.0.0",
"table": "6.8.1"
},
"devDependencies": {
"@commitlint/cli": "16.2.3",
"@commitlint/config-conventional": "16.2.1",
"@swc/cli": "0.1.57",
"@swc/core": "1.2.163",
"@types/html-validator": "5.0.2",
"@commitlint/cli": "17.7.0",
"@commitlint/config-conventional": "17.7.0",
"@swc/cli": "0.1.62",
"@swc/core": "1.3.75",
"@tsconfig/strictest": "2.0.1",
"@types/html-validator": "5.0.3",
"@types/mock-fs": "4.13.1",
"@types/node": "17.0.23",
"@types/tap": "15.0.6",
"@typescript-eslint/eslint-plugin": "5.18.0",
"editorconfig-checker": "4.0.2",
"eslint": "8.12.0",
"eslint-config-conventions": "2.0.0",
"eslint-config-prettier": "8.5.0",
"eslint-plugin-import": "2.26.0",
"eslint-plugin-prettier": "4.0.0",
"eslint-plugin-promise": "6.0.0",
"eslint-plugin-unicorn": "42.0.0",
"execa": "6.1.0",
"husky": "7.0.4",
"lint-staged": "12.3.7",
"markdownlint-cli": "0.31.1",
"mock-fs": "5.1.2",
"pinst": "3.0.0",
"prettier": "2.6.2",
"rimraf": "3.0.2",
"semantic-release": "19.0.2",
"serve": "13.0.2",
"tap": "16.0.1",
"typescript": "4.6.3"
"@types/node": "20.4.9",
"@types/sinon": "10.0.16",
"@typescript-eslint/eslint-plugin": "6.3.0",
"@typescript-eslint/parser": "6.3.0",
"editorconfig-checker": "5.1.1",
"eslint": "8.46.0",
"eslint-config-conventions": "11.0.1",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-import": "2.28.0",
"eslint-plugin-prettier": "5.0.0",
"eslint-plugin-promise": "6.1.1",
"eslint-plugin-unicorn": "48.0.1",
"execa": "7.2.0",
"lint-staged": "13.2.3",
"markdownlint-cli2": "0.8.1",
"markdownlint-rule-relative-links": "2.1.0",
"mock-fs": "5.2.0",
"prettier": "3.0.1",
"rimraf": "5.0.1",
"semantic-release": "21.0.7",
"serve": "14.2.0",
"sinon": "15.2.0",
"typescript": "5.1.6"
}
}

View File

@ -1,23 +1,30 @@
import path from 'node:path'
import fs from 'node:fs'
import { Command } from 'clipanion'
import { Command, Option } from 'clipanion'
import * as typanion from 'typanion'
import chalk from 'chalk'
import ora from 'ora'
import validateHTML, {
import logSymbols from 'log-symbols'
import type {
ValidationMessageLocationObject,
ParsedJsonAsValidationResults
} from 'html-validator'
import validateHTML from 'html-validator'
import { table } from 'table'
import { isExistingPath } from './utils/isExistingPath.js'
const CURRENT_DIRECTORY = process.cwd()
const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
export const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
export const SEVERITIES = ['error', 'warning', 'info'] as const
export type Severity = (typeof SEVERITIES)[number]
interface Config {
urls?: string[]
files?: string[]
severities?: Severity[]
}
interface Error {
@ -25,21 +32,44 @@ interface Error {
messagesTable: string[][]
}
interface Result {
data: string
isSuccess: boolean
}
const printResults = (results: Result[]): void => {
for (const result of results) {
if (result.isSuccess) {
console.log(logSymbols.success, result.data)
} else {
console.log(logSymbols.error, result.data)
}
}
}
export class HTMLValidatorCommand extends Command {
static usage = {
static override usage = {
description:
'CLI for validating multiple html pages using <https://validator.w3.org/>.'
}
async execute(): Promise<number> {
const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME)
public currentWorkingDirectory = Option.String(
'--current-working-directory',
process.cwd(),
{
description: 'The current working directory.',
validator: typanion.isString()
}
)
public async execute(): Promise<number> {
const configPath = path.join(this.currentWorkingDirectory, CONFIG_FILE_NAME)
try {
if (!(await isExistingPath(configPath))) {
throw new Error(
`No config file found at ${configPath}. Please create ${CONFIG_FILE_NAME}.`
`No config file found at ${configPath}. Please create "${CONFIG_FILE_NAME}".`
)
}
const configData = await fs.promises.readFile(configPath, {
encoding: 'utf-8'
})
@ -50,12 +80,19 @@ export class HTMLValidatorCommand extends Command {
} catch {
isValidConfig = false
}
isValidConfig =
isValidConfig &&
(Array.isArray(config.urls) || Array.isArray(config.urls))
if (!isValidConfig) {
throw new Error(
`Invalid config file at ${configPath}. Please check the syntax.`
`Invalid config file at "${configPath}". Please check the JSON syntax.`
)
}
if (config.urls != null && !Array.isArray(config.urls)) {
throw new Error(
`Invalid config file at "${configPath}". Please include an array of URLs.`
)
}
if (config.files != null && !Array.isArray(config.files)) {
throw new Error(
`Invalid config file at "${configPath}". Please include an array of files.`
)
}
const urls =
@ -71,74 +108,115 @@ export class HTMLValidatorCommand extends Command {
return { type: 'file', data: file }
})
const dataToValidate = [...urls, ...files]
const errors: Error[] = []
let isValid = true
for (const { data, type } of dataToValidate) {
const loader = ora(`Validating ${data}`).start()
try {
const options = {
format: 'json' as 'json' | undefined
}
let result: ParsedJsonAsValidationResults | undefined
if (type === 'url') {
result = await validateHTML({
url: data,
isLocal: true,
...options
})
} else if (type === 'file') {
const htmlPath = path.resolve(CURRENT_DIRECTORY, data)
if (!(await isExistingPath(htmlPath))) {
throw new Error(
`No file found at ${htmlPath}. Please check the path.`
)
}
const html = await fs.promises.readFile(htmlPath, {
encoding: 'utf-8'
})
result = await validateHTML({
data: html,
...options
})
} else {
throw new Error('Invalid type')
}
const isValidHTML = result.messages.length === 0
if (isValidHTML) {
loader.succeed()
} else {
loader.fail()
const messagesTable: string[][] = []
for (const message of result.messages) {
const row: string[] = []
if (message.type === 'error') {
row.push(chalk.red(message.type))
} else {
row.push(chalk.yellow(message.type))
}
row.push(message.message)
const violation = message as ValidationMessageLocationObject
if (violation.extract != null) {
row.push(
`line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}`
)
}
messagesTable.push(row)
}
errors.push({ data, messagesTable })
isValid = false
}
} catch (error) {
loader.fail()
isValid = false
if (error instanceof Error) {
const messagesTable: string[][] = [[error.message]]
errors.push({ data, messagesTable })
}
if (dataToValidate.length === 0) {
throw new Error(
`Invalid config file at "${configPath}". Please add URLs or files.`
)
}
const severities: Severity[] = config.severities ?? ['warning', 'error']
for (const severity of severities) {
if (!SEVERITIES.includes(severity)) {
throw new Error(
`Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
', '
)}).`
)
}
}
if (severities.length === 0) {
throw new Error(
`Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
', '
)}).`
)
}
const errors: Error[] = []
let isValid = true
const loader = ora(`Validating HTML (W3C)...`).start()
const results: Result[] = []
await Promise.all(
dataToValidate.map(async ({ data, type }) => {
try {
const options = {
format: 'json' as 'json' | undefined
}
let result: ParsedJsonAsValidationResults | undefined
if (type === 'url') {
result = await validateHTML({
url: data,
isLocal: true,
...options
})
} else if (type === 'file') {
const htmlPath = path.resolve(this.currentWorkingDirectory, data)
if (!(await isExistingPath(htmlPath))) {
throw new Error(
`No file found at "${htmlPath}". Please check the path.`
)
}
const html = await fs.promises.readFile(htmlPath, {
encoding: 'utf-8'
})
result = await validateHTML({
data: html,
...options
})
} else {
throw new Error('Invalid type')
}
const hasErrors = result.messages.some((message) => {
return (
severities.includes(message.type as Severity) ||
severities.includes(message.subType as Severity)
)
})
if (!hasErrors) {
results.push({ data, isSuccess: true })
} else {
results.push({ data, isSuccess: false })
const messagesTable: string[][] = []
for (const message of result.messages) {
if (
!severities.includes(message.type as Severity) &&
!severities.includes(message.subType as Severity)
) {
continue
}
const row: string[] = []
if (message.type === 'info') {
if (message.subType === 'warning') {
row.push(chalk.yellow(message.subType))
} else {
row.push(chalk.blue(message.type))
}
} else {
row.push(chalk.red(message.type))
}
row.push(message.message)
const violation = message as ValidationMessageLocationObject
if (violation.extract != null) {
row.push(
`line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}`
)
}
messagesTable.push(row)
}
errors.push({ data, messagesTable })
isValid = false
}
} catch (error) {
isValid = false
if (error instanceof Error) {
const messagesTable: string[][] = [[error.message]]
errors.push({ data, messagesTable })
}
}
})
)
if (!isValid) {
loader.fail()
printResults(results)
for (const error of errors) {
console.error(`\n${error.data}`)
console.error(table(error.messagesTable))
@ -147,10 +225,10 @@ export class HTMLValidatorCommand extends Command {
console.error()
throw new Error('HTML validation (W3C) failed!')
}
console.log()
console.log(
loader.succeed(
`${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉`
)
printResults(results)
return 0
} catch (error) {
if (error instanceof Error) {

View File

@ -1,21 +1,416 @@
import tap from 'tap'
import test from 'node:test'
import assert from 'node:assert/strict'
import path from 'node:path'
import { PassThrough } from 'node:stream'
import sinon from 'sinon'
import { execa } from 'execa'
import { table } from 'table'
import chalk from 'chalk'
import logSymbols from 'log-symbols'
import { cli } from '../cli.js'
import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js'
import {
HTMLValidatorCommand,
CONFIG_FILE_NAME,
SEVERITIES
} from '../HTMLValidatorCommand.js'
await tap.test('html-w3c-validator', async (t) => {
await t.test('should be instance of the command', async (t) => {
const command = cli.process([])
t.equal(command instanceof HTMLValidatorCommand, true)
const FIXTURES_PATH = path.join(process.cwd(), 'src', '__test__', 'fixtures')
await test('html-w3c-validator', async (t) => {
t.afterEach(() => {
sinon.restore()
})
await t.test('succeeds and validate the html correctly', async (t) => {
const exampleURL = new URL('../../example', import.meta.url)
process.chdir(exampleURL.pathname)
await execa('rimraf', ['node_modules'])
await execa('npm', ['install'])
const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator'])
t.equal(exitCode, 0)
await t.test('should be instance of the command', async () => {
const command = cli.process([])
assert(command instanceof HTMLValidatorCommand)
})
await t.test(
'succeeds and validate the html correctly (example)',
async () => {
const exampleURL = new URL('../../example', import.meta.url)
process.chdir(exampleURL.pathname)
await execa('rimraf', ['node_modules'])
await execa('npm', ['install'])
const { exitCode } = await execa('npm', [
'run',
'test:html-w3c-validator'
])
assert.strictEqual(exitCode, 0)
}
)
await t.test(
'succeeds and validate the html correctly (example without working directory)',
async () => {
const logs: string[] = []
sinon.stub(console, 'log').value((log: string) => {
logs.push(log)
})
const consoleLogSpy = sinon.spy(console, 'log')
const stream = new PassThrough()
const exitCode = await cli.run([], {
stdin: process.stdin,
stdout: stream,
stderr: stream
})
stream.end()
assert.strictEqual(exitCode, 0)
assert.strictEqual(
consoleLogSpy.calledWith(
logSymbols.success,
'./example/build/index.html'
),
true,
logs.join('\n')
)
assert.strictEqual(
consoleLogSpy.calledWith(
logSymbols.success,
'./example/build/about.html'
),
true,
logs.join('\n')
)
}
)
await t.test(
'succeeds and validate the html correctly (fixture)',
async () => {
const workingDirectory = path.join(FIXTURES_PATH, 'success')
const logs: string[] = []
sinon.stub(console, 'log').value((log: string) => {
logs.push(log)
})
const consoleLogSpy = sinon.spy(console, 'log')
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, 0)
assert.strictEqual(
consoleLogSpy.calledWith(logSymbols.success, './build/index.html'),
true,
logs.join('\n')
)
assert.strictEqual(
consoleLogSpy.calledWith(logSymbols.success, './build/about.html'),
true,
logs.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)
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)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` No config file found at ${configPath}. Please create "${CONFIG_FILE_NAME}".`
),
true,
errors.join('\n')
)
})
await t.test('fails with invalid JSON config', async () => {
const workingDirectory = path.join(
FIXTURES_PATH,
'error-config-invalid-json'
)
const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
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)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` Invalid config file at "${configPath}". Please check the JSON syntax.`
),
true,
errors.join('\n')
)
})
await t.test('fails with invalid URLs config', async () => {
const workingDirectory = path.join(
FIXTURES_PATH,
'error-config-invalid-urls'
)
const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
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)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` Invalid config file at "${configPath}". Please include an array of URLs.`
),
true,
errors.join('\n')
)
})
await t.test('fails with invalid files config', async () => {
const workingDirectory = path.join(
FIXTURES_PATH,
'error-config-invalid-files'
)
const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
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)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` Invalid config file at "${configPath}". Please include an array of files.`
),
true,
errors.join('\n')
)
})
await t.test('fails with invalid files and urls config', async () => {
const workingDirectory = path.join(
FIXTURES_PATH,
'error-config-invalid-files-and-urls'
)
const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
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)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` Invalid config file at "${configPath}". Please add URLs or files.`
),
true,
errors.join('\n')
)
})
await t.test('fails with invalid severities config', async () => {
const workingDirectory = path.join(
FIXTURES_PATH,
'error-config-invalid-severities'
)
const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
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)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
', '
)}).`
),
true,
errors.join('\n')
)
})
await t.test('fails with invalid empty severities config', async () => {
const workingDirectory = path.join(
FIXTURES_PATH,
'error-config-invalid-severities-empty'
)
const configPath = path.join(workingDirectory, CONFIG_FILE_NAME)
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)
assert.strictEqual(
consoleErrorSpy.calledWith(
chalk.bold.red('Error:') +
` Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
', '
)}).`
),
true,
errors.join('\n')
)
})
await t.test('fails with invalid files paths to check', async () => {
const workingDirectory = path.join(
FIXTURES_PATH,
'error-invalid-files-paths-to-check'
)
const htmlPath = path.resolve(workingDirectory, 'index.html')
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 = [
[`No file found at "${htmlPath}". Please check the path.`]
]
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 invalid W3C HTML', async () => {
const workingDirectory = path.join(FIXTURES_PATH, 'error-invalid-w3c-html')
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.yellow('warning'),
'Consider adding a “lang” attribute to the “html” start tag to declare the language of this document.',
'line: 2, column: 16-6'
]
]
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')
)
})
})

View File

@ -0,0 +1,4 @@
{
"urls": [],
"files": []
}

View File

@ -0,0 +1,3 @@
{
"files": "Invalid"
}

View File

@ -0,0 +1 @@
Invalid JSON

View File

@ -0,0 +1,4 @@
{
"files": ["./index.html"],
"severities": []
}

View File

@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Home</title>
</head>
<body></body>
</html>

View File

@ -0,0 +1,4 @@
{
"files": ["./index.html"],
"severities": ["errors-invalid"]
}

View File

@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Home</title>
</head>
<body></body>
</html>

View File

@ -0,0 +1,3 @@
{
"urls": "Invalid"
}

View File

@ -0,0 +1,3 @@
{
"files": ["./index.html"]
}

View File

@ -0,0 +1,3 @@
{
"files": ["./build/index.html", "./build/about.html"]
}

View File

@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>About</title>
</head>
<body></body>
</html>

View File

@ -0,0 +1,9 @@
<!doctype html>
<html>
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Home</title>
</head>
<body></body>
</html>

View File

@ -0,0 +1,3 @@
{
"files": ["./build/index.html", "./build/about.html"]
}

View File

@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>About</title>
</head>
<body></body>
</html>

View File

@ -0,0 +1,9 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Home</title>
</head>
<body></body>
</html>

View File

@ -1,9 +1,11 @@
import test from 'node:test'
import assert from 'node:assert/strict'
import fsMock from 'mock-fs'
import tap from 'tap'
import { isExistingPath } from '../isExistingPath.js'
await tap.test('utils/isExistingPath', async (t) => {
await test('utils/isExistingPath', async (t) => {
t.afterEach(() => {
fsMock.restore()
})
@ -12,13 +14,13 @@ await tap.test('utils/isExistingPath', async (t) => {
fsMock({
'/file.txt': ''
})
t.equal(await isExistingPath('/file.txt'), true)
assert.strictEqual(await isExistingPath('/file.txt'), true)
})
await t.test("should return false if the file doesn't exists", async () => {
fsMock({
'/file.txt': ''
})
t.equal(await isExistingPath('/randomfile.txt'), false)
assert.strictEqual(await isExistingPath('/randomfile.txt'), false)
})
})

View File

@ -1,4 +1,5 @@
{
"extends": "@tsconfig/strictest/tsconfig.json",
"compilerOptions": {
"target": "ESNext",
"module": "ESNext",
@ -7,8 +8,6 @@
"outDir": "./build",
"rootDir": "./src",
"noEmit": true,
"strict": true,
"skipLibCheck": true,
"esModuleInterop": true
"exactOptionalPropertyTypes": false
}
}