mirror of
				https://github.com/theoludwig/html-w3c-validator.git
				synced 2025-05-21 23:21:29 +02:00 
			
		
		
		
	Compare commits
	
		
			39 Commits
		
	
	
		
			v1.1.0
			...
			fbe3830db7
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| fbe3830db7 | |||
| 58d392d320 | |||
| e9a62072cf | |||
| cc6a1278a1 | |||
| e53c80d578 | |||
| 5f63d749e8 | |||
| 67b70feb15 | |||
| 6b28c6d224 | |||
| a1340b2729 | |||
| 92320385b5 | |||
| 8934ac1b7a | |||
| 09731d4749 | |||
| 2e0e136355 | |||
| 04a2742e46 | |||
| 75f862d0fd | |||
| 7dafa2401b | |||
| 02a5010340 | |||
| e3cd809e56 | |||
| 284b9fb057 | |||
| 1ae47aa197 | |||
| d4424036c5 | |||
| 82e32f26ff | |||
| 5abdb8a1f1 | |||
| aab0c3f502 | |||
| 5fa068b9f8 | |||
| c7bf82135b | |||
| eb970f1823 | |||
| 29203985e4 | |||
| a8841b24fd | |||
| bda82b39a3 | |||
| f7a4edc46a | |||
| 67806866ee | |||
|  | 3d24ffe971 | ||
|  | e818556c5b | ||
|  | 2cb7967bc7 | ||
|  | 943b3d1fd6 | ||
|  | 6ca7722fcf | ||
|  | 3a44eca5b1 | ||
|  | e762c0fad5 | 
| @@ -1 +0,0 @@ | ||||
| { "extends": ["@commitlint/config-conventional"] } | ||||
| @@ -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' | ||||
| @@ -1,16 +1,18 @@ | ||||
| { | ||||
|   "extends": ["conventions", "prettier"], | ||||
|   "plugins": ["prettier", "import", "unicorn"], | ||||
|   "root": true, | ||||
|   "extends": ["conventions"], | ||||
|   "plugins": ["promise", "unicorn"], | ||||
|   "overrides": [ | ||||
|     { | ||||
|       "files": ["*.ts", "*.tsx"], | ||||
|       "parser": "@typescript-eslint/parser", | ||||
|       "plugins": ["@typescript-eslint"], | ||||
|       "parserOptions": { | ||||
|     "project": "./tsconfig.json" | ||||
|   }, | ||||
|   "env": { | ||||
|     "node": true, | ||||
|     "jest": true | ||||
|         "projectService": true | ||||
|       }, | ||||
|       "rules": { | ||||
|     "prettier/prettier": "error", | ||||
|     "import/extensions": ["error", "always"], | ||||
|     "unicorn/prevent-abbreviations": "error" | ||||
|         "@typescript-eslint/no-unnecessary-condition": "off" | ||||
|       } | ||||
|     } | ||||
|   ] | ||||
| } | ||||
|   | ||||
							
								
								
									
										12
									
								
								.github/ISSUE_TEMPLATE/BUG.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										12
									
								
								.github/ISSUE_TEMPLATE/BUG.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,13 +1,13 @@ | ||||
| --- | ||||
| name: '🐛 Bug Report' | ||||
| about: 'Report an unexpected problem or unintended behavior.' | ||||
| title: '[Bug]' | ||||
| labels: 'bug' | ||||
| name: "🐛 Bug Report" | ||||
| about: "Report an unexpected problem or unintended behavior." | ||||
| title: "[Bug]" | ||||
| labels: "bug" | ||||
| --- | ||||
|  | ||||
| <!-- | ||||
|   Please provide a clear and concise description of what the bug is. Include | ||||
|   screenshots if needed. Please make sure your issue has not already been fixed. | ||||
| Please provide a clear and concise description of what the bug is. | ||||
| Include screenshots if needed. Please make sure your issue has not already been fixed. | ||||
| --> | ||||
|  | ||||
| ## Steps To Reproduce | ||||
|   | ||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/DOCUMENTATION.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/DOCUMENTATION.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | ||||
| --- | ||||
| name: '📜 Documentation' | ||||
| about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).' | ||||
| title: '[Documentation]' | ||||
| labels: 'documentation' | ||||
| name: "📜 Documentation" | ||||
| about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)." | ||||
| title: "[Documentation]" | ||||
| labels: "documentation" | ||||
| --- | ||||
|  | ||||
| <!-- Please make sure your issue has not already been fixed. --> | ||||
|   | ||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | ||||
| --- | ||||
| name: '✨ Feature Request' | ||||
| about: 'Suggest a new feature idea.' | ||||
| title: '[Feature]' | ||||
| labels: 'feature request' | ||||
| name: "✨ Feature Request" | ||||
| about: "Suggest a new feature idea." | ||||
| title: "[Feature]" | ||||
| labels: "feature request" | ||||
| --- | ||||
|  | ||||
| <!-- Please make sure your issue has not already been fixed. --> | ||||
|   | ||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/IMPROVEMENT.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/IMPROVEMENT.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | ||||
| --- | ||||
| name: '🔧 Improvement' | ||||
| about: 'Improve structure/format/performance/refactor/tests of the code.' | ||||
| title: '[Improvement]' | ||||
| labels: 'improvement' | ||||
| name: "🔧 Improvement" | ||||
| about: "Improve structure/format/performance/refactor/tests of the code." | ||||
| title: "[Improvement]" | ||||
| labels: "improvement" | ||||
| --- | ||||
|  | ||||
| <!-- Please make sure your issue has not already been fixed. --> | ||||
|   | ||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/QUESTION.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/QUESTION.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | ||||
| --- | ||||
| name: '🙋 Question' | ||||
| about: 'Further information is requested.' | ||||
| title: '[Question]' | ||||
| labels: 'question' | ||||
| name: "🙋 Question" | ||||
| about: "Further information is requested." | ||||
| title: "[Question]" | ||||
| labels: "question" | ||||
| --- | ||||
|  | ||||
| ### Question | ||||
|   | ||||
							
								
								
									
										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 | ||||
