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

6 Commits

Author SHA1 Message Date
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
e762c0fad5 feat: usage of ESM modules imports (instead of CommonJS) 2022-04-06 19:59:31 +02:00
e032bbe637 feat: support plain HTML files (not served)
fixes #2
2022-02-24 11:55:32 +01:00
d92235d79d chore: maintenance 2022-02-19 16:55:36 +01:00
36 changed files with 8568 additions and 47565 deletions

View File

@ -1,2 +0,0 @@
ARG VARIANT="16"
FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}

View File

@ -1,15 +0,0 @@
{
"name": "html-w3c-validator",
"dockerComposeFile": "./docker-compose.yml",
"service": "workspace",
"workspaceFolder": "/workspace",
"extensions": [
"editorconfig.editorconfig",
"esbenp.prettier-vscode",
"dbaeumer.vscode-eslint",
"davidanson.vscode-markdownlint",
"ms-azuretools.vscode-docker"
],
"postAttachCommand": ["npm", "install"],
"remoteUser": "node"
}

View File

@ -1,10 +0,0 @@
version: '3.0'
services:
workspace:
build:
context: './'
dockerfile: './Dockerfile'
volumes:
- '..:/workspace:cached'
command: 'sleep infinity'

View File

@ -1,5 +0,0 @@
build
node_modules
coverage
package.json
package-lock.json

View File

@ -1,21 +1,16 @@
{ {
"extends": ["standard-with-typescript", "prettier"], "extends": ["conventions", "prettier"],
"plugins": ["unicorn", "import", "prettier"], "plugins": ["prettier", "import", "unicorn"],
"parserOptions": { "parserOptions": {
"project": "./tsconfig.json" "project": "./tsconfig.json"
}, },
"env": { "env": {
"node": true, "node": true
"jest": true
}, },
"rules": { "rules": {
"prettier/prettier": "error", "prettier/prettier": "error",
"import/order": [
"error",
{ "groups": ["builtin", "external", "internal"] }
],
"import/extensions": ["error", "always"], "import/extensions": ["error", "always"],
"unicorn/prefer-node-protocol": "error", "unicorn/prevent-abbreviations": "error",
"unicorn/prevent-abbreviations": "error" "unicorn/prefer-node-protocol": "error"
} }
} }

1
.gitattributes vendored Normal file
View File

@ -0,0 +1 @@
* text=auto eol=lf

View File

@ -2,7 +2,7 @@ name: 'Build'
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
@ -10,12 +10,12 @@ jobs:
build: build:
runs-on: 'ubuntu-latest' runs-on: 'ubuntu-latest'
steps: steps:
- uses: 'actions/checkout@v2' - uses: 'actions/checkout@v3.3.0'
- name: 'Use Node.js' - name: 'Use Node.js'
uses: 'actions/setup-node@v2.5.1' uses: 'actions/setup-node@v3.6.0'
with: with:
node-version: '16.x' node-version: 'lts/*'
cache: 'npm' cache: 'npm'
- name: 'Install' - name: 'Install'
@ -23,3 +23,5 @@ jobs:
- name: 'Build' - name: 'Build'
run: 'npm run build' run: 'npm run build'
- run: 'npm run build:typescript'

View File

@ -2,7 +2,7 @@ name: 'Lint'
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
@ -10,28 +10,19 @@ jobs:
lint: lint:
runs-on: 'ubuntu-latest' runs-on: 'ubuntu-latest'
steps: steps:
- uses: 'actions/checkout@v2' - uses: 'actions/checkout@v3.3.0'
- name: 'Use Node.js' - name: 'Use Node.js'
uses: 'actions/setup-node@v2.5.1' uses: 'actions/setup-node@v3.6.0'
with: with:
node-version: '16.x' node-version: 'lts/*'
cache: 'npm' cache: 'npm'
- name: 'Install' - name: 'Install'
run: 'npm install' run: 'npm install'
- name: 'lint:commit' - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
run: 'npm run lint:commit -- --to "${{ github.sha }}"' - run: 'npm run lint:editorconfig'
- run: 'npm run lint:markdown'
- name: 'lint:editorconfig' - run: 'npm run lint:eslint'
run: 'npm run lint:editorconfig' - run: 'npm run lint:prettier'
- name: 'lint:markdown'
run: 'npm run lint:markdown'
- name: 'lint:typescript'
run: 'npm run lint:typescript'
- name: 'lint:prettier'
run: 'npm run lint:prettier'

