mirror of
https://github.com/theoludwig/html-w3c-validator.git
synced 2025-05-21 23:21:29 +02:00
Compare commits
14 Commits
Author | SHA1 | Date | |
---|---|---|---|
c7bf82135b
|
|||
eb970f1823
|
|||
29203985e4
|
|||
a8841b24fd
|
|||
bda82b39a3
|
|||
f7a4edc46a
|
|||
67806866ee
|
|||
3d24ffe971 | |||
e818556c5b | |||
2cb7967bc7 | |||
943b3d1fd6 | |||
6ca7722fcf | |||
3a44eca5b1 | |||
e762c0fad5 |
@ -1,2 +0,0 @@
|
||||
ARG VARIANT="16"
|
||||
FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
|
@ -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"
|
||||
}
|
@ -1,10 +0,0 @@
|
||||
version: '3.0'
|
||||
|
||||
services:
|
||||
workspace:
|
||||
build:
|
||||
context: './'
|
||||
dockerfile: './Dockerfile'
|
||||
volumes:
|
||||
- '..:/workspace:cached'
|
||||
command: 'sleep infinity'
|
@ -5,12 +5,12 @@
|
||||
"project": "./tsconfig.json"
|
||||
},
|
||||
"env": {
|
||||
"node": true,
|
||||
"jest": true
|
||||
"node": true
|
||||
},
|
||||
"rules": {
|
||||
"prettier/prettier": "error",
|
||||
"import/extensions": ["error", "always"],
|
||||
"unicorn/prevent-abbreviations": "error"
|
||||
"unicorn/prevent-abbreviations": "error",
|
||||
"unicorn/prefer-node-protocol": "error"
|
||||
}
|
||||
}
|
||||
|
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -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
|
||||
|
||||
|
12
.github/workflows/build.yml
vendored
12
.github/workflows/build.yml
vendored
@ -10,16 +10,18 @@ jobs:
|
||||
build:
|
||||
runs-on: 'ubuntu-latest'
|
||||
steps:
|
||||
- uses: 'actions/checkout@v2'
|
||||
- uses: 'actions/checkout@v3.5.3'
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
- 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'
|
||||
|
12
.github/workflows/lint.yml
vendored
12
.github/workflows/lint.yml
vendored
@ -10,19 +10,19 @@ jobs:
|
||||
lint:
|
||||
runs-on: 'ubuntu-latest'
|
||||
steps:
|
||||
- uses: 'actions/checkout@v2'
|
||||
- uses: 'actions/checkout@v3.5.3'
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
- 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'
|
||||
|
20
.github/workflows/release.yml
vendored
20
.github/workflows/release.yml
vendored
@ -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@v2.3.4'
|
||||
- uses: 'actions/checkout@v3.5.3'
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
- 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:
|
||||
|
10
.github/workflows/test.yml
vendored
10
.github/workflows/test.yml
vendored
@ -10,16 +10,16 @@ jobs:
|
||||
test:
|
||||
runs-on: 'ubuntu-latest'
|
||||
steps:
|
||||
- uses: 'actions/checkout@v2'
|
||||
- uses: 'actions/checkout@v3.5.3'
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
- 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'
|
||||
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -8,6 +8,7 @@ node_modules
|
||||
|
||||
# testing
|
||||
coverage
|
||||
.nyc_output
|
||||
|
||||
# envs
|
||||
.env
|
||||
|
@ -1,4 +0,0 @@
|
||||
#!/bin/sh
|
||||
. "$(dirname "$0")/_/husky.sh"
|
||||
|
||||
npm run lint:commit -- --edit
|
@ -1,5 +0,0 @@
|
||||
#!/bin/sh
|
||||
. "$(dirname "$0")/_/husky.sh"
|
||||
|
||||
npm run lint:staged
|
||||
npm run build
|
@ -1,10 +1,6 @@
|
||||
{
|
||||
"*": ["editorconfig-checker"],
|
||||
"*.{js,ts,jsx,tsx}": [
|
||||
"prettier --write",
|
||||
"eslint --fix",
|
||||
"jest --findRelatedTests"
|
||||
],
|
||||
"*.{js,ts,jsx,tsx}": ["prettier --write", "eslint --fix"],
|
||||
"*.{yml,json}": ["prettier --write"],
|
||||
"*.md": ["prettier --write", "markdownlint --dot --fix"]
|
||||
}
|
||||
|
11
.markdownlint-cli2.jsonc
Normal file
11
.markdownlint-cli2.jsonc
Normal 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"]
|
||||
}
|
@ -1,6 +0,0 @@
|
||||
{
|
||||
"default": true,
|
||||
"MD013": false,
|
||||
"MD033": false,
|
||||
"MD041": false
|
||||
}
|
3
.swcrc
3
.swcrc
@ -1,4 +1,5 @@
|
||||
{
|
||||
"sourceMaps": true,
|
||||
"jsc": {
|
||||
"parser": {
|
||||
"syntax": "typescript",
|
||||
@ -13,7 +14,7 @@
|
||||
"loose": true
|
||||
},
|
||||
"module": {
|
||||
"type": "commonjs",
|
||||
"type": "es6",
|
||||
"strict": false,
|
||||
"strictMode": true,
|
||||
"lazy": false,
|
||||
|
3
.vscode/extensions.json
vendored
3
.vscode/extensions.json
vendored
@ -3,7 +3,6 @@
|
||||
"editorconfig.editorconfig",
|
||||
"esbenp.prettier-vscode",
|
||||
"dbaeumer.vscode-eslint",
|
||||
"davidanson.vscode-markdownlint",
|
||||
"ms-azuretools.vscode-docker"
|
||||
"davidanson.vscode-markdownlint"
|
||||
]
|
||||
}
|
||||
|
6
.vscode/settings.json
vendored
6
.vscode/settings.json
vendored
@ -6,5 +6,9 @@
|
||||
"editor.formatOnSave": true,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll": true
|
||||
}
|
||||
},
|
||||
"eslint.options": {
|
||||
"ignorePath": ".gitignore"
|
||||
},
|
||||
"prettier.ignorePath": ".gitignore"
|
||||
}
|
||||
|
@ -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
|
||||
|
@ -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.
|
||||
|
2
LICENSE
2
LICENSE
@ -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
|
||||
|
19
README.md
19
README.md
@ -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! 🎉
|
||||
```
|
||||
|
@ -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"]
|
||||
}
|
||||
|
23156
example/package-lock.json
generated
23156
example/package-lock.json
generated
File diff suppressed because it is too large
Load Diff
@ -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:.."
|
||||
}
|
||||
}
|
||||
|
@ -1,9 +0,0 @@
|
||||
{
|
||||
"testEnvironment": "node",
|
||||
"resolver": "jest-ts-webcompat-resolver",
|
||||
"transform": {
|
||||
"^.+\\.(t|j)sx?$": ["@swc/jest"]
|
||||
},
|
||||
"rootDir": "./src",
|
||||
"setupFiles": ["<rootDir>/__test__/setup.ts"]
|
||||
}
|
22832
package-lock.json
generated
22832
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
111
package.json
111
package.json
@ -3,16 +3,17 @@
|
||||
"version": "0.0.0-development",
|
||||
"public": true,
|
||||
"description": "CLI for validating multiple html pages using validator.w3.org.",
|
||||
"author": "Divlo <contact@divlo.fr>",
|
||||
"type": "module",
|
||||
"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",
|
||||
@ -21,67 +22,69 @@
|
||||
],
|
||||
"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 . --ignore-path .gitignore",
|
||||
"lint:prettier": "prettier . --check --ignore-path .gitignore",
|
||||
"lint:staged": "lint-staged",
|
||||
"test": "jest",
|
||||
"release": "semantic-release",
|
||||
"postinstall": "husky install",
|
||||
"prepublishOnly": "pinst --disable",
|
||||
"postpublish": "pinst --enable"
|
||||
"test": "node --enable-source-maps --test build/",
|
||||
"release": "semantic-release"
|
||||
},
|
||||
"dependencies": {
|
||||
"chalk": "4.1.2",
|
||||
"clipanion": "3.1.0",
|
||||
"html-validator": "6.0.0",
|
||||
"ora": "5.4.1",
|
||||
"read-pkg": "5.2.0",
|
||||
"table": "6.8.0"
|
||||
"chalk": "5.3.0",
|
||||
"clipanion": "3.2.1",
|
||||
"html-validator": "6.0.1",
|
||||
"log-symbols": "5.1.0",
|
||||
"ora": "6.3.1",
|
||||
"read-pkg": "8.0.0",
|
||||
"table": "6.8.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "16.2.1",
|
||||
"@commitlint/config-conventional": "16.2.1",
|
||||
"@swc/cli": "0.1.55",
|
||||
"@swc/core": "1.2.144",
|
||||
"@swc/jest": "0.2.17",
|
||||
"@types/html-validator": "5.0.2",
|
||||
"@types/jest": "27.4.1",
|
||||
"@commitlint/cli": "17.6.6",
|
||||
"@commitlint/config-conventional": "17.6.6",
|
||||
"@swc/cli": "0.1.62",
|
||||
"@swc/core": "1.3.67",
|
||||
"@tsconfig/strictest": "2.0.1",
|
||||
"@types/html-validator": "5.0.3",
|
||||
"@types/mock-fs": "4.13.1",
|
||||
"@types/node": "17.0.21",
|
||||
"@typescript-eslint/eslint-plugin": "5.12.1",
|
||||
"editorconfig-checker": "4.0.2",
|
||||
"eslint": "8.9.0",
|
||||
"eslint-config-conventions": "1.1.0",
|
||||
"eslint-config-prettier": "8.4.0",
|
||||
"eslint-plugin-import": "2.25.4",
|
||||
"eslint-plugin-prettier": "4.0.0",
|
||||
"eslint-plugin-promise": "6.0.0",
|
||||
"eslint-plugin-unicorn": "41.0.0",
|
||||
"execa": "5.1.1",
|
||||
"husky": "7.0.4",
|
||||
"jest": "27.5.1",
|
||||
"jest-mock-extended": "2.0.4",
|
||||
"jest-ts-webcompat-resolver": "1.0.0",
|
||||
"lint-staged": "12.3.4",
|
||||
"markdownlint-cli": "0.31.1",
|
||||
"mock-fs": "5.1.2",
|
||||
"pinst": "3.0.0",
|
||||
"prettier": "2.5.1",
|
||||
"rimraf": "3.0.2",
|
||||
"semantic-release": "19.0.2",
|
||||
"serve": "13.0.2",
|
||||
"typescript": "4.5.5"
|
||||
"@types/node": "20.3.3",
|
||||
"@types/tap": "15.0.8",
|
||||
"@typescript-eslint/eslint-plugin": "5.60.1",
|
||||
"editorconfig-checker": "5.1.1",
|
||||
"eslint": "8.44.0",
|
||||
"eslint-config-conventions": "9.0.0",
|
||||
"eslint-config-prettier": "8.8.0",
|
||||
"eslint-plugin-import": "2.27.5",
|
||||
"eslint-plugin-prettier": "4.2.1",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-unicorn": "47.0.0",
|
||||
"execa": "7.1.1",
|
||||
"lint-staged": "13.2.3",
|
||||
"markdownlint-cli2": "0.8.1",
|
||||
"markdownlint-rule-relative-links": "2.1.0",
|
||||
"mock-fs": "5.2.0",
|
||||
"prettier": "2.8.8",
|
||||
"rimraf": "5.0.1",
|
||||
"semantic-release": "21.0.6",
|
||||
"serve": "14.2.0",
|
||||
"typescript": "5.0.4"
|
||||
}
|
||||
}
|
||||
|
@ -4,10 +4,12 @@ import fs from 'node:fs'
|
||||
import { Command } from 'clipanion'
|
||||
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'
|
||||
@ -15,9 +17,14 @@ import { isExistingPath } from './utils/isExistingPath.js'
|
||||
const CURRENT_DIRECTORY = process.cwd()
|
||||
const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json'
|
||||
|
||||
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,35 @@ 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> {
|
||||
public async execute(): Promise<number> {
|
||||
const configPath = path.join(CURRENT_DIRECTORY, 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 +71,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 +99,111 @@ 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 configSeverities: Severity[] = config.severities ?? [
|
||||
'warning',
|
||||
'error'
|
||||
]
|
||||
for (const severity of configSeverities) {
|
||||
if (!severities.includes(severity)) {
|
||||
throw new Error(
|
||||
`Invalid config file at "${configPath}". Please add valid severities (${severities.join(
|
||||
', '
|
||||
)}).`
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
if (configSeverities.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(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 hasErrors = result.messages.some((message) => {
|
||||
return (
|
||||
configSeverities.includes(message.type as Severity) ||
|
||||
configSeverities.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) {
|
||||
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 +212,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) {
|
||||
|
@ -1,26 +1,23 @@
|
||||
import path from 'node:path'
|
||||
import test from 'node:test'
|
||||
import assert from 'node:assert/strict'
|
||||
|
||||
import execa from 'execa'
|
||||
import { execa } from 'execa'
|
||||
|
||||
import { cli } from '../cli.js'
|
||||
import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js'
|
||||
|
||||
describe('html-w3c-validator', () => {
|
||||
afterEach(() => {
|
||||
jest.clearAllMocks()
|
||||
})
|
||||
|
||||
it('should be instance of the command', () => {
|
||||
await test('html-w3c-validator', async (t) => {
|
||||
await t.test('should be instance of the command', async () => {
|
||||
const command = cli.process([])
|
||||
expect(command).toBeInstanceOf(HTMLValidatorCommand)
|
||||
assert(command instanceof HTMLValidatorCommand)
|
||||
})
|
||||
|
||||
it('succeeds and validate the html correctly', async () => {
|
||||
const examplePath = path.join(__dirname, '..', '..', 'example')
|
||||
process.chdir(examplePath)
|
||||
await t.test('succeeds and validate the html correctly', 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'])
|
||||
expect(exitCode).toEqual(0)
|
||||
assert.strictEqual(exitCode, 0)
|
||||
})
|
||||
})
|
||||
|
@ -1 +0,0 @@
|
||||
jest.setTimeout(60000)
|
@ -1,11 +1,7 @@
|
||||
import path from 'node:path'
|
||||
|
||||
import { Builtins, Cli } from 'clipanion'
|
||||
import readPackage from 'read-pkg'
|
||||
|
||||
import { HTMLValidatorCommand } from './HTMLValidatorCommand.js'
|
||||
|
||||
const packageJSON = readPackage.sync({ cwd: path.join(__dirname, '..') })
|
||||
import { packageJSON } from './packageJSON.js'
|
||||
|
||||
export const cli = new Cli({
|
||||
binaryLabel: packageJSON.name,
|
||||
|
@ -1,12 +1,8 @@
|
||||
#!/usr/bin/env node
|
||||
import chalk from 'chalk'
|
||||
import { Cli } from 'clipanion'
|
||||
|
||||
import { cli } from './cli.js'
|
||||
|
||||
const [, , ...arguments_] = process.argv
|
||||
|
||||
cli.runExit(arguments_, Cli.defaultContext).catch(() => {
|
||||
console.error(chalk.red('Error occurred...'))
|
||||
process.exit(1)
|
||||
})
|
||||
await cli.runExit(arguments_, Cli.defaultContext)
|
||||
|
5
src/packageJSON.ts
Normal file
5
src/packageJSON.ts
Normal file
@ -0,0 +1,5 @@
|
||||
import { readPackage } from 'read-pkg'
|
||||
|
||||
export const packageJSON = await readPackage({
|
||||
cwd: new URL('..', import.meta.url)
|
||||
})
|
@ -1,29 +1,26 @@
|
||||
import test from 'node:test'
|
||||
import assert from 'node:assert/strict'
|
||||
|
||||
import fsMock from 'mock-fs'
|
||||
|
||||
import { isExistingPath } from '../isExistingPath.js'
|
||||
|
||||
describe('utils/isExistingFile', () => {
|
||||
afterEach(() => {
|
||||
await test('utils/isExistingPath', async (t) => {
|
||||
t.afterEach(() => {
|
||||
fsMock.restore()
|
||||
})
|
||||
|
||||
it('should return true if the file exists', async () => {
|
||||
fsMock(
|
||||
{
|
||||
'/file.txt': ''
|
||||
},
|
||||
{ createCwd: false }
|
||||
)
|
||||
expect(await isExistingPath('/file.txt')).toBeTruthy()
|
||||
await t.test('should return true if the file exists', async () => {
|
||||
fsMock({
|
||||
'/file.txt': ''
|
||||
})
|
||||
assert.strictEqual(await isExistingPath('/file.txt'), true)
|
||||
})
|
||||
|
||||
it("should return false if the file doesn't exists", async () => {
|
||||
fsMock(
|
||||
{
|
||||
'/file.txt': ''
|
||||
},
|
||||
{ createCwd: false }
|
||||
)
|
||||
expect(await isExistingPath('/randomfile.txt')).toBeFalsy()
|
||||
await t.test("should return false if the file doesn't exists", async () => {
|
||||
fsMock({
|
||||
'/file.txt': ''
|
||||
})
|
||||
assert.strictEqual(await isExistingPath('/randomfile.txt'), false)
|
||||
})
|
||||
})
|
||||
|
@ -1,14 +1,13 @@
|
||||
{
|
||||
"extends": "@tsconfig/strictest/tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"target": "ESNext",
|
||||
"module": "commonjs",
|
||||
"module": "ESNext",
|
||||
"lib": ["ESNext"],
|
||||
"moduleResolution": "node",
|
||||
"outDir": "./build",
|
||||
"rootDir": "./src",
|
||||
"noEmit": true,
|
||||
"strict": true,
|
||||
"skipLibCheck": true,
|
||||
"esModuleInterop": true
|
||||
"exactOptionalPropertyTypes": false
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user