|  | ||||
|   | ||||
							
								
								
									
										26
									
								
								.github/workflows/build.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										26
									
								
								.github/workflows/build.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,25 +1,27 @@ | ||||
| name: 'Build' | ||||
| name: "Build" | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: [develop] | ||||
|   pull_request: | ||||
|     branches: [master, develop] | ||||
|     branches: [main, develop] | ||||
|  | ||||
| jobs: | ||||
|   build: | ||||
|     runs-on: 'ubuntu-latest' | ||||
|     runs-on: "ubuntu-latest" | ||||
|     steps: | ||||
|       - uses: 'actions/checkout@v2' | ||||
|       - uses: "actions/checkout@v4.2.2" | ||||
|  | ||||
|       - name: 'Use Node.js' | ||||
|         uses: 'actions/setup-node@v2.5.1' | ||||
|       - name: "Setup Node.js" | ||||
|         uses: "actions/setup-node@v4.1.0" | ||||
|         with: | ||||
|           node-version: 'lts/*' | ||||
|           cache: 'npm' | ||||
|           node-version: "lts/*" | ||||
|           cache: "npm" | ||||
|  | ||||
|       - name: 'Install' | ||||
|         run: 'npm install' | ||||
|       - name: "Install dependencies" | ||||
|         run: "npm clean-install" | ||||
|  | ||||
|       - name: 'Build' | ||||
|         run: 'npm run build' | ||||
|       - name: "Build" | ||||
|         run: "node --run build" | ||||
|  | ||||
|       - run: "node --run build:typescript" | ||||
|   | ||||
							
								
								
									
										28
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										28
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,28 +1,26 @@ | ||||
| name: 'Lint' | ||||
| name: "Lint" | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: [develop] | ||||
|   pull_request: | ||||
|     branches: [master, develop] | ||||
|     branches: [main, develop] | ||||
|  | ||||
| jobs: | ||||
|   lint: | ||||
|     runs-on: 'ubuntu-latest' | ||||
|     runs-on: "ubuntu-latest" | ||||
|     steps: | ||||
|       - uses: 'actions/checkout@v2' | ||||
|       - uses: "actions/checkout@v4.2.2" | ||||
|  | ||||
|       - name: 'Use Node.js' | ||||
|         uses: 'actions/setup-node@v2.5.1' | ||||
|       - name: "Setup Node.js" | ||||
|         uses: "actions/setup-node@v4.1.0" | ||||
|         with: | ||||
|           node-version: 'lts/*' | ||||
|           cache: 'npm' | ||||
|           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:prettier' | ||||
|       - run: "node --run lint:editorconfig" | ||||
|       - run: "node --run lint:eslint" | ||||
|       - run: "node --run lint:prettier" | ||||
|   | ||||
							
								
								
									
										38
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										38
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,32 +1,42 @@ | ||||
| name: 'Release' | ||||
| name: "Release" | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: [master] | ||||
|     branches: [main, beta] | ||||
|  | ||||
| jobs: | ||||
|   release: | ||||
|     runs-on: 'ubuntu-latest' | ||||
|     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@v4.2.2" | ||||
|         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@v4.1.0" | ||||
|         with: | ||||
|           node-version: 'lts/*' | ||||
|           cache: 'npm' | ||||
|           node-version: "lts/*" | ||||
|           cache: "npm" | ||||
|  | ||||
|       - name: 'Install' | ||||
|         run: 'npm install' | ||||
|       - name: "Install dependencies" | ||||
|         run: "npm clean-install" | ||||
|  | ||||
|       - name: 'Build' | ||||
|         run: 'npm run build' | ||||
|       - name: "Build" | ||||
|         run: "node --run build" | ||||
|  | ||||
|       - name: 'Release' | ||||
|         run: 'npm run release' | ||||
|       - run: "node --run build:typescript" | ||||
|  | ||||
|       - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies" | ||||
|         run: "npm audit signatures" | ||||
|  | ||||
|       - name: "Release" | ||||
|         run: "node --run release" | ||||
|         env: | ||||
|           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||
|           NPM_TOKEN: ${{ secrets.NPM_TOKEN }} | ||||
|   | ||||
							
								
								
									
										28
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										28
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,28 +1,28 @@ | ||||
| name: 'Test' | ||||
| name: "Test" | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: [develop] | ||||
|   pull_request: | ||||
|     branches: [master, develop] | ||||
|     branches: [main, develop] | ||||
|  | ||||
| jobs: | ||||
|   test: | ||||
|     runs-on: 'ubuntu-latest' | ||||
|     runs-on: "ubuntu-latest" | ||||
|     steps: | ||||
|       - uses: 'actions/checkout@v2' | ||||
|       - uses: "actions/checkout@v4.2.2" | ||||
|  | ||||
|       - name: 'Use Node.js' | ||||
|         uses: 'actions/setup-node@v2.5.1' | ||||
|       - name: "Setup Node.js" | ||||
|         uses: "actions/setup-node@v4.1.0" | ||||
|         with: | ||||
|           node-version: 'lts/*' | ||||
|           cache: 'npm' | ||||
|           node-version: "lts/*" | ||||
|           cache: "npm" | ||||
|  | ||||
|       - name: 'Install' | ||||
|         run: 'npm install' | ||||
|       - name: "Install dependencies" | ||||
|         run: "npm clean-install" | ||||
|  | ||||
|       - name: 'Build' | ||||
|         run: 'npm run build' | ||||
|       - name: "Build" | ||||
|         run: "node --run build" | ||||
|  | ||||
|       - name: 'Test' | ||||
|         run: 'npm run test' | ||||
|       - name: "Test" | ||||
|         run: "node --run test" | ||||
|   | ||||
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @@ -8,6 +8,7 @@ node_modules | ||||
|  | ||||
| # testing | ||||
| coverage | ||||
| .nyc_output | ||||
|  | ||||
| # envs | ||||
| .env | ||||
|   | ||||
							
								
								
									
										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,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 +0,0 @@ | ||||