View File

@ -8,15 +8,15 @@ jobs:
release: release:
runs-on: 'ubuntu-latest' runs-on: 'ubuntu-latest'
steps: steps:
- uses: 'actions/checkout@v2.3.4' - uses: 'actions/checkout@v3.3.0'
with: with:
fetch-depth: 0 fetch-depth: 0
persist-credentials: false persist-credentials: false
- name: 'Use Node.js' - name: 'Use Node.js'
uses: 'actions/setup-node@v2.5.1' uses: 'actions/setup-node@v3.6.0'
with: with:
node-version: '16.x' node-version: 'lts/*'
cache: 'npm' cache: 'npm'
- name: 'Install' - name: 'Install'
@ -25,6 +25,8 @@ jobs:
- name: 'Build' - name: 'Build'
run: 'npm run build' run: 'npm run build'
- run: 'npm run build:typescript'
- name: 'Release' - name: 'Release'
run: 'npm run release' run: 'npm run release'
env: env:

View File

@ -2,7 +2,7 @@ name: 'Test'
on: on:
push: push:
branches: [master, develop] branches: [develop]
pull_request: pull_request:
branches: [master, develop] branches: [master, develop]
@ -10,12 +10,12 @@ jobs:
test: test:
runs-on: 'ubuntu-latest' runs-on: 'ubuntu-latest'
steps: steps:
- uses: 'actions/checkout@v2' - uses: 'actions/checkout@v3.3.0'
- name: 'Use Node.js' - name: 'Use Node.js'
uses: 'actions/setup-node@v2.5.1' uses: 'actions/setup-node@v3.6.0'
with: with:
node-version: '16.x' node-version: 'lts/*'
cache: 'npm' cache: 'npm'
- name: 'Install' - name: 'Install'

1
.gitignore vendored
View File

@ -8,6 +8,7 @@ node_modules
# testing # testing
coverage coverage
.nyc_output
# envs # envs
.env .env

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

View File

@ -1,10 +1,6 @@
{ {
"*": ["editorconfig-checker"], "*": ["editorconfig-checker"],
"*.{js,ts,jsx,tsx}": [ "*.{js,ts,jsx,tsx}": ["prettier --write", "eslint --fix"],
"prettier --write",
"eslint --fix",
"jest --findRelatedTests"
],
"*.{yml,json}": ["prettier --write"], "*.{yml,json}": ["prettier --write"],
"*.{md}": ["prettier --write", "markdownlint --dot --fix"] "*.md": ["prettier --write", "markdownlint --dot --fix"]
} }

5
.markdownlint-cli2.jsonc Normal file
View File

@ -0,0 +1,5 @@
{
"globs": ["**/*.{md,mdx}"],
"ignores": ["**/node_modules"],
"customRules": ["markdownlint-rule-relative-links"]
}

View File

@ -1,6 +1,7 @@
{ {
"default": true, "default": true,
"MD013": false, "relative-links": true,
"extends": "markdownlint/style/prettier",
"MD033": false, "MD033": false,
"MD041": false "MD041": false
} }

1
.npmrc
View File

@ -1,2 +1 @@
save-exact=true save-exact=true
engine-strict=true

View File

@ -1,5 +0,0 @@
/build
node_modules
coverage
package.json
package-lock.json

2
.swcrc
View File

