mirror of
https://github.com/theoludwig/html-w3c-validator.git
synced 2025-05-21 23:21:29 +02:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
e3cd809e56
|
|||
|
284b9fb057
|
|||
|
1ae47aa197
|
|||
|
d4424036c5
|
|||
|
82e32f26ff
|
|||
|
5abdb8a1f1
|
|||
|
aab0c3f502
|
|||
|
5fa068b9f8
|
3
.html-w3c-validatorrc.json
Normal file
3
.html-w3c-validatorrc.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"files": ["./example/build/index.html", "./example/build/about.html"]
|
||||||
|
}
|
||||||
1
.prettierignore
Normal file
1
.prettierignore
Normal file
@ -0,0 +1 @@
|
|||||||
|
fixtures
|
||||||
14
.swcrc
14
.swcrc
@ -3,21 +3,11 @@
|
|||||||
"jsc": {
|
"jsc": {
|
||||||
"parser": {
|
"parser": {
|
||||||
"syntax": "typescript",
|
"syntax": "typescript",
|
||||||
"decorators": true,
|
|
||||||
"dynamicImport": true
|
"dynamicImport": true
|
||||||
},
|
},
|
||||||
"transform": {
|
"target": "es2022"
|
||||||
"legacyDecorator": true,
|
|
||||||
"decoratorMetadata": true
|
|
||||||
},
|
|
||||||
"target": "es2022",
|
|
||||||
"loose": true
|
|
||||||
},
|
},
|
||||||
"module": {
|
"module": {
|
||||||
"type": "es6",
|
"type": "es6"
|
||||||
"strict": false,
|
|
||||||
"strictMode": true,
|
|
||||||
"lazy": false,
|
|
||||||
"noInterop": false
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="UTF-8" />
|
<meta charset="UTF-8" />
|
||||||
|
|||||||
@ -1,4 +1,4 @@
|
|||||||
<!DOCTYPE html>
|
<!doctype html>
|
||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="UTF-8" />
|
<meta charset="UTF-8" />
|
||||||
|
|||||||
42
example/package-lock.json
generated
42
example/package-lock.json
generated
@ -20,7 +20,7 @@
|
|||||||
"clipanion": "3.2.1",
|
"clipanion": "3.2.1",
|
||||||
"html-validator": "6.0.1",
|
"html-validator": "6.0.1",
|
||||||
"log-symbols": "5.1.0",
|
"log-symbols": "5.1.0",
|
||||||
"ora": "6.3.1",
|
"ora": "7.0.1",
|
||||||
"read-pkg": "8.0.0",
|
"read-pkg": "8.0.0",
|
||||||
"table": "6.8.1"
|
"table": "6.8.1"
|
||||||
},
|
},
|
||||||
@ -28,34 +28,36 @@
|
|||||||
"html-w3c-validator": "build/index.js"
|
"html-w3c-validator": "build/index.js"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "17.6.6",
|
"@commitlint/cli": "17.7.0",
|
||||||
"@commitlint/config-conventional": "17.6.6",
|
"@commitlint/config-conventional": "17.7.0",
|
||||||
"@swc/cli": "0.1.62",
|
"@swc/cli": "0.1.62",
|
||||||
"@swc/core": "1.3.67",
|
"@swc/core": "1.3.75",
|
||||||
"@tsconfig/strictest": "2.0.1",
|
"@tsconfig/strictest": "2.0.1",
|
||||||
"@types/html-validator": "5.0.3",
|
"@types/html-validator": "5.0.3",
|
||||||
"@types/mock-fs": "4.13.1",
|
"@types/mock-fs": "4.13.1",
|
||||||
"@types/node": "20.3.3",
|
"@types/node": "20.4.9",
|
||||||
"@types/tap": "15.0.8",
|
"@types/sinon": "10.0.16",
|
||||||
"@typescript-eslint/eslint-plugin": "5.60.1",
|
"@typescript-eslint/eslint-plugin": "6.3.0",
|
||||||
|
"@typescript-eslint/parser": "6.3.0",
|
||||||
"editorconfig-checker": "5.1.1",
|
"editorconfig-checker": "5.1.1",
|
||||||
"eslint": "8.44.0",
|
"eslint": "8.46.0",
|
||||||
"eslint-config-conventions": "9.0.0",
|
"eslint-config-conventions": "11.0.1",
|
||||||
"eslint-config-prettier": "8.8.0",
|
"eslint-config-prettier": "9.0.0",
|
||||||
"eslint-plugin-import": "2.27.5",
|
"eslint-plugin-import": "2.28.0",
|
||||||
"eslint-plugin-prettier": "4.2.1",
|
"eslint-plugin-prettier": "5.0.0",
|
||||||
"eslint-plugin-promise": "6.1.1",
|
"eslint-plugin-promise": "6.1.1",
|
||||||
"eslint-plugin-unicorn": "47.0.0",
|
"eslint-plugin-unicorn": "48.0.1",
|
||||||
"execa": "7.1.1",
|
"execa": "7.2.0",
|
||||||
"lint-staged": "13.2.3",
|
"lint-staged": "13.2.3",
|
||||||
"markdownlint-cli2": "0.8.1",
|
"markdownlint-cli2": "0.8.1",
|
||||||
"markdownlint-rule-relative-links": "2.1.0",
|
"markdownlint-rule-relative-links": "2.1.0",
|
||||||
"mock-fs": "5.2.0",
|
"mock-fs": "5.2.0",
|
||||||
"prettier": "2.8.8",
|
"prettier": "3.0.1",
|
||||||
"rimraf": "5.0.1",
|
"rimraf": "5.0.1",
|
||||||
"semantic-release": "21.0.6",
|
"semantic-release": "21.0.7",
|
||||||
"serve": "14.2.0",
|
"serve": "14.2.0",
|
||||||
"typescript": "5.0.4"
|
"sinon": "15.2.0",
|
||||||
|
"typescript": "5.1.6"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16.0.0",
|
"node": ">=16.0.0",
|
||||||
@ -1238,9 +1240,9 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/tslib": {
|
"node_modules/tslib": {
|
||||||
"version": "2.6.0",
|
"version": "2.6.1",
|
||||||
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.0.tgz",
|
"resolved": "https://registry.npmjs.org/tslib/-/tslib-2.6.1.tgz",
|
||||||
"integrity": "sha512-7At1WUettjcSRHXCyYtTselblcHl9PJFFVKiCAy/bY97+BPZXSQ2wbq0P9s8tK2G7dFQfNnlJnPAiArVBVBsfA==",
|
"integrity": "sha512-t0hLfiEKfMUoqhG+U1oid7Pva4bbDPHYfJNiB7BiIjRkj1pyC++4N3huJfqY6aRH6VTB0rvtzQwjM4K6qpfOig==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/type-fest": {
|
"node_modules/type-fest": {
|
||||||
|
|||||||
2226
package-lock.json
generated
2226
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
40
package.json
40
package.json
@ -42,8 +42,8 @@
|
|||||||
"lint:commit": "commitlint",
|
"lint:commit": "commitlint",
|
||||||
"lint:editorconfig": "editorconfig-checker",
|
"lint:editorconfig": "editorconfig-checker",
|
||||||
"lint:markdown": "markdownlint-cli2",
|
"lint:markdown": "markdownlint-cli2",
|
||||||
"lint:eslint": "eslint . --ignore-path .gitignore",
|
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
|
||||||
"lint:prettier": "prettier . --check --ignore-path .gitignore",
|
"lint:prettier": "prettier . --check",
|
||||||
"lint:staged": "lint-staged",
|
"lint:staged": "lint-staged",
|
||||||
"test": "node --enable-source-maps --test build/",
|
"test": "node --enable-source-maps --test build/",
|
||||||
"release": "semantic-release"
|
"release": "semantic-release"
|
||||||
@ -53,38 +53,40 @@
|
|||||||
"clipanion": "3.2.1",
|
"clipanion": "3.2.1",
|
||||||
"html-validator": "6.0.1",
|
"html-validator": "6.0.1",
|
||||||
"log-symbols": "5.1.0",
|
"log-symbols": "5.1.0",
|
||||||
"ora": "6.3.1",
|
"ora": "7.0.1",
|
||||||
"read-pkg": "8.0.0",
|
"read-pkg": "8.0.0",
|
||||||
"table": "6.8.1"
|
"table": "6.8.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "17.6.6",
|
"@commitlint/cli": "17.7.0",
|
||||||
"@commitlint/config-conventional": "17.6.6",
|
"@commitlint/config-conventional": "17.7.0",
|
||||||
"@swc/cli": "0.1.62",
|
"@swc/cli": "0.1.62",
|
||||||
"@swc/core": "1.3.67",
|
"@swc/core": "1.3.75",
|
||||||
"@tsconfig/strictest": "2.0.1",
|
"@tsconfig/strictest": "2.0.1",
|
||||||
"@types/html-validator": "5.0.3",
|
"@types/html-validator": "5.0.3",
|
||||||
"@types/mock-fs": "4.13.1",
|
"@types/mock-fs": "4.13.1",
|
||||||
"@types/node": "20.3.3",
|
"@types/node": "20.4.9",
|
||||||
"@types/tap": "15.0.8",
|
"@types/sinon": "10.0.16",
|
||||||
"@typescript-eslint/eslint-plugin": "5.60.1",
|
"@typescript-eslint/eslint-plugin": "6.3.0",
|
||||||
|
"@typescript-eslint/parser": "6.3.0",
|
||||||
"editorconfig-checker": "5.1.1",
|
"editorconfig-checker": "5.1.1",
|
||||||
"eslint": "8.44.0",
|
"eslint": "8.46.0",
|
||||||
"eslint-config-conventions": "9.0.0",
|
"eslint-config-conventions": "11.0.1",
|
||||||
"eslint-config-prettier": "8.8.0",
|
"eslint-config-prettier": "9.0.0",
|
||||||
"eslint-plugin-import": "2.27.5",
|
"eslint-plugin-import": "2.28.0",
|
||||||
"eslint-plugin-prettier": "4.2.1",
|
"eslint-plugin-prettier": "5.0.0",
|
||||||
"eslint-plugin-promise": "6.1.1",
|
"eslint-plugin-promise": "6.1.1",
|
||||||
"eslint-plugin-unicorn": "47.0.0",
|
"eslint-plugin-unicorn": "48.0.1",
|
||||||
"execa": "7.1.1",
|
"execa": "7.2.0",
|
||||||
"lint-staged": "13.2.3",
|
"lint-staged": "13.2.3",
|
||||||
"markdownlint-cli2": "0.8.1",
|
"markdownlint-cli2": "0.8.1",
|
||||||
"markdownlint-rule-relative-links": "2.1.0",
|
"markdownlint-rule-relative-links": "2.1.0",
|
||||||
"mock-fs": "5.2.0",
|
"mock-fs": "5.2.0",
|
||||||
"prettier": "2.8.8",
|
"prettier": "3.0.1",
|
||||||
"rimraf": "5.0.1",
|
"rimraf": "5.0.1",
|
||||||
"semantic-release": "21.0.6",
|
"semantic-release": "21.0.7",
|
||||||
"serve": "14.2.0",
|
"serve": "14.2.0",
|
||||||
"typescript": "5.0.4"
|
"sinon": "15.2.0",
|
||||||
|
"typescript": "5.1.6"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,7 +1,8 @@
|
|||||||
import path from 'node:path'
|
import path from 'node:path'
|
||||||
import fs from 'node:fs'
|
import fs from 'node:fs'
|
||||||
|
|
||||||
import { Command } from 'clipanion'
|
import { Command, Option } from 'clipanion'
|
||||||
|
import * as typanion from 'typanion'
|
||||||
import chalk from 'chalk'
|
import chalk from 'chalk'
|
||||||
import ora from 'ora'
|
import ora from 'ora'
|
||||||
import logSymbols from 'log-symbols'
|
import logSymbols from 'log-symbols'
|
||||||
@ -14,12 +15,11 @@ import { table } from 'table'
|
|||||||
|
|
||||||
import { isExistingPath } from './utils/isExistingPath.js'
|
import { isExistingPath } from './utils/isExistingPath.js'
|
||||||
|
|
||||||
const CURRENT_DIRECTORY = process.cwd()
|
export const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
|
||||||
const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
|
|
||||||
|
|
||||||
const severities = ['error', 'warning', 'info'] as const
|
export const SEVERITIES = ['error', 'warning', 'info'] as const
|
||||||
|
|
||||||
export type Severity = (typeof severities)[number]
|
export type Severity = (typeof SEVERITIES)[number]
|
||||||
|
|
||||||
interface Config {
|
interface Config {
|
||||||
urls?: string[]
|
urls?: string[]
|
||||||
@ -53,8 +53,17 @@ export class HTMLValidatorCommand extends Command {
|
|||||||
'CLI for validating multiple html pages using <https://validator.w3.org/>.'
|
'CLI for validating multiple html pages using <https://validator.w3.org/>.'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public currentWorkingDirectory = Option.String(
|
||||||
|
'--current-working-directory',
|
||||||
|
process.cwd(),
|
||||||
|
{
|
||||||
|
description: 'The current working directory.',
|
||||||
|
validator: typanion.isString()
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
public async execute(): Promise<number> {
|
public async execute(): Promise<number> {
|
||||||
const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME)
|
const configPath = path.join(this.currentWorkingDirectory, CONFIG_FILE_NAME)
|
||||||
try {
|
try {
|
||||||
if (!(await isExistingPath(configPath))) {
|
if (!(await isExistingPath(configPath))) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
@ -104,22 +113,19 @@ export class HTMLValidatorCommand extends Command {
|
|||||||
`Invalid config file at "${configPath}". Please add URLs or files.`
|
`Invalid config file at "${configPath}". Please add URLs or files.`
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
const configSeverities: Severity[] = config.severities ?? [
|
const severities: Severity[] = config.severities ?? ['warning', 'error']
|
||||||
'warning',
|
for (const severity of severities) {
|
||||||
'error'
|
if (!SEVERITIES.includes(severity)) {
|
||||||
]
|
|
||||||
for (const severity of configSeverities) {
|
|
||||||
if (!severities.includes(severity)) {
|
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`Invalid config file at "${configPath}". Please add valid severities (${severities.join(
|
`Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
|
||||||
', '
|
', '
|
||||||
)}).`
|
)}).`
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (configSeverities.length === 0) {
|
if (severities.length === 0) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`Invalid config file at "${configPath}". Please add valid severities (${severities.join(
|
`Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join(
|
||||||
', '
|
', '
|
||||||
)}).`
|
)}).`
|
||||||
)
|
)
|
||||||
@ -142,7 +148,7 @@ export class HTMLValidatorCommand extends Command {
|
|||||||
...options
|
...options
|
||||||
})
|
})
|
||||||
} else if (type === 'file') {
|
} else if (type === 'file') {
|
||||||
const htmlPath = path.resolve(CURRENT_DIRECTORY, data)
|
const htmlPath = path.resolve(this.currentWorkingDirectory, data)
|
||||||
if (!(await isExistingPath(htmlPath))) {
|
if (!(await isExistingPath(htmlPath))) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`No file found at "${htmlPath}". Please check the path.`
|
`No file found at "${htmlPath}". Please check the path.`
|
||||||
@ -160,8 +166,8 @@ export class HTMLValidatorCommand extends Command {
|
|||||||
}
|
}
|
||||||
const hasErrors = result.messages.some((message) => {
|
const hasErrors = result.messages.some((message) => {
|
||||||
return (
|
return (
|
||||||
configSeverities.includes(message.type as Severity) ||
|
severities.includes(message.type as Severity) ||
|
||||||
configSeverities.includes(message.subType as Severity)
|
severities.includes(message.subType as Severity)
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
if (!hasErrors) {
|
if (!hasErrors) {
|
||||||
@ -170,6 +176,13 @@ export class HTMLValidatorCommand extends Command {
|
|||||||
results.push({ data, isSuccess: false })
|
results.push({ data, isSuccess: false })
|
||||||
const messagesTable: string[][] = []
|
const messagesTable: string[][] = []
|
||||||
for (const message of result.messages) {
|
for (const message of result.messages) {
|
||||||
|
if (
|
||||||
|
!severities.includes(message.type as Severity) &&
|
||||||
|
!severities.includes(message.subType as Severity)
|
||||||
|
) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
const row: string[] = []
|
const row: string[] = []
|
||||||
if (message.type === 'info') {
|
if (message.type === 'info') {
|
||||||
if (message.subType === 'warning') {
|
if (message.subType === 'warning') {
|
||||||
|
|||||||
@ -1,23 +1,416 @@
|
|||||||
import test from 'node:test'
|
import test from 'node:test'
|
||||||
import assert from 'node:assert/strict'
|
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 { execa } from 'execa'
|
||||||
|
import { table } from 'table'
|
||||||
|
import chalk from 'chalk'
|
||||||
|
import logSymbols from 'log-symbols'
|
||||||
|
|
||||||
import { cli } from '../cli.js'
|
import { cli } from '../cli.js'
|
||||||
import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js'
|
import {
|
||||||
|
HTMLValidatorCommand,
|
||||||
|
CONFIG_FILE_NAME,
|
||||||
|
SEVERITIES
|
||||||
|
} from '../HTMLValidatorCommand.js'
|
||||||
|
|
||||||
|
const FIXTURES_PATH = path.join(process.cwd(), 'src', '__test__', 'fixtures')
|
||||||
|
|
||||||
await test('html-w3c-validator', async (t) => {
|
await test('html-w3c-validator', async (t) => {
|
||||||
|
t.afterEach(() => {
|
||||||
|
sinon.restore()
|
||||||
|
})
|
||||||
|
|
||||||
await t.test('should be instance of the command', async () => {
|
await t.test('should be instance of the command', async () => {
|
||||||
const command = cli.process([])
|
const command = cli.process([])
|
||||||
assert(command instanceof HTMLValidatorCommand)
|
assert(command instanceof HTMLValidatorCommand)
|
||||||
})
|
})
|
||||||
|
|
||||||
await t.test('succeeds and validate the html correctly', async () => {
|
await t.test(
|
||||||
const exampleURL = new URL('../../example', import.meta.url)
|
'succeeds and validate the html correctly (example)',
|
||||||
process.chdir(exampleURL.pathname)
|
async () => {
|
||||||
await execa('rimraf', ['node_modules'])
|
const exampleURL = new URL('../../example', import.meta.url)
|
||||||
await execa('npm', ['install'])
|
process.chdir(exampleURL.pathname)
|
||||||
const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator'])
|
await execa('rimraf', ['node_modules'])
|
||||||
assert.strictEqual(exitCode, 0)
|
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')
|
||||||
|
)
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"urls": [],
|
||||||
|
"files": []
|
||||||
|
}
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"files": "Invalid"
|
||||||
|
}
|
||||||
@ -0,0 +1 @@
|
|||||||
|
Invalid JSON
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"files": ["./index.html"],
|
||||||
|
"severities": []
|
||||||
|
}
|
||||||
@ -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>
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"files": ["./index.html"],
|
||||||
|
"severities": ["errors-invalid"]
|
||||||
|
}
|
||||||
@ -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>
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"urls": "Invalid"
|
||||||
|
}
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"files": ["./index.html"]
|
||||||
|
}
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"files": ["./build/index.html", "./build/about.html"]
|
||||||
|
}
|
||||||
@ -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>
|
||||||
@ -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>
|
||||||
3
src/__test__/fixtures/success/.html-w3c-validatorrc.json
Normal file
3
src/__test__/fixtures/success/.html-w3c-validatorrc.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"files": ["./build/index.html", "./build/about.html"]
|
||||||
|
}
|
||||||
9
src/__test__/fixtures/success/build/about.html
Normal file
9
src/__test__/fixtures/success/build/about.html
Normal 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>
|
||||||
9
src/__test__/fixtures/success/build/index.html
Normal file
9
src/__test__/fixtures/success/build/index.html
Normal 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>
|
||||||
Reference in New Issue
Block a user