| { | ||||
|   "*": ["editorconfig-checker"], | ||||
|   "*.{js,ts,jsx,tsx}": [ | ||||
|     "prettier --write", | ||||
|     "eslint --fix", | ||||
|     "jest --findRelatedTests" | ||||
|   ], | ||||
|   "*.{yml,json}": ["prettier --write"], | ||||
|   "*.md": ["prettier --write", "markdownlint --dot --fix"] | ||||
| } | ||||
| @@ -1,6 +0,0 @@ | ||||
| { | ||||
|   "default": true, | ||||
|   "MD013": false, | ||||
|   "MD033": false, | ||||
|   "MD041": false | ||||
| } | ||||
							
								
								
									
										1
									
								
								.prettierignore
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								.prettierignore
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | ||||
| fixtures | ||||
| @@ -1,6 +1,3 @@ | ||||
| { | ||||
|   "singleQuote": true, | ||||
|   "jsxSingleQuote": true, | ||||
|   "semi": false, | ||||
|   "trailingComma": "none" | ||||
|   "semi": false | ||||
| } | ||||
|   | ||||
| @@ -1,18 +1,8 @@ | ||||
| { | ||||
|   "branches": ["master"], | ||||
|   "branches": ["main", { "name": "beta", "prerelease": true }], | ||||
|   "plugins": [ | ||||
|     [ | ||||
|     "@semantic-release/commit-analyzer", | ||||
|       { | ||||
|         "preset": "conventionalcommits" | ||||
|       } | ||||
|     ], | ||||
|     [ | ||||
|     "@semantic-release/release-notes-generator", | ||||
|       { | ||||
|         "preset": "conventionalcommits" | ||||
|       } | ||||
|     ], | ||||
|     "@semantic-release/npm", | ||||
|     "@semantic-release/github" | ||||
|   ] | ||||
|   | ||||
							
								
								
									
										15
									
								
								.swcrc
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								.swcrc
									
									
									
									
									
								
							| @@ -1,22 +1,13 @@ | ||||
| { | ||||
|   "sourceMaps": true, | ||||
|   "jsc": { | ||||
|     "parser": { | ||||
|       "syntax": "typescript", | ||||
|       "decorators": true, | ||||
|       "dynamicImport": true | ||||
|     }, | ||||
|     "transform": { | ||||
|       "legacyDecorator": true, | ||||
|       "decoratorMetadata": true | ||||
|     }, | ||||
|     "target": "es2022", | ||||
|     "loose": true | ||||
|     "target": "esnext" | ||||
|   }, | ||||
|   "module": { | ||||
|     "type": "commonjs", | ||||
|     "strict": false, | ||||
|     "strictMode": true, | ||||
|     "lazy": false, | ||||
|     "noInterop": false | ||||
|     "type": "es6" | ||||
|   } | ||||
| } | ||||
|   | ||||
							
								
								
									
										9
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										9
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							| @@ -1,9 +0,0 @@ | ||||
| { | ||||
|   "recommendations": [ | ||||
|     "editorconfig.editorconfig", | ||||
|     "esbenp.prettier-vscode", | ||||
|     "dbaeumer.vscode-eslint", | ||||
|     "davidanson.vscode-markdownlint", | ||||
|     "ms-azuretools.vscode-docker" | ||||
|   ] | ||||
| } | ||||
							
								
								
									
										10
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							| @@ -1,10 +0,0 @@ | ||||
| { | ||||
|   "typescript.tsdk": "node_modules/typescript/lib", | ||||
|   "typescript.preferences.importModuleSpecifierEnding": "js", | ||||
|   "editor.defaultFormatter": "esbenp.prettier-vscode", | ||||
|   "prettier.configPath": ".prettierrc.json", | ||||
|   "editor.formatOnSave": true, | ||||
|   "editor.codeActionsOnSave": { | ||||
|     "source.fixAll": true | ||||
|   } | ||||
| } | ||||
| @@ -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. | ||||
|   | ||||
							
								
								
									
										4
									
								
								LICENSE
									
									
									
									
									
								
							
							
						
						
									
										4
									
								
								LICENSE
									
									
									
									
									
								
							| @@ -1,6 +1,6 @@ | ||||
| MIT License | ||||
| # MIT License | ||||
|  | ||||
| Copyright (c) Divlo | ||||
| Copyright (c) Théo LUDWIG <contact@theoludwig.fr> | ||||
|  | ||||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||||
| of this software and associated documentation files (the "Software"), to deal | ||||
|   | ||||
							
								
								
									
										41
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										41
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,19 +1,17 @@ | ||||
| <h1 align="center">html-w3c-validator</h1> | ||||
|  | ||||
| <p align="center"> | ||||
|   <strong>CLI for validating multiple html pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong> | ||||
| </p> | ||||
|  | ||||
|   <strong>CLI for validating HTML pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong> | ||||
| </p> | ||||
|  | ||||
| <p align="center"> | ||||
|   <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a> | ||||
|   <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="CONTRIBUTING" /></a> | ||||
|   <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" alt="Build" /></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" alt="Lint" /></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" alt="Test" /></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> | ||||
| @@ -22,11 +20,11 @@ | ||||
|  | ||||
| ## 📜 About | ||||
|  | ||||
| **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 HTML pages using [validator.w3.org](https://validator.w3.org/). | ||||
|  | ||||
| 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 is HTML page validation important? | ||||
|  | ||||
| Quote from [https://validator.w3.org/docs/help.html#why-validate](https://validator.w3.org/docs/help.html#why-validate): | ||||
|  | ||||
| @@ -40,7 +38,7 @@ You can combine **html-w3c-validator** with [start-server-and-test](https://gith | ||||
|  | ||||
| ### Prerequisites | ||||
|  | ||||
| - [Node.js](https://nodejs.org/) >= 16.0.0 | ||||
| [Node.js](https://nodejs.org/) >= 16.0.0 | ||||
|  | ||||
| ### Installation (with [start-server-and-test](https://github.com/bahmutov/start-server-and-test)) | ||||
|  | ||||
| @@ -59,8 +57,8 @@ 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,24 +66,30 @@ npm install --save-dev html-w3c-validator start-server-and-test | ||||
|  | ||||
| ```jsonc | ||||
| { | ||||
|   "urls": ["http://localhost:3000/", "http://localhost:3000/about"], | ||||
|   "$schema": "./node_modules/html-w3c-validator/schema/schema.json", | ||||
|  | ||||
|   // You can also specify HTML files instead of URLs | ||||
|   "files": ["./index.html", "./about.html"] | ||||
|   // URLs to validate. | ||||
|   "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"], | ||||
|  | ||||
|   // Files to validate. | ||||
|   "files": ["./index.html", "./about.html"], | ||||
|  | ||||
|   // Specify the severities of the validator messages to report. (default: ["warning", "error"]) | ||||
|   "severities": ["info", "warning", "error"], | ||||
| } | ||||
| ``` | ||||
|  | ||||
| ## Usage | ||||
|  | ||||
| ```sh | ||||
| npm run test:html-w3c-validator | ||||
| node --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! 🎉 | ||||
| ``` | ||||
| @@ -95,6 +99,7 @@ See the [./example](./example) folder for practical usage. | ||||
| ### Options | ||||
|  | ||||
| ```text | ||||
| --current-working-directory <path>  The current working directory (default: `process.cwd()`). | ||||
| -V, --version                       Output the version number. | ||||
| -h, --help                          Display help for command. | ||||
| ``` | ||||
|   | ||||
| @@ -1,4 +1,5 @@ | ||||
| { | ||||
|   "urls": ["http://localhost:3000/", "http://localhost:3000/about"], | ||||
|   "$schema": "./node_modules/html-w3c-validator/schema/schema.json", | ||||
|   "urls": ["http://127.0.0.1:3000/", "http://127.0.0.1:3000/about"], | ||||
|   "files": ["./build/index.html", "./build/about.html"] | ||||
| } | ||||
|   | ||||
| @@ -1,4 +1,4 @@ | ||||
| <!DOCTYPE html> | ||||
| <!doctype html> | ||||
| <html lang="en"> | ||||
|   <head> | ||||
|     <meta charset="UTF-8" /> | ||||
|   | ||||
| @@ -1,4 +1,4 @@ | ||||
| <!DOCTYPE html> | ||||
| <!doctype html> | ||||
| <html lang="en"> | ||||
|   <head> | ||||
|     <meta charset="UTF-8" /> | ||||
|   | ||||
							
								
								
									
										23784
									
								
								example/package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										23784
									
								
								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.4", | ||||
|     "start-server-and-test": "2.0.8", | ||||
|     "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"] | ||||
| } | ||||
							
								
								
									
										26540
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										26540
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										108
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										108
									
								
								package.json
									
									
									
									
									
								
							| @@ -1,18 +1,20 @@ | ||||
| { | ||||
|   "name": "html-w3c-validator", | ||||
|   "version": "0.0.0-development", | ||||
|   "description": "CLI for validating HTML pages using validator.w3.org.", | ||||
|   "public": true, | ||||
|   "description": "CLI for validating multiple html pages using validator.w3.org.", | ||||
|   "author": "Divlo <contact@divlo.fr>", | ||||
|   "types": "module", | ||||
|   "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 +23,55 @@ | ||||
|   ], | ||||
|   "main": "build/index.js", | ||||
|   "bin": "build/index.js", | ||||
|   "engines": { | ||||
|     "node": ">=16.0.0", | ||||
|     "npm": ">=8.0.0" | ||||
|   }, | ||||
|   "files": [ | ||||
|     "build" | ||||
|     "build", | ||||
|     "./schema/schema.json", | ||||
|     "!**/*.test.js", | ||||
|     "!**/*.map" | ||||
|   ], | ||||
|   "publishConfig": { | ||||
|     "access": "public", | ||||
|     "provenance": true | ||||
|   }, | ||||
|   "engines": { | ||||
|     "node": ">=16.0.0" | ||||
|   }, | ||||
|   "scripts": { | ||||
|     "build": "rimraf ./build && swc ./src --out-dir ./build && tsc", | ||||
|     "lint:commit": "commitlint", | ||||
|     "build": "swc ./src --out-dir ./build --strip-leading-paths --delete-dir-on-start", | ||||
|     "build:typescript": "tsc", | ||||
|     "start": "node --enable-source-maps build/index.js", | ||||
|     "lint: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:staged": "lint-staged", | ||||
|     "test": "jest", | ||||
|     "release": "semantic-release", | ||||
|     "postinstall": "husky install", | ||||
|     "prepublishOnly": "pinst --disable", | ||||
|     "postpublish": "pinst --enable" | ||||
|     "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore", | ||||
|     "lint:prettier": "prettier . --check", | ||||
|     "test": "node --enable-source-maps --test", | ||||
|     "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", | ||||
|     "log-symbols": "6.0.0", | ||||
|     "ora": "8.1.1", | ||||
|     "read-pkg": "9.0.1", | ||||
|     "table": "6.8.2" | ||||
|   }, | ||||
|   "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", | ||||
|     "@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" | ||||
|     "@swc/cli": "0.5.0", | ||||
|     "@swc/core": "1.9.1", | ||||
|     "@tsconfig/strictest": "2.0.5", | ||||
|     "@types/node": "22.9.0", | ||||
|     "@types/sinon": "17.0.3", | ||||
|     "@typescript-eslint/eslint-plugin": "8.13.0", | ||||
|     "@typescript-eslint/parser": "8.13.0", | ||||
|     "editorconfig-checker": "6.0.0", | ||||
|     "eslint": "8.57.1", | ||||
|     "eslint-config-conventions": "16.0.1", | ||||
|     "eslint-plugin-promise": "7.1.0", | ||||
|     "eslint-plugin-unicorn": "55.0.0", | ||||
|     "execa": "9.5.1", | ||||
|     "prettier": "3.3.3", | ||||
|     "semantic-release": "23.1.1", | ||||
|     "serve": "14.2.4", | ||||
|     "sinon": "19.0.2", | ||||
|     "typescript": "5.6.3" | ||||
|   } | ||||
| } | ||||
|   | ||||
							
								
								
									
										48
									
								
								schema/schema.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										48
									
								
								schema/schema.json
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,48 @@ | ||||
| { | ||||
|   "$schema": "http://json-schema.org/draft-07/schema", | ||||
|   "$id": "html-w3c-validator://config/schema.json", | ||||
|   "title": "html-w3c-validator configuration schema", | ||||
|   "type": "object", | ||||
|   "properties": { | ||||
|     "$schema": { | ||||
|       "description": "JSON Schema", | ||||
|       "type": "string" | ||||
|     }, | ||||
|     "urls": { | ||||
|       "description": "URLs to validate.", | ||||
|       "type": "array", | ||||
|       "default": [], | ||||
|       "minItems": 1, | ||||
|       "items": { | ||||
|         "description": "URL to validate.", | ||||
|         "type": "string", | ||||
|         "format": "uri", | ||||
|         "minLength": 1 | ||||
|       } | ||||
|     }, | ||||
|     "files": { | ||||
|       "description": "Files to validate.", | ||||
|       "type": "array", | ||||
|       "minItems": 1, | ||||
|       "default": [], | ||||
|       "items": { | ||||
|         "description": "File to validate.", | ||||
|         "type": "string", | ||||
|         "format": "uri-reference", | ||||
|         "minLength": 1 | ||||
|       } | ||||
|     }, | ||||
|     "severities": { | ||||
|       "description": "Specify the severities to report.", | ||||
|       "type": "array", | ||||
|       "minItems": 1, | ||||
|       "default": ["warning", "error"], | ||||
|       "items": { | ||||
|         "description": "Severity to report.", | ||||
|         "type": "string", | ||||
|         "enum": ["error", "warning", "info"] | ||||
|       } | ||||
|     } | ||||
|   }, | ||||
|   "additionalProperties": false | ||||
| } | ||||
| @@ -1,23 +1,26 @@ | ||||
| import path from 'node:path' | ||||
| import fs from 'node:fs' | ||||
| import fs from "node:fs" | ||||
| import path from "node:path" | ||||
|  | ||||
| import { Command } from 'clipanion' | ||||
| import chalk from 'chalk' | ||||
| import ora from 'ora' | ||||
| import validateHTML, { | ||||
|   ValidationMessageLocationObject, | ||||
|   ParsedJsonAsValidationResults | ||||
| } from 'html-validator' | ||||
| import { table } from 'table' | ||||
| import chalk from "chalk" | ||||
| import { Command, Option } from "clipanion" | ||||
| import logSymbols from "log-symbols" | ||||
| import ora from "ora" | ||||
| import { table } from "table" | ||||
| import * as typanion from "typanion" | ||||
|  | ||||
| import { isExistingPath } from './utils/isExistingPath.js' | ||||
| import type { ValidateHTMLResult } from "./validateHTML.js" | ||||
| import { getHTMLFromURL, validateHTML } from "./validateHTML.js" | ||||
|  | ||||
| const CURRENT_DIRECTORY = process.cwd() | ||||
| const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json' | ||||
| export const CONFIG_FILE_NAME = ".html-w3c-validatorrc.json" | ||||
|  | ||||
| export const SEVERITIES = ["error", "warning", "info"] as const | ||||
|  | ||||
| export type Severity = (typeof SEVERITIES)[number] | ||||
|  | ||||
| interface Config { | ||||
|   urls?: string[] | ||||
|   files?: string[] | ||||
|   severities?: Severity[] | ||||
| } | ||||
|  | ||||
| interface Error { | ||||
| @@ -25,103 +28,173 @@ 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/>.' | ||||
|       "CLI for validating HTML pages using <https://validator.w3.org/>.", | ||||
|   } | ||||
|  | ||||
|   async execute(): Promise<number> { | ||||
|     const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME) | ||||
|   public currentWorkingDirectory = Option.String( | ||||
|     "--current-working-directory", | ||||
|     process.cwd(), | ||||
|     { | ||||
|       description: "The current working directory.", | ||||
|       validator: typanion.isString(), | ||||
|     }, | ||||
|   ) | ||||
|  | ||||
|   public async execute(): Promise<number> { | ||||
|     const configPath = path.join(this.currentWorkingDirectory, CONFIG_FILE_NAME) | ||||
|     try { | ||||
|       if (!(await isExistingPath(configPath))) { | ||||
|       let configData: string | ||||
|       try { | ||||
|         configData = await fs.promises.readFile(configPath, { | ||||
|           encoding: "utf-8", | ||||
|         }) | ||||
|       } catch { | ||||
|         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' | ||||
|       }) | ||||
|       let config: Config = { urls: [], files: [] } | ||||
|       let isValidConfig = true | ||||
|       try { | ||||
|         config = JSON.parse(configData) | ||||
|       } 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 = | ||||
|         config.urls == null | ||||
|           ? [] | ||||
|           : config.urls.map((url) => { | ||||
|               return { type: 'url', data: url } | ||||
|               return { type: "url", data: url } | ||||
|             }) | ||||
|       const files = | ||||
|         config.files == null | ||||
|           ? [] | ||||
|           : config.files.map((file) => { | ||||
|               return { type: 'file', data: file } | ||||
|               return { type: "file", data: file } | ||||
|             }) | ||||
|       const dataToValidate = [...urls, ...files] | ||||
|       if (dataToValidate.length === 0) { | ||||
|         throw new Error( | ||||
|           `Invalid config file at "${configPath}". Please add URLs or files.`, | ||||
|         ) | ||||
|       } | ||||
|       const severities: Severity[] = config.severities ?? ["warning", "error"] | ||||
|       for (const severity of severities) { | ||||
|         if (!SEVERITIES.includes(severity)) { | ||||
|           throw new Error( | ||||
|             `Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join( | ||||
|               ", ", | ||||
|             )}).`, | ||||
|           ) | ||||
|         } | ||||
|       } | ||||
|       if (severities.length === 0) { | ||||
|         throw new Error( | ||||
|           `Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join( | ||||
|             ", ", | ||||
|           )}).`, | ||||
|         ) | ||||
|       } | ||||
|       const errors: Error[] = [] | ||||
|       let isValid = true | ||||
|       for (const { data, type } of dataToValidate) { | ||||
|         const loader = ora(`Validating ${data}`).start() | ||||
|       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') { | ||||
|             let result: ValidateHTMLResult | undefined | ||||
|             if (type === "url") { | ||||
|               result = await validateHTML({ | ||||
|               url: data, | ||||
|               isLocal: true, | ||||
|               ...options | ||||
|                 htmlData: await getHTMLFromURL(data), | ||||
|               }) | ||||
|           } else if (type === 'file') { | ||||
|             const htmlPath = path.resolve(CURRENT_DIRECTORY, data) | ||||
|             if (!(await isExistingPath(htmlPath))) { | ||||
|             } else if (type === "file") { | ||||
|               const htmlPath = path.resolve(this.currentWorkingDirectory, data) | ||||
|               let html: string | ||||
|               try { | ||||
|                 html = await fs.promises.readFile(htmlPath, { | ||||
|                   encoding: "utf-8", | ||||
|                 }) | ||||
|               } catch { | ||||
|                 throw new Error( | ||||
|                 `No file found at ${htmlPath}. Please check the path.` | ||||
|                   `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 | ||||
|                 htmlData: html, | ||||
|               }) | ||||
|             } else { | ||||
|             throw new Error('Invalid type') | ||||
|               throw new Error("Invalid type") | ||||
|             } | ||||
|           const isValidHTML = result.messages.length === 0 | ||||
|           if (isValidHTML) { | ||||
|             loader.succeed() | ||||
|             const hasErrors = result.messages.some((message) => { | ||||
|               return ( | ||||
|                 severities.includes(message.type as Severity) || | ||||
|                 severities.includes(message.subType as Severity) | ||||
|               ) | ||||
|             }) | ||||
|             if (!hasErrors) { | ||||
|               results.push({ data, isSuccess: true }) | ||||
|             } else { | ||||
|             loader.fail() | ||||
|               results.push({ data, isSuccess: false }) | ||||
|               const messagesTable: string[][] = [] | ||||
|               for (const message of result.messages) { | ||||
|                 if ( | ||||
|                   !severities.includes(message.type as Severity) && | ||||
|                   !severities.includes(message.subType as Severity) | ||||
|                 ) { | ||||
|                   continue | ||||
|                 } | ||||
|  | ||||
|                 const row: string[] = [] | ||||
|               if (message.type === 'error') { | ||||
|                 row.push(chalk.red(message.type)) | ||||
|                 if (message.type === "info") { | ||||
|                   if (message.subType === "warning") { | ||||
|                     row.push(chalk.yellow(message.subType)) | ||||
|                   } else { | ||||
|                 row.push(chalk.yellow(message.type)) | ||||
|                     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) { | ||||
|                 if ( | ||||
|                   message.extract != null && | ||||
|                   message.lastLine != null && | ||||
|                   message.firstColumn != null && | ||||
|                   message.lastColumn != null | ||||
|                 ) { | ||||
|                   row.push( | ||||
|                   `line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}` | ||||
|                     `line: ${message.lastLine}, column: ${message.firstColumn}-${message.lastColumn}`, | ||||
|                   ) | ||||
|                 } else { | ||||
|                   row.push("") | ||||
|                 } | ||||
|                 messagesTable.push(row) | ||||
|               } | ||||
| @@ -129,35 +202,36 @@ export class HTMLValidatorCommand extends Command { | ||||
|               isValid = false | ||||
|             } | ||||
|           } catch (error) { | ||||
|           loader.fail() | ||||
|             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)) | ||||
|           console.error('------------------------------') | ||||
|           console.error("------------------------------") | ||||
|         } | ||||
|         console.error() | ||||
|         throw new Error('HTML validation (W3C) failed!') | ||||
|         throw new Error("HTML validation (W3C) failed!") | ||||
|       } | ||||
|       console.log() | ||||
|       console.log( | ||||
|         `${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉` | ||||
|       loader.succeed( | ||||
|         `${chalk.bold.green("Success:")} HTML validation (W3C) passed! 🎉`, | ||||
|       ) | ||||
|       printResults(results) | ||||
|       return 0 | ||||
|     } catch (error) { | ||||
|       if (error instanceof Error) { | ||||
|         console.error(`${chalk.bold.red('Error:')} ${error.message}`) | ||||
|         console.error(`${chalk.bold.red("Error:")} ${error.message}`) | ||||
|       } else { | ||||
|         console.error( | ||||
|           `${chalk.bold.red('Error:')} HTML validation (W3C) failed!` | ||||
|           `${chalk.bold.red("Error:")} HTML validation (W3C) failed!`, | ||||
|         ) | ||||
|       } | ||||
|       return 1 | ||||
|   | ||||
| @@ -1,26 +1,468 @@ | ||||
| import path from 'node:path' | ||||
| import test from "node:test" | ||||
| import assert from "node:assert/strict" | ||||
| import path from "node:path" | ||||
| import fs from "node:fs" | ||||
| import { PassThrough } from "node:stream" | ||||
| import { fileURLToPath } from "node:url" | ||||
|  | ||||
| import execa from 'execa' | ||||
| import sinon from "sinon" | ||||
| import { execa } from "execa" | ||||
| import { table } from "table" | ||||
| import chalk from "chalk" | ||||
| import logSymbols from "log-symbols" | ||||
|  | ||||
| import { cli } from '../cli.js' | ||||
| import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js' | ||||
| import { cli } from "../cli.js" | ||||
| import { | ||||
|   HTMLValidatorCommand, | ||||
|   CONFIG_FILE_NAME, | ||||
|   SEVERITIES, | ||||
| } from "../HTMLValidatorCommand.js" | ||||
|  | ||||
| describe('html-w3c-validator', () => { | ||||
|   afterEach(() => { | ||||
|     jest.clearAllMocks() | ||||
| const FIXTURES_PATH = path.join(process.cwd(), "src", "__test__", "fixtures") | ||||
|  | ||||
| await test("html-w3c-validator", async (t) => { | ||||
|   t.afterEach(() => { | ||||
|     sinon.restore() | ||||
|   }) | ||||
|  | ||||
|   it('should be instance of the command', () => { | ||||
|   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 execa('rimraf', ['node_modules']) | ||||
|     await execa('npm', ['install']) | ||||
|     const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator']) | ||||
|     expect(exitCode).toEqual(0) | ||||
|   await t.test( | ||||
|     "succeeds and validate the html correctly (example)", | ||||
|     async () => { | ||||
|       const exampleURL = new URL("../../example", import.meta.url) | ||||
|       process.chdir(exampleURL.pathname) | ||||
|       await fs.promises.rm( | ||||
|         path.join(fileURLToPath(exampleURL), "node_modules"), | ||||
|         { recursive: true, force: true }, | ||||
|       ) | ||||
|       await execa("npm", ["install"]) | ||||
|       const { exitCode } = await execa("node", [ | ||||
|         "--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, logs.join("\n")) | ||||
|       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, logs.join("\n")) | ||||
|       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 by validating the html correctly with 2 errors: one with line/column, the other without (GitHub issue #6)", | ||||
|     async () => { | ||||
|       const workingDirectory = path.join(FIXTURES_PATH, "issue-6") | ||||
|       const errors: string[] = [] | ||||
|       sinon.stub(console, "error").value((error: string) => { | ||||
|         errors.push(error) | ||||
|       }) | ||||
|       const consoleErrorSpy = sinon.spy(console, "error") | ||||
|       const stream = new PassThrough() | ||||
|       const exitCode = await cli.run( | ||||
|         [`--current-working-directory=${workingDirectory}`], | ||||
|         { | ||||
|           stdin: process.stdin, | ||||
|           stdout: stream, | ||||
|           stderr: stream, | ||||
|         }, | ||||
|       ) | ||||
|       stream.end() | ||||
|       assert.strictEqual(exitCode, 1) | ||||
|       const messagesTable = [ | ||||
|         [ | ||||
|           chalk.red("error"), | ||||
|           "The character encoding was not declared. Proceeding using “windows-1252”.", | ||||
|           "", | ||||
|         ], | ||||
|         [ | ||||
|           chalk.yellow("warning"), | ||||
|           "Consider adding a “lang” attribute to the “html” start tag to declare the language of this document.", | ||||
|           "line: 2, column: 16-7", | ||||
|         ], | ||||
|       ] | ||||
|       assert.strictEqual( | ||||
|         consoleErrorSpy.calledWith( | ||||
|           chalk.bold.red("Error:") + " HTML validation (W3C) failed!", | ||||
|         ), | ||||
|         true, | ||||
|         errors.join("\n"), | ||||
|       ) | ||||
|       assert.strictEqual( | ||||
|         consoleErrorSpy.calledWith(table(messagesTable)), | ||||
|         true, | ||||
|         errors.join("\n"), | ||||
|       ) | ||||
|     }, | ||||
|   ) | ||||
|  | ||||
|   await t.test("fails with not found config", async () => { | ||||
|     const workingDirectory = path.join(FIXTURES_PATH, "error-config-not-found") | ||||
|     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME) | ||||
|     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,5 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "urls": [], | ||||
|   "files": [] | ||||
| } | ||||
| @@ -0,0 +1,4 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "files": "Invalid" | ||||
| } | ||||
| @@ -0,0 +1 @@ | ||||
| Invalid JSON | ||||
| @@ -0,0 +1,5 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "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,5 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "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,4 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "urls": "Invalid" | ||||
| } | ||||
| @@ -0,0 +1,4 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "files": ["./index.html"] | ||||
| } | ||||
| @@ -0,0 +1,4 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "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> | ||||
							
								
								
									
										5
									
								
								src/__test__/fixtures/issue-6/.html-w3c-validatorrc.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										5
									
								
								src/__test__/fixtures/issue-6/.html-w3c-validatorrc.json
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,5 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "files": ["./build/index.html"], | ||||
|   "severities": ["info", "warning", "error"] | ||||
| } | ||||
							
								
								
									
										12
									
								
								src/__test__/fixtures/issue-6/build/index.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								src/__test__/fixtures/issue-6/build/index.html
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,12 @@ | ||||
| <!DOCTYPE html> | ||||
| <title>Have We Stopped Killing Yet?</title> | ||||
| <link rel=icon href=favicon.ico> | ||||
| <link rel=stylesheet href=setup/default.css> | ||||
| <meta name=viewport content="initial-scale=1,width=device-width"> | ||||
| <meta property="og:image" content="https://mirrors.meiert.org/havewestoppedkillingyet.org/media/redrum.png"> | ||||
| <h1>Have We Stopped Killing Yet?</h1> | ||||
| <p><strong>No.</strong> | ||||
| <p>This is <a href=https://meiert.com/en/blog/on-taking-life/>unacceptable</a>. | ||||
| <p>We don’t need arms and armies and industrial slaughterhouses. | ||||
| <p>We need respect for life. | ||||
| <p>Everyone can <em>do something</em>. Speaking up is doing something. <a href=https://meiert.com/en/><img src=https://hell.meiert.org/core/png/meiert-logo-80x80-alt.png alt="Jens Oliver Meiert"></a> | ||||
							
								
								
									
										4
									
								
								src/__test__/fixtures/success/.html-w3c-validatorrc.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										4
									
								
								src/__test__/fixtures/success/.html-w3c-validatorrc.json
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,4 @@ | ||||
| { | ||||
|   "$schema": "../../../../schema/schema.json", | ||||
|   "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> | ||||
| @@ -1 +0,0 @@ | ||||
| jest.setTimeout(60000) | ||||
							
								
								
									
										12
									
								
								src/cli.ts
									
									
									
									
									
								
							
							
						
						
									
										12
									
								
								src/cli.ts
									
									
									
									
									
								
							| @@ -1,16 +1,12 @@ | ||||
| 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' | ||||
|  | ||||
| const packageJSON = readPackage.sync({ cwd: path.join(__dirname, '..') }) | ||||
| import { HTMLValidatorCommand } from "./HTMLValidatorCommand.js" | ||||
| import { packageJSON } from "./packageJSON.js" | ||||
|  | ||||
| export const cli = new Cli({ | ||||
|   binaryLabel: packageJSON.name, | ||||
|   binaryName: packageJSON.name, | ||||
|   binaryVersion: packageJSON.version | ||||
|   binaryVersion: packageJSON.version, | ||||
| }) | ||||
| cli.register(Builtins.HelpCommand) | ||||
| cli.register(Builtins.VersionCommand) | ||||
|   | ||||
							
								
								
									
										10
									
								
								src/index.ts
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								src/index.ts
									
									
									
									
									
								
							| @@ -1,12 +1,8 @@ | ||||
| #!/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 | ||||
|  | ||||
| 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 +0,0 @@ | ||||
| import fsMock from 'mock-fs' | ||||
|  | ||||
| import { isExistingPath } from '../isExistingPath.js' | ||||
|  | ||||
| describe('utils/isExistingFile', () => { | ||||
|   afterEach(() => { | ||||
|     fsMock.restore() | ||||
|   }) | ||||
|  | ||||
|   it('should return true if the file exists', async () => { | ||||
|     fsMock( | ||||
|       { | ||||
|         '/file.txt': '' | ||||
|       }, | ||||
|       { createCwd: false } | ||||
|     ) | ||||
|     expect(await isExistingPath('/file.txt')).toBeTruthy() | ||||
|   }) | ||||
|  | ||||
|   it("should return false if the file doesn't exists", async () => { | ||||
|     fsMock( | ||||
|       { | ||||
|         '/file.txt': '' | ||||
|       }, | ||||
|       { createCwd: false } | ||||
|     ) | ||||
|     expect(await isExistingPath('/randomfile.txt')).toBeFalsy() | ||||
|   }) | ||||
| }) | ||||
| @@ -1,10 +0,0 @@ | ||||
| import fs from 'node:fs' | ||||
|  | ||||
| export const isExistingPath = async (path: string): Promise<boolean> => { | ||||
|   try { | ||||
|     await fs.promises.access(path, fs.constants.F_OK) | ||||
|     return true | ||||
|   } catch { | ||||
|     return false | ||||
|   } | ||||
| } | ||||
							
								
								
									
										46
									
								
								src/validateHTML.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										46
									
								
								src/validateHTML.ts
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,46 @@ | ||||
| export interface ValidateHTMLOptions { | ||||
|   htmlData: string | ||||
| } | ||||
|  | ||||
| export interface ValidationMessage { | ||||
|   type: "error" | "info" | "non-document-error" | ||||
|   subType?: "warning" | "fatal" | "internal" | "io" | "schema" | ||||
|   message: string | ||||
|   extract?: string | ||||
|   lastLine?: number | ||||
|   firstColumn?: number | ||||
|   lastColumn?: number | ||||
| } | ||||
|  | ||||
| export interface ValidateHTMLResult { | ||||
|   messages: ValidationMessage[] | ||||
| } | ||||
|  | ||||
| export const validateHTML = async ( | ||||
|   options: ValidateHTMLOptions, | ||||
| ): Promise<ValidateHTMLResult> => { | ||||
|   const { htmlData } = options | ||||
|   const url = new URL("https://validator.w3.org/nu/") | ||||
|   url.searchParams.set("out", "json") | ||||
|   const response = await fetch(url, { | ||||
|     method: "POST", | ||||
|     body: htmlData, | ||||
|     headers: { | ||||
|       "Content-Type": "text/html", | ||||
|     }, | ||||
|   }) | ||||
|   if (!response.ok) { | ||||
|     throw new Error(response.statusText) | ||||
|   } | ||||
|   const result = (await response.json()) as ValidateHTMLResult | ||||
|   return result | ||||
| } | ||||
|  | ||||
| export const getHTMLFromURL = async (url: string): Promise<string> => { | ||||
|   const response = await fetch(url) | ||||
|   if (!response.ok) { | ||||
|     throw new Error(`Failed to fetch HTML from "${url}"`) | ||||
|   } | ||||
|   const html = await response.text() | ||||
|   return html | ||||
| } | ||||
| @@ -1,14 +1,14 @@ | ||||
| { | ||||
|   "extends": "@tsconfig/strictest/tsconfig.json", | ||||
|   "compilerOptions": { | ||||
|     "target": "ESNext", | ||||
|     "module": "commonjs", | ||||
|     "lib": ["ESNext"], | ||||
|     "moduleResolution": "node", | ||||
|     "module": "NodeNext", | ||||
|     "moduleResolution": "NodeNext", | ||||
|     "outDir": "./build", | ||||
|     "rootDir": "./src", | ||||
|     "noEmit": true, | ||||
|     "strict": true, | ||||
|     "skipLibCheck": true, | ||||
|     "esModuleInterop": true | ||||
|     "exactOptionalPropertyTypes": false, | ||||
|     "checkJs": false | ||||
|   } | ||||
| } | ||||
|   | ||||
		Reference in New Issue
	
	Block a user