@ -13,7 +13,7 @@
"loose": true "loose": true
}, },
"module": { "module": {
"type": "commonjs", "type": "es6",
"strict": false, "strict": false,
"strictMode": true, "strictMode": true,
"lazy": false, "lazy": false,

9
.taprc Normal file
View File

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

27
.vscode/settings.json vendored
View File

@ -1,33 +1,14 @@
{ {
"typescript.tsdk": "node_modules/typescript/lib", "typescript.tsdk": "node_modules/typescript/lib",
"typescript.preferences.importModuleSpecifierEnding": "js", "typescript.preferences.importModuleSpecifierEnding": "js",
"editor.defaultFormatter": "esbenp.prettier-vscode",
"prettier.configPath": ".prettierrc.json", "prettier.configPath": ".prettierrc.json",
"editor.formatOnSave": true, "editor.formatOnSave": true,
"editor.codeActionsOnSave": { "editor.codeActionsOnSave": {
"source.fixAll": true "source.fixAll": true
}, },
"[markdown]": { "eslint.options": {
"editor.autoClosingBrackets": "always", "ignorePath": ".gitignore"
"editor.defaultFormatter": "esbenp.prettier-vscode"
}, },
"[yaml]": { "prettier.ignorePath": ".gitignore"
"editor.autoClosingBrackets": "always",
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.autoClosingBrackets": "always",
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[jsonc]": {
"editor.autoClosingBrackets": "always",
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescript]": {
"editor.autoClosingBrackets": "always",
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.autoClosingBrackets": "always",
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
} }

View File

@ -24,7 +24,7 @@
**html-w3c-validator** is a CLI tool to validate multiple html pages using [validator.w3.org](https://validator.w3.org/). **html-w3c-validator** is a CLI tool to validate multiple html pages using [validator.w3.org](https://validator.w3.org/).
You might use a JavaScript framework or simply use HTML: **you should validate your production HTML** and this validation should be part of your CI/CD pipeline (tests, linting, etc.). You might use a JavaScript framework or simply use HTML but **you should always validate your production HTML** and this validation should be part of your CI/CD pipeline (tests, linting, etc.).
### Why should I validate my HTML pages? ### Why should I validate my HTML pages?
@ -56,19 +56,22 @@ npm install --save-dev html-w3c-validator start-server-and-test
{ {
"scripts": { "scripts": {
// Command to start the server serving your HTML pages (e.g: using vercel/serve) // Command to start the server serving your HTML pages (e.g: using vercel/serve)
"start": "serve ./build", "start": "serve \"./build\"",
// Command to validate your HTML pages // 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\""
} }
} }
``` ```
### `.html-w3c-validatorrc.json` ### `.html-w3c-validatorrc.json`
```json ```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"]
} }
``` ```
@ -81,8 +84,8 @@ npm run test:html-w3c-validator
Example of output (in case of success): Example of output (in case of success):
```txt ```txt
✔ Validating http://localhost:3000/ ✔ Validating http://127.0.0.1:3000/
✔ Validating http://localhost:3000/about ✔ Validating http://127.0.0.1:3000/about
Success: HTML validation (W3C) passed! 🎉 Success: HTML validation (W3C) passed! 🎉
``` ```

View File

@ -1,3 +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"]
} }

27765
example/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -2,12 +2,12 @@
"name": "example", "name": "example",
"private": true, "private": true,
"scripts": { "scripts": {
"start": "serve ./build", "start": "serve \"./build\"",
"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\""
}, },
"devDependencies": { "devDependencies": {
"serve": "13.0.2", "serve": "14.1.2",
"start-server-and-test": "1.14.0", "start-server-and-test": "1.15.2",
"html-w3c-validator": "file:.." "html-w3c-validator": "file:.."
} }
} }

View File

@ -1,9 +0,0 @@
{
"testEnvironment": "node",
"resolver": "jest-ts-webcompat-resolver",
"transform": {
"^.+\\.(t|j)sx?$": ["@swc/jest"]
},
"rootDir": "./src",
"setupFiles": ["<rootDir>/__test__/setup.ts"]
}

27844
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,7 +1,9 @@
{ {
"name": "html-w3c-validator", "name": "html-w3c-validator",
"version": "0.0.0-development", "version": "0.0.0-development",
"public": true,
"description": "CLI for validating multiple html pages using validator.w3.org.", "description": "CLI for validating multiple html pages using validator.w3.org.",
"type": "module",
"author": "Divlo <contact@divlo.fr>", "author": "Divlo <contact@divlo.fr>",
"license": "MIT", "license": "MIT",
"repository": { "repository": {
@ -28,60 +30,55 @@
"build" "build"
], ],
"scripts": { "scripts": {
"build": "rimraf ./build && swc ./src --out-dir ./build && tsc", "build": "rimraf ./build && swc ./src --out-dir ./build",
"build:typescript": "tsc",
"lint:commit": "commitlint", "lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint '**/*.md' --dot --ignore node_modules", "lint:markdown": "markdownlint-cli2",
"lint:typescript": "eslint '**/*.{js,ts,jsx,tsx}'", "lint:eslint": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
"lint:prettier": "prettier '.' --check", "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
"lint:staged": "lint-staged", "lint:staged": "lint-staged",
"test": "jest", "test": "tap",
"release": "semantic-release", "release": "semantic-release"
"postinstall": "husky install",
"prepublishOnly": "pinst --disable",
"postpublish": "pinst --enable"
}, },
"dependencies": { "dependencies": {
"chalk": "4.1.2", "chalk": "5.2.0",
"clipanion": "3.1.0", "clipanion": "3.1.0",
"html-validator": "6.0.0", "html-validator": "6.0.1",
"ora": "5.4.1", "log-symbols": "5.1.0",
"read-pkg": "5.2.0", "ora": "6.1.2",
"table": "6.8.0" "read-pkg": "7.1.0",
"table": "6.8.1"
}, },
"devDependencies": { "devDependencies": {
"@commitlint/cli": "16.0.1", "@commitlint/cli": "17.4.1",
"@commitlint/config-conventional": "16.0.0", "@commitlint/config-conventional": "17.4.0",
"@swc/cli": "0.1.55", "@swc/cli": "0.1.57",
"@swc/core": "1.2.127", "@swc/core": "1.3.25",
"@swc/jest": "0.2.15", "@tsconfig/strictest": "1.0.2",
"@types/html-validator": "5.0.2", "@types/html-validator": "5.0.3",
"@types/jest": "27.4.0",
"@types/mock-fs": "4.13.1", "@types/mock-fs": "4.13.1",
"@types/node": "17.0.8", "@types/node": "18.11.18",
"@types/tap": "15.0.7",
"@typescript-eslint/eslint-plugin": "5.48.1",
"editorconfig-checker": "4.0.2", "editorconfig-checker": "4.0.2",
"eslint": "7.32.0", "eslint": "8.31.0",
"eslint-config-prettier": "8.3.0", "eslint-config-conventions": "6.0.0",
"eslint-config-standard-with-typescript": "21.0.1", "eslint-config-prettier": "8.6.0",
"eslint-plugin-import": "2.25.4", "eslint-plugin-import": "2.26.0",
"eslint-plugin-node": "11.1.0", "eslint-plugin-prettier": "4.2.1",
"eslint-plugin-prettier": "4.0.0", "eslint-plugin-promise": "6.1.1",
"eslint-plugin-promise": "5.1.1", "eslint-plugin-unicorn": "45.0.2",
"eslint-plugin-unicorn": "40.0.0", "execa": "6.1.0",
"execa": "5.1.1", "lint-staged": "13.1.0",
"husky": "7.0.4", "markdownlint-cli2": "0.6.0",
"jest": "27.4.7", "markdownlint-rule-relative-links": "1.1.1",
"jest-mock-extended": "2.0.4", "mock-fs": "5.2.0",
"jest-ts-webcompat-resolver": "1.0.0", "prettier": "2.8.2",
"lint-staged": "12.1.5",
"markdownlint-cli": "0.30.0",
"mock-fs": "5.1.2",
"npm": "8.3.0",
"pinst": "2.1.6",
"prettier": "2.5.1",
"rimraf": "3.0.2", "rimraf": "3.0.2",
"semantic-release": "18.0.1", "semantic-release": "20.0.2",
"serve": "13.0.2", "serve": "14.1.2",
"typescript": "4.5.4" "tap": "16.3.3",
"typescript": "4.9.4"
} }
} }

View File

@ -4,7 +4,12 @@ import fs from 'node:fs'
import { Command } from 'clipanion' import { Command } from 'clipanion'
import chalk from 'chalk' import chalk from 'chalk'
import ora from 'ora' import ora from 'ora'
import validateHTML, { ValidationMessageLocationObject } from 'html-validator' import logSymbols from 'log-symbols'
import type {
ValidationMessageLocationObject,
ParsedJsonAsValidationResults
} from 'html-validator'
import validateHTML from 'html-validator'
import { table } from 'table' import { table } from 'table'
import { isExistingPath } from './utils/isExistingPath.js' import { isExistingPath } from './utils/isExistingPath.js'
@ -13,21 +18,37 @@ const CURRENT_DIRECTORY = process.cwd()
const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json' const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
interface Config { interface Config {
urls: string[] urls?: string[]
files?: string[]
} }
interface Error { interface Error {
url: string data: string
messagesTable: string[][] 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 { export class HTMLValidatorCommand extends Command {
static usage = { static override usage = {
description: description:
'CLI for validating multiple html pages using <https://validator.w3.org/>.' 'CLI for validating multiple html pages using <https://validator.w3.org/>.'
} }
async execute(): Promise<number> { public async execute(): Promise<number> {
const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME) const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME)
try { try {
if (!(await isExistingPath(configPath))) { if (!(await isExistingPath(configPath))) {
@ -35,73 +56,120 @@ export class HTMLValidatorCommand extends Command {
`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, { const configData = await fs.promises.readFile(configPath, {
encoding: 'utf-8' encoding: 'utf-8'
}) })
let config: Config = { urls: [] } let config: Config = { urls: [], files: [] }
let isValidConfig = true let isValidConfig = true
try { try {
config = JSON.parse(configData) config = JSON.parse(configData)
} catch { } catch {
isValidConfig = false isValidConfig = false
} }
isValidConfig = isValidConfig && Array.isArray(config.urls) isValidConfig =
isValidConfig &&
(Array.isArray(config.urls) || Array.isArray(config.urls))
if (!isValidConfig) { if (!isValidConfig) {
throw new Error( throw new Error(
`Invalid config file at ${configPath}. Please check the syntax.` `Invalid config file at ${configPath}. Please check the syntax.`
) )
} }
const urls =
config.urls == null
? []
: config.urls.map((url) => {
return { type: 'url', data: url }
})
const files =
config.files == null
? []
: config.files.map((file) => {
return { type: 'file', data: file }
})
const dataToValidate = [...urls, ...files]
const errors: Error[] = [] const errors: Error[] = []
let isValid = true let isValid = true
for (const url of config.urls) { const loader = ora(`Validating HTML (W3C)...`).start()
const loader = ora(`Validating ${url}`).start() const results: Result[] = []
const result = await validateHTML({ await Promise.all(
url, dataToValidate.map(async ({ data, type }) => {
format: 'json', try {
isLocal: true const options = {
}) format: 'json' as 'json' | undefined
const isValidHTML = result.messages.length === 0 }
if (isValidHTML) { let result: ParsedJsonAsValidationResults | undefined
loader.succeed() if (type === 'url') {
} else { result = await validateHTML({
loader.fail() url: data,
const messagesTable: string[][] = [] isLocal: true,
for (const message of result.messages) { ...options
const row: string[] = [] })
if (message.type === 'error') { } else if (type === 'file') {
row.push(chalk.red(message.type)) 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 { } else {
row.push(chalk.yellow(message.type)) throw new Error('Invalid type')
} }
row.push(message.message) const hasErrors = result.messages.some((message) => {
const violation = message as ValidationMessageLocationObject return message.type === 'error'
if (violation.extract != null) { })
row.push( if (!hasErrors) {
`line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}` results.push({ data, isSuccess: true })
) } else {
results.push({ data, isSuccess: false })
const messagesTable: string[][] = []
for (const message of result.messages) {
if (message.type === 'error') {
const row: string[] = []
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 })
} }
messagesTable.push(row)
} }
errors.push({ url, messagesTable }) })
isValid = false )
}
}
if (!isValid) { if (!isValid) {
loader.fail()
printResults(results)
for (const error of errors) { for (const error of errors) {
console.error(`\n${error.url}`) console.error(`\n${error.data}`)
console.error(table(error.messagesTable)) console.error(table(error.messagesTable))
console.error('------------------------------') console.error('------------------------------')
} }
console.error() console.error()
throw new Error('HTML validation (W3C) failed!') throw new Error('HTML validation (W3C) failed!')
} }
console.log() loader.succeed(
console.log(
`${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉` `${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉`
) )
printResults(results)
return 0 return 0
} catch (error) { } catch (error) {
if (error instanceof Error) { if (error instanceof Error) {

View File

@ -1,26 +1,21 @@
import path from 'node:path' import tap from 'tap'
import { execa } from 'execa'
import execa from 'execa'
import { cli } from '../cli.js' import { cli } from '../cli.js'
import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js' import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js'
describe('html-w3c-validator', () => { await tap.test('html-w3c-validator', async (t) => {
afterEach(() => { await t.test('should be instance of the command', async (t) => {
jest.clearAllMocks()
})
it('should be instance of the command', async () => {
const command = cli.process([]) const command = cli.process([])
expect(command).toBeInstanceOf(HTMLValidatorCommand) t.equal(command instanceof HTMLValidatorCommand, true)
}) })
it('succeeds and validate the html correctly', async () => { await t.test('succeeds and validate the html correctly', async (t) => {
const examplePath = path.join(__dirname, '..', '..', 'example') const exampleURL = new URL('../../example', import.meta.url)
process.chdir(examplePath) process.chdir(exampleURL.pathname)
await execa('rimraf', ['node_modules']) await execa('rimraf', ['node_modules'])
await execa('npm', ['install']) await execa('npm', ['install'])
const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator']) const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator'])
expect(exitCode).toEqual(0) t.equal(exitCode, 0)
}) })
}) })

View File

@ -1 +0,0 @@
jest.setTimeout(60000)

View File

@ -1,11 +1,7 @@
import path from 'node:path'
import { Builtins, Cli } from 'clipanion' import { Builtins, Cli } from 'clipanion'
import readPackage from 'read-pkg'
import { HTMLValidatorCommand } from './HTMLValidatorCommand.js' import { HTMLValidatorCommand } from './HTMLValidatorCommand.js'
import { packageJSON } from './packageJSON.js'
const packageJSON = readPackage.sync({ cwd: path.join(__dirname, '..') })
export const cli = new Cli({ export const cli = new Cli({
binaryLabel: packageJSON.name, binaryLabel: packageJSON.name,

View File

@ -1,12 +1,8 @@
#!/usr/bin/env node #!/usr/bin/env node
import chalk from 'chalk'
import { Cli } from 'clipanion' import { Cli } from 'clipanion'
import { cli } from './cli.js' import { cli } from './cli.js'
const [, , ...arguments_] = process.argv const [, , ...arguments_] = process.argv
cli.runExit(arguments_, Cli.defaultContext).catch(() => { await cli.runExit(arguments_, Cli.defaultContext)
console.error(chalk.red('Error occurred...'))
process.exit(1)
})

5
src/packageJSON.ts Normal file
View File

@ -0,0 +1,5 @@
import { readPackage } from 'read-pkg'
export const packageJSON = await readPackage({
cwd: new URL('..', import.meta.url)
})

View File

@ -1,29 +1,24 @@
import fsMock from 'mock-fs' import fsMock from 'mock-fs'
import tap from 'tap'
import { isExistingPath } from '../isExistingPath.js' import { isExistingPath } from '../isExistingPath.js'
describe('utils/isExistingFile', () => { await tap.test('utils/isExistingPath', async (t) => {
afterEach(async () => { t.afterEach(() => {
fsMock.restore() fsMock.restore()
}) })
it('should return true if the file exists', async () => { await t.test('should return true if the file exists', async () => {
fsMock( fsMock({
{ '/file.txt': ''
'/file.txt': '' })
}, t.equal(await isExistingPath('/file.txt'), true)
{ createCwd: false }
)
expect(await isExistingPath('/file.txt')).toBeTruthy()
}) })
it("should return false if the file doesn't exists", async () => { await t.test("should return false if the file doesn't exists", async () => {
fsMock( fsMock({
{ '/file.txt': ''
'/file.txt': '' })
}, t.equal(await isExistingPath('/randomfile.txt'), false)
{ createCwd: false }
)
expect(await isExistingPath('/randomfile.txt')).toBeFalsy()
}) })
}) })

View File

@ -1,14 +1,13 @@
{ {
"extends": "@tsconfig/strictest/tsconfig.json",
"compilerOptions": { "compilerOptions": {
"target": "ESNext", "target": "ESNext",
"module": "commonjs", "module": "ESNext",
"lib": ["ESNext"], "lib": ["ESNext"],
"moduleResolution": "node", "moduleResolution": "node",
"outDir": "./build", "outDir": "./build",
"rootDir": "./src", "rootDir": "./src",
"noEmit": true, "noEmit": true,
"strict": true, "exactOptionalPropertyTypes": false
"skipLibCheck": true,
"esModuleInterop": true
} }
} }