mirror of
				https://github.com/theoludwig/html-w3c-validator.git
				synced 2025-05-21 23:21:29 +02:00 
			
		
		
		
	Compare commits
	
		
			37 Commits
		
	
	
		
			v1.0.0
			...
			e53c80d578
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 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 | ||
|  | e032bbe637 | ||
|  | d92235d79d | 
| @@ -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,5 +0,0 @@ | |||||||
| build |  | ||||||
| node_modules |  | ||||||
| coverage |  | ||||||
| package.json |  | ||||||
| package-lock.json |  | ||||||
| @@ -1,21 +1,19 @@ | |||||||
| { | { | ||||||
|   "extends": ["standard-with-typescript", "prettier"], |   "root": true, | ||||||
|   "plugins": ["unicorn", "import", "prettier"], |   "extends": ["conventions"], | ||||||
|  |   "plugins": ["import", "promise", "unicorn"], | ||||||
|  |   "rules": { | ||||||
|  |     "import/extensions": ["error", "always"], | ||||||
|  |     "unicorn/prevent-abbreviations": "error" | ||||||
|  |   }, | ||||||
|  |   "overrides": [ | ||||||
|  |     { | ||||||
|  |       "files": ["*.ts", "*.tsx"], | ||||||
|  |       "parser": "@typescript-eslint/parser", | ||||||
|  |       "plugins": ["@typescript-eslint"], | ||||||
|       "parserOptions": { |       "parserOptions": { | ||||||
|         "project": "./tsconfig.json" |         "project": "./tsconfig.json" | ||||||
|   }, |  | ||||||
|   "env": { |  | ||||||
|     "node": true, |  | ||||||
|     "jest": true |  | ||||||
|   }, |  | ||||||
|   "rules": { |  | ||||||
|     "prettier/prettier": "error", |  | ||||||
|     "import/order": [ |  | ||||||
|       "error", |  | ||||||
|       { "groups": ["builtin", "external", "internal"] } |  | ||||||
|     ], |  | ||||||
|     "import/extensions": ["error", "always"], |  | ||||||
|     "unicorn/prefer-node-protocol": "error", |  | ||||||
|     "unicorn/prevent-abbreviations": "error" |  | ||||||
|       } |       } | ||||||
|     } |     } | ||||||
|  |   ] | ||||||
|  | } | ||||||
|   | |||||||
							
								
								
									
										1
									
								
								.gitattributes
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										1
									
								
								.gitattributes
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1 @@ | |||||||
|  | * text=auto eol=lf | ||||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/BUG.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/BUG.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | |||||||
| --- | --- | ||||||
| name: '🐛 Bug Report' | name: "🐛 Bug Report" | ||||||
| about: 'Report an unexpected problem or unintended behavior.' | about: "Report an unexpected problem or unintended behavior." | ||||||
| title: '[Bug]' | title: "[Bug]" | ||||||
| labels: 'bug' | labels: "bug" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| <!-- | <!-- | ||||||
|   | |||||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/DOCUMENTATION.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/DOCUMENTATION.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | |||||||
| --- | --- | ||||||
| name: '📜 Documentation' | name: "📜 Documentation" | ||||||
| about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).' | about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)." | ||||||
| title: '[Documentation]' | title: "[Documentation]" | ||||||
| labels: 'documentation' | labels: "documentation" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| <!-- Please make sure your issue has not already been fixed. --> | <!-- 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' | name: "✨ Feature Request" | ||||||
| about: 'Suggest a new feature idea.' | about: "Suggest a new feature idea." | ||||||
| title: '[Feature]' | title: "[Feature]" | ||||||
| labels: 'feature request' | labels: "feature request" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| <!-- Please make sure your issue has not already been fixed. --> | <!-- 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' | name: "🔧 Improvement" | ||||||
| about: 'Improve structure/format/performance/refactor/tests of the code.' | about: "Improve structure/format/performance/refactor/tests of the code." | ||||||
| title: '[Improvement]' | title: "[Improvement]" | ||||||
| labels: 'improvement' | labels: "improvement" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| <!-- Please make sure your issue has not already been fixed. --> | <!-- 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' | name: "🙋 Question" | ||||||
| about: 'Further information is requested.' | about: "Further information is requested." | ||||||
| title: '[Question]' | title: "[Question]" | ||||||
| labels: 'question' | labels: "question" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| ### 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. --> | <!-- 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 | ## 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: | on: | ||||||
|   push: |   push: | ||||||
|     branches: [master, develop] |     branches: [develop] | ||||||
|   pull_request: |   pull_request: | ||||||
|     branches: [master, develop] |     branches: [master, develop] | ||||||
|  |  | ||||||
| jobs: | jobs: | ||||||
|   build: |   build: | ||||||
|     runs-on: 'ubuntu-latest' |     runs-on: "ubuntu-latest" | ||||||
|     steps: |     steps: | ||||||
|       - uses: 'actions/checkout@v2' |       - uses: "actions/checkout@v4.1.6" | ||||||
|  |  | ||||||
|       - name: 'Use Node.js' |       - name: "Setup Node.js" | ||||||
|         uses: 'actions/setup-node@v2.5.1' |         uses: "actions/setup-node@v4.0.2" | ||||||
|         with: |         with: | ||||||
|           node-version: '16.x' |           node-version: "lts/*" | ||||||
|           cache: 'npm' |           cache: "npm" | ||||||
|  |  | ||||||
|       - name: 'Install' |       - name: "Install dependencies" | ||||||
|         run: 'npm install' |         run: "npm clean-install" | ||||||
|  |  | ||||||
|       - name: 'Build' |       - name: "Build" | ||||||
|         run: 'npm run build' |         run: "npm run build" | ||||||
|  |  | ||||||
|  |       - run: "npm run build:typescript" | ||||||
|   | |||||||
							
								
								
									
										38
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										38
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,37 +1,27 @@ | |||||||
| name: 'Lint' | name: "Lint" | ||||||
|  |  | ||||||
| on: | on: | ||||||
|   push: |   push: | ||||||
|     branches: [master, develop] |     branches: [develop] | ||||||
|   pull_request: |   pull_request: | ||||||
|     branches: [master, develop] |     branches: [master, develop] | ||||||
|  |  | ||||||
| jobs: | jobs: | ||||||
|   lint: |   lint: | ||||||
|     runs-on: 'ubuntu-latest' |     runs-on: "ubuntu-latest" | ||||||
|     steps: |     steps: | ||||||
|       - uses: 'actions/checkout@v2' |       - uses: "actions/checkout@v4.1.6" | ||||||
|  |  | ||||||
|       - name: 'Use Node.js' |       - name: "Setup Node.js" | ||||||
|         uses: 'actions/setup-node@v2.5.1' |         uses: "actions/setup-node@v4.0.2" | ||||||
|         with: |         with: | ||||||
|           node-version: '16.x' |           node-version: "lts/*" | ||||||
|           cache: 'npm' |           cache: "npm" | ||||||
|  |  | ||||||
|       - name: 'Install' |       - name: "Install dependencies" | ||||||
|         run: 'npm install' |         run: "npm clean-install" | ||||||
|  |  | ||||||
|       - name: 'lint:commit' |       - run: 'npm run lint:commit -- --to "${{ github.sha }}"' | ||||||
|         run: 'npm run lint:commit -- --to "${{ github.sha }}"' |       - run: "npm run lint:editorconfig" | ||||||
|  |       - run: "npm run lint:eslint" | ||||||
|       - name: 'lint:editorconfig' |       - run: "npm run lint:prettier" | ||||||
|         run: 'npm run lint:editorconfig' |  | ||||||
|  |  | ||||||
|       - name: 'lint:markdown' |  | ||||||
|         run: 'npm run lint:markdown' |  | ||||||
|  |  | ||||||
|       - name: 'lint:typescript' |  | ||||||
|         run: 'npm run lint:typescript' |  | ||||||
|  |  | ||||||
|       - name: 'lint:prettier' |  | ||||||
|         run: 'npm run lint:prettier' |  | ||||||
|   | |||||||
							
								
								
									
										36
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										36
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,4 +1,4 @@ | |||||||
| name: 'Release' | name: "Release" | ||||||
|  |  | ||||||
| on: | on: | ||||||
|   push: |   push: | ||||||
| @@ -6,27 +6,37 @@ on: | |||||||
|  |  | ||||||
| jobs: | jobs: | ||||||
|   release: |   release: | ||||||
|     runs-on: 'ubuntu-latest' |     runs-on: "ubuntu-latest" | ||||||
|  |     permissions: | ||||||
|  |       contents: "write" | ||||||
|  |       issues: "write" | ||||||
|  |       pull-requests: "write" | ||||||
|  |       id-token: "write" | ||||||
|     steps: |     steps: | ||||||
|       - uses: 'actions/checkout@v2.3.4' |       - uses: "actions/checkout@v4.1.6" | ||||||
|         with: |         with: | ||||||
|           fetch-depth: 0 |           fetch-depth: 0 | ||||||
|           persist-credentials: false |           persist-credentials: false | ||||||
|  |  | ||||||
|       - name: 'Use Node.js' |       - name: "Setup Node.js" | ||||||
|         uses: 'actions/setup-node@v2.5.1' |         uses: "actions/setup-node@v4.0.2" | ||||||
|         with: |         with: | ||||||
|           node-version: '16.x' |           node-version: "lts/*" | ||||||
|           cache: 'npm' |           cache: "npm" | ||||||
|  |  | ||||||
|       - name: 'Install' |       - name: "Install dependencies" | ||||||
|         run: 'npm install' |         run: "npm clean-install" | ||||||
|  |  | ||||||
|       - name: 'Build' |       - name: "Build" | ||||||
|         run: 'npm run build' |         run: "npm run build" | ||||||
|  |  | ||||||
|       - name: 'Release' |       - run: "npm run build:typescript" | ||||||
|         run: 'npm run release' |  | ||||||
|  |       - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies" | ||||||
|  |         run: "npm audit signatures" | ||||||
|  |  | ||||||
|  |       - name: "Release" | ||||||
|  |         run: "npm run release" | ||||||
|         env: |         env: | ||||||
|           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||
|           NPM_TOKEN: ${{ secrets.NPM_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: | on: | ||||||
|   push: |   push: | ||||||
|     branches: [master, develop] |     branches: [develop] | ||||||
|   pull_request: |   pull_request: | ||||||
|     branches: [master, develop] |     branches: [master, develop] | ||||||
|  |  | ||||||
| jobs: | jobs: | ||||||
|   test: |   test: | ||||||
|     runs-on: 'ubuntu-latest' |     runs-on: "ubuntu-latest" | ||||||
|     steps: |     steps: | ||||||
|       - uses: 'actions/checkout@v2' |       - uses: "actions/checkout@v4.1.6" | ||||||
|  |  | ||||||
|       - name: 'Use Node.js' |       - name: "Setup Node.js" | ||||||
|         uses: 'actions/setup-node@v2.5.1' |         uses: "actions/setup-node@v4.0.2" | ||||||
|         with: |         with: | ||||||
|           node-version: '16.x' |           node-version: "lts/*" | ||||||
|           cache: 'npm' |           cache: "npm" | ||||||
|  |  | ||||||
|       - name: 'Install' |       - name: "Install dependencies" | ||||||
|         run: 'npm install' |         run: "npm clean-install" | ||||||
|  |  | ||||||
|       - name: 'Build' |       - name: "Build" | ||||||
|         run: 'npm run build' |         run: "npm run build" | ||||||
|  |  | ||||||
|       - name: 'Test' |       - name: "Test" | ||||||
|         run: 'npm run test' |         run: "npm run test" | ||||||
|   | |||||||
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @@ -8,6 +8,7 @@ node_modules | |||||||
|  |  | ||||||
| # testing | # testing | ||||||
| coverage | coverage | ||||||
|  | .nyc_output | ||||||
|  |  | ||||||
| # envs | # envs | ||||||
| .env | .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 +1,3 @@ | |||||||
| #!/bin/sh | #!/usr/bin/env sh | ||||||
| . "$(dirname "$0")/_/husky.sh" |  | ||||||
|  |  | ||||||
| npm run lint:commit -- --edit | npm run lint:commit -- --edit | ||||||
|   | |||||||
| @@ -1,5 +1,4 @@ | |||||||
| #!/bin/sh | #!/usr/bin/env sh | ||||||
| . "$(dirname "$0")/_/husky.sh" |  | ||||||
|  |  | ||||||
| npm run lint:staged | npm run lint:staged | ||||||
| npm run build | npm run build:typescript | ||||||
|   | |||||||
| @@ -1,10 +1,6 @@ | |||||||
| { | { | ||||||
|   "*": ["editorconfig-checker"], |   "**/*": ["editorconfig-checker", "prettier --write --ignore-unknown"], | ||||||
|   "*.{js,ts,jsx,tsx}": [ |   "**/*.{js,jsx,ts,tsx}": [ | ||||||
|     "prettier --write", |     "eslint --fix --max-warnings 0 --report-unused-disable-directives" | ||||||
|     "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 |  | ||||||
| } |  | ||||||
							
								
								
									
										2
									
								
								.npmrc
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								.npmrc
									
									
									
									
									
								
							| @@ -1,2 +1,2 @@ | |||||||
| save-exact=true | save-exact=true | ||||||
| engine-strict=true | provenance=true | ||||||
|   | |||||||
| @@ -1,5 +1 @@ | |||||||
| /build | fixtures | ||||||
| node_modules |  | ||||||
| coverage |  | ||||||
| package.json |  | ||||||
| package-lock.json |  | ||||||
|   | |||||||
| @@ -1,6 +1,3 @@ | |||||||
| { | { | ||||||
|   "singleQuote": true, |   "semi": false | ||||||
|   "jsxSingleQuote": true, |  | ||||||
|   "semi": false, |  | ||||||
|   "trailingComma": "none" |  | ||||||
| } | } | ||||||
|   | |||||||
							
								
								
									
										15
									
								
								.swcrc
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								.swcrc
									
									
									
									
									
								
							| @@ -1,22 +1,13 @@ | |||||||
| { | { | ||||||
|  |   "sourceMaps": true, | ||||||
|   "jsc": { |   "jsc": { | ||||||
|     "parser": { |     "parser": { | ||||||
|       "syntax": "typescript", |       "syntax": "typescript", | ||||||
|       "decorators": true, |  | ||||||
|       "dynamicImport": true |       "dynamicImport": true | ||||||
|     }, |     }, | ||||||
|     "transform": { |     "target": "esnext" | ||||||
|       "legacyDecorator": true, |  | ||||||
|       "decoratorMetadata": true |  | ||||||
|     }, |  | ||||||
|     "target": "es2022", |  | ||||||
|     "loose": true |  | ||||||
|   }, |   }, | ||||||
|   "module": { |   "module": { | ||||||
|     "type": "commonjs", |     "type": "es6" | ||||||
|     "strict": false, |  | ||||||
|     "strictMode": true, |  | ||||||
|     "lazy": false, |  | ||||||
|     "noInterop": false |  | ||||||
|   } |   } | ||||||
| } | } | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							| @@ -3,7 +3,6 @@ | |||||||
|     "editorconfig.editorconfig", |     "editorconfig.editorconfig", | ||||||
|     "esbenp.prettier-vscode", |     "esbenp.prettier-vscode", | ||||||
|     "dbaeumer.vscode-eslint", |     "dbaeumer.vscode-eslint", | ||||||
|     "davidanson.vscode-markdownlint", |     "davidanson.vscode-markdownlint" | ||||||
|     "ms-azuretools.vscode-docker" |  | ||||||
|   ] |   ] | ||||||
| } | } | ||||||
|   | |||||||
							
								
								
									
										29
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										29
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							| @@ -1,33 +1,14 @@ | |||||||
| { | { | ||||||
|   "typescript.tsdk": "node_modules/typescript/lib", |   "typescript.tsdk": "node_modules/typescript/lib", | ||||||
|   "typescript.preferences.importModuleSpecifierEnding": "js", |   "typescript.preferences.importModuleSpecifierEnding": "js", | ||||||
|  |   "editor.defaultFormatter": "esbenp.prettier-vscode", | ||||||
|   "prettier.configPath": ".prettierrc.json", |   "prettier.configPath": ".prettierrc.json", | ||||||
|   "editor.formatOnSave": true, |   "editor.formatOnSave": true, | ||||||
|   "editor.codeActionsOnSave": { |   "editor.codeActionsOnSave": { | ||||||
|     "source.fixAll": true |     "source.fixAll": "explicit" | ||||||
|   }, |   }, | ||||||
|   "[markdown]": { |   "eslint.options": { | ||||||
|     "editor.autoClosingBrackets": "always", |     "ignorePath": ".gitignore" | ||||||
|     "editor.defaultFormatter": "esbenp.prettier-vscode" |  | ||||||
|   }, |   }, | ||||||
|   "[yaml]": { |   "prettier.ignorePath": ".gitignore" | ||||||
|     "editor.autoClosingBrackets": "always", |  | ||||||
|     "editor.defaultFormatter": "esbenp.prettier-vscode" |  | ||||||
|   }, |  | ||||||
|   "[json]": { |  | ||||||
|     "editor.autoClosingBrackets": "always", |  | ||||||
|     "editor.defaultFormatter": "esbenp.prettier-vscode" |  | ||||||
|   }, |  | ||||||
|   "[jsonc]": { |  | ||||||
|     "editor.autoClosingBrackets": "always", |  | ||||||
|     "editor.defaultFormatter": "esbenp.prettier-vscode" |  | ||||||
|   }, |  | ||||||
|   "[typescript]": { |  | ||||||
|     "editor.autoClosingBrackets": "always", |  | ||||||
|     "editor.defaultFormatter": "esbenp.prettier-vscode" |  | ||||||
|   }, |  | ||||||
|   "[javascript]": { |  | ||||||
|     "editor.autoClosingBrackets": "always", |  | ||||||
|     "editor.defaultFormatter": "esbenp.prettier-vscode" |  | ||||||
|   } |  | ||||||
| } | } | ||||||
|   | |||||||
| @@ -60,7 +60,7 @@ representative at an online or offline event. | |||||||
|  |  | ||||||
| Instances of abusive, harassing, or otherwise unacceptable behavior may be | Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||||||
| reported to the community leaders responsible for enforcement at | 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 complaints will be reviewed and investigated promptly and fairly. | ||||||
|  |  | ||||||
| All community leaders are obligated to respect the privacy and security of the | 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**! 🎉 | 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 | ## Types of contributions | ||||||
|  |  | ||||||
| - Reporting a bug. | - Reporting a bug. | ||||||
| @@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **html-w3c-validator**! 🎉 | |||||||
|  |  | ||||||
| ## Pull Requests | ## 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. | - Ensure your code respect linting. | ||||||
|  |  | ||||||
| @@ -21,26 +29,4 @@ If you're adding new features to **html-w3c-validator**, please include tests. | |||||||
|  |  | ||||||
| ## Commits | ## 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. | The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) 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. |  | ||||||
|   | |||||||
							
								
								
									
										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 | Permission is hereby granted, free of charge, to any person obtaining a copy | ||||||
| of this software and associated documentation files (the "Software"), to deal | of this software and associated documentation files (the "Software"), to deal | ||||||
|   | |||||||
							
								
								
									
										44
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										44
									
								
								README.md
									
									
									
									
									
								
							| @@ -1,19 +1,17 @@ | |||||||
| <h1 align="center">html-w3c-validator</h1> | <h1 align="center">html-w3c-validator</h1> | ||||||
|  |  | ||||||
| <p align="center"> | <p align="center"> | ||||||
|   <strong>CLI for validating multiple html pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong> |   <strong>CLI for validating HTML pages using <a href="https://validator.w3.org/">validator.w3.org</a>.</strong> | ||||||
| </p> |  | ||||||
|  |  | ||||||
| </p> | </p> | ||||||
|  |  | ||||||
| <p align="center"> | <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="./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> |   <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 /> |   <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/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/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/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/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/test.yml"><img src="https://github.com/theoludwig/html-w3c-validator/actions/workflows/test.yml/badge.svg?branch=develop" alt="Test" /></a> | ||||||
|   <br /> |   <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://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> |   <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 | ## 📜 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: **you should validate your production HTML** and this validation should be part of your CI/CD pipeline (tests, linting, etc.). | You might use a JavaScript framework or simply use HTML but **you should always validate your production HTML** and this validation should be part of your CI/CD pipeline (tests, linting, etc.). | ||||||
|  |  | ||||||
| ### Why should I validate my HTML pages? | ### Why 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): | 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 | ### 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)) | ### Installation (with [start-server-and-test](https://github.com/bahmutov/start-server-and-test)) | ||||||
|  |  | ||||||
| @@ -56,19 +54,28 @@ npm install --save-dev html-w3c-validator start-server-and-test | |||||||
| { | { | ||||||
|   "scripts": { |   "scripts": { | ||||||
|     // Command to start the server serving your HTML pages (e.g: using vercel/serve) |     // Command to start the server serving your HTML pages (e.g: using vercel/serve) | ||||||
|     "start": "serve ./build", |     "start": "serve \"./build\"", | ||||||
|  |  | ||||||
|     // Command to validate your HTML pages |     // Command to validate your HTML pages | ||||||
|     "test:html-w3c-validator": "start-server-and-test 'start' 'http://localhost:3000' 'html-w3c-validator'" |     "test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\"", | ||||||
|   } |   }, | ||||||
| } | } | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ### `.html-w3c-validatorrc.json` | ### `.html-w3c-validatorrc.json` | ||||||
|  |  | ||||||
| ```json | ```jsonc | ||||||
| { | { | ||||||
|   "urls": ["http://localhost:3000/", "http://localhost:3000/about"] |   "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/master/schema/html-w3c-validatorrc-schema.json", | ||||||
|  |  | ||||||
|  |   // 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"], | ||||||
| } | } | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| @@ -81,8 +88,8 @@ npm run test:html-w3c-validator | |||||||
| Example of output (in case of success): | Example of output (in case of success): | ||||||
|  |  | ||||||
| ```txt | ```txt | ||||||
| ✔ Validating http://localhost:3000/ | ✔ Validating http://127.0.0.1:3000/ | ||||||
| ✔ Validating http://localhost:3000/about | ✔ Validating http://127.0.0.1:3000/about | ||||||
|  |  | ||||||
| Success: HTML validation (W3C) passed! 🎉 | Success: HTML validation (W3C) passed! 🎉 | ||||||
| ``` | ``` | ||||||
| @@ -92,6 +99,7 @@ See the [./example](./example) folder for practical usage. | |||||||
| ### Options | ### Options | ||||||
|  |  | ||||||
| ```text | ```text | ||||||
|  | --current-working-directory <path>  The current working directory (default: `process.cwd()`). | ||||||
| -V, --version                       Output the version number. | -V, --version                       Output the version number. | ||||||
| -h, --help                          Display help for command. | -h, --help                          Display help for command. | ||||||
| ``` | ``` | ||||||
|   | |||||||
| @@ -1,3 +1,5 @@ | |||||||
| { | { | ||||||
|   "urls": ["http://localhost:3000/", "http://localhost:3000/about"] |   "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-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"> | <html lang="en"> | ||||||
|   <head> |   <head> | ||||||
|     <meta charset="UTF-8" /> |     <meta charset="UTF-8" /> | ||||||
|   | |||||||
| @@ -1,4 +1,4 @@ | |||||||
| <!DOCTYPE html> | <!doctype html> | ||||||
| <html lang="en"> | <html lang="en"> | ||||||
|   <head> |   <head> | ||||||
|     <meta charset="UTF-8" /> |     <meta charset="UTF-8" /> | ||||||
|   | |||||||
							
								
								
									
										28353
									
								
								example/package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										28353
									
								
								example/package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							| @@ -3,11 +3,11 @@ | |||||||
|   "private": true, |   "private": true, | ||||||
|   "scripts": { |   "scripts": { | ||||||
|     "start": "serve ./build", |     "start": "serve ./build", | ||||||
|     "test:html-w3c-validator": "start-server-and-test 'start' 'http://localhost:3000' 'html-w3c-validator'" |     "test:html-w3c-validator": "start-server-and-test \"start\" \"http://127.0.0.1:3000\" \"html-w3c-validator\"" | ||||||
|   }, |   }, | ||||||
|   "devDependencies": { |   "devDependencies": { | ||||||
|     "serve": "13.0.2", |     "serve": "14.2.3", | ||||||
|     "start-server-and-test": "1.14.0", |     "start-server-and-test": "2.0.3", | ||||||
|     "html-w3c-validator": "file:.." |     "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"] |  | ||||||
| } |  | ||||||
							
								
								
									
										32859
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										32859
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										110
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										110
									
								
								package.json
									
									
									
									
									
								
							| @@ -1,17 +1,20 @@ | |||||||
| { | { | ||||||
|   "name": "html-w3c-validator", |   "name": "html-w3c-validator", | ||||||
|   "version": "0.0.0-development", |   "version": "0.0.0-development", | ||||||
|   "description": "CLI for validating multiple html pages using validator.w3.org.", |   "description": "CLI for validating HTML pages using validator.w3.org.", | ||||||
|   "author": "Divlo <contact@divlo.fr>", |   "public": true, | ||||||
|  |   "types": "module", | ||||||
|  |   "type": "module", | ||||||
|  |   "author": "Théo LUDWIG <contact@theoludwig.fr>", | ||||||
|   "license": "MIT", |   "license": "MIT", | ||||||
|   "repository": { |   "repository": { | ||||||
|     "type": "git", |     "type": "git", | ||||||
|     "url": "https://github.com/Divlo/html-w3c-validator.git" |     "url": "https://github.com/theoludwig/html-w3c-validator.git" | ||||||
|   }, |   }, | ||||||
|   "bugs": { |   "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": [ |   "keywords": [ | ||||||
|     "cli", |     "cli", | ||||||
|     "html-validator", |     "html-validator", | ||||||
| @@ -20,68 +23,65 @@ | |||||||
|   ], |   ], | ||||||
|   "main": "build/index.js", |   "main": "build/index.js", | ||||||
|   "bin": "build/index.js", |   "bin": "build/index.js", | ||||||
|   "engines": { |  | ||||||
|     "node": ">=16.0.0", |  | ||||||
|     "npm": ">=8.0.0" |  | ||||||
|   }, |  | ||||||
|   "files": [ |   "files": [ | ||||||
|     "build" |     "build", | ||||||
|  |     "!**/*.test.js", | ||||||
|  |     "!**/*.map" | ||||||
|   ], |   ], | ||||||
|  |   "publishConfig": { | ||||||
|  |     "access": "public", | ||||||
|  |     "provenance": true | ||||||
|  |   }, | ||||||
|  |   "engines": { | ||||||
|  |     "node": ">=16.0.0" | ||||||
|  |   }, | ||||||
|   "scripts": { |   "scripts": { | ||||||
|     "build": "rimraf ./build && swc ./src --out-dir ./build && tsc", |     "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:commit": "commitlint", |     "lint:commit": "commitlint", | ||||||
|     "lint:editorconfig": "editorconfig-checker", |     "lint:editorconfig": "editorconfig-checker", | ||||||
|     "lint:markdown": "markdownlint '**/*.md' --dot --ignore node_modules", |     "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore", | ||||||
|     "lint:typescript": "eslint '**/*.{js,ts,jsx,tsx}'", |     "lint:prettier": "prettier . --check", | ||||||
|     "lint:prettier": "prettier '.' --check", |  | ||||||
|     "lint:staged": "lint-staged", |     "lint:staged": "lint-staged", | ||||||
|     "test": "jest", |     "test": "node --enable-source-maps --test", | ||||||
|     "release": "semantic-release", |     "release": "semantic-release", | ||||||
|     "postinstall": "husky install", |     "postinstall": "husky", | ||||||
|     "prepublishOnly": "pinst --disable", |     "prepublishOnly": "pinst --disable", | ||||||
|     "postpublish": "pinst --enable" |     "postpublish": "pinst --enable" | ||||||
|   }, |   }, | ||||||
|   "dependencies": { |   "dependencies": { | ||||||
|     "chalk": "4.1.2", |     "chalk": "5.3.0", | ||||||
|     "clipanion": "3.1.0", |     "clipanion": "3.2.1", | ||||||
|     "html-validator": "6.0.0", |     "log-symbols": "6.0.0", | ||||||
|     "ora": "5.4.1", |     "ora": "8.0.1", | ||||||
|     "read-pkg": "5.2.0", |     "read-pkg": "9.0.1", | ||||||
|     "table": "6.8.0" |     "table": "6.8.2" | ||||||
|   }, |   }, | ||||||
|   "devDependencies": { |   "devDependencies": { | ||||||
|     "@commitlint/cli": "16.0.1", |     "@commitlint/cli": "19.2.2", | ||||||
|     "@commitlint/config-conventional": "16.0.0", |     "@commitlint/config-conventional": "19.2.2", | ||||||
|     "@swc/cli": "0.1.55", |     "@swc/cli": "0.3.12", | ||||||
|     "@swc/core": "1.2.127", |     "@swc/core": "1.5.7", | ||||||
|     "@swc/jest": "0.2.15", |     "@tsconfig/strictest": "2.0.5", | ||||||
|     "@types/html-validator": "5.0.2", |     "@types/node": "20.12.12", | ||||||
|     "@types/jest": "27.4.0", |     "@types/sinon": "17.0.3", | ||||||
|     "@types/mock-fs": "4.13.1", |     "@typescript-eslint/eslint-plugin": "7.10.0", | ||||||
|     "@types/node": "17.0.8", |     "@typescript-eslint/parser": "7.10.0", | ||||||
|     "editorconfig-checker": "4.0.2", |     "editorconfig-checker": "5.1.5", | ||||||
|     "eslint": "7.32.0", |     "eslint": "8.57.0", | ||||||
|     "eslint-config-prettier": "8.3.0", |     "eslint-config-conventions": "14.2.0", | ||||||
|     "eslint-config-standard-with-typescript": "21.0.1", |     "eslint-plugin-import": "2.29.1", | ||||||
|     "eslint-plugin-import": "2.25.4", |     "eslint-plugin-promise": "6.1.1", | ||||||
|     "eslint-plugin-node": "11.1.0", |     "eslint-plugin-unicorn": "53.0.0", | ||||||
|     "eslint-plugin-prettier": "4.0.0", |     "execa": "9.1.0", | ||||||
|     "eslint-plugin-promise": "5.1.1", |     "husky": "9.0.11", | ||||||
|     "eslint-plugin-unicorn": "40.0.0", |     "lint-staged": "15.2.4", | ||||||
|     "execa": "5.1.1", |     "pinst": "3.0.0", | ||||||
|     "husky": "7.0.4", |     "prettier": "3.2.5", | ||||||
|     "jest": "27.4.7", |     "semantic-release": "23.1.1", | ||||||
|     "jest-mock-extended": "2.0.4", |     "serve": "14.2.3", | ||||||
|     "jest-ts-webcompat-resolver": "1.0.0", |     "sinon": "18.0.0", | ||||||
|     "lint-staged": "12.1.5", |     "typescript": "5.4.5" | ||||||
|     "markdownlint-cli": "0.30.0", |  | ||||||
|     "mock-fs": "5.1.2", |  | ||||||
|     "npm": "8.3.0", |  | ||||||
|     "pinst": "2.1.6", |  | ||||||
|     "prettier": "2.5.1", |  | ||||||
|     "rimraf": "3.0.2", |  | ||||||
|     "semantic-release": "18.0.1", |  | ||||||
|     "serve": "13.0.2", |  | ||||||
|     "typescript": "4.5.4" |  | ||||||
|   } |   } | ||||||
| } | } | ||||||
|   | |||||||
							
								
								
									
										50
									
								
								schema/html-w3c-validatorrc-schema.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										50
									
								
								schema/html-w3c-validatorrc-schema.json
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,50 @@ | |||||||
|  | { | ||||||
|  |   "$schema": "http://json-schema.org/draft-07/schema#", | ||||||
|  |   "$id": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/master/schema/html-w3c-validatorrc-schema.json", | ||||||
|  |   "title": "html-w3c-validator configuration schema", | ||||||
|  |   "type": "object", | ||||||
|  |   "properties": { | ||||||
|  |     "$schema": { | ||||||
|  |       "description": "JSON Schema URI", | ||||||
|  |       "type": "string", | ||||||
|  |       "format": "uri", | ||||||
|  |       "default": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/master/schema/html-w3c-validatorrc-schema.json" | ||||||
|  |     }, | ||||||
|  |     "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,114 +1,230 @@ | |||||||
| 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 chalk from 'chalk' | import { Command, Option } from "clipanion" | ||||||
| import ora from 'ora' | import logSymbols from "log-symbols" | ||||||
| import validateHTML, { ValidationMessageLocationObject } from 'html-validator' | import ora from "ora" | ||||||
| import { table } from 'table' | 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() | export const CONFIG_FILE_NAME = ".html-w3c-validatorrc.json" | ||||||
| const CONFIG_FILE_NAME = '.html-w3c-validatorrc.json' |  | ||||||
|  | export const SEVERITIES = ["error", "warning", "info"] as const | ||||||
|  |  | ||||||
|  | export type Severity = (typeof SEVERITIES)[number] | ||||||
|  |  | ||||||
| interface Config { | interface Config { | ||||||
|   urls: string[] |   urls?: string[] | ||||||
|  |   files?: string[] | ||||||
|  |   severities?: Severity[] | ||||||
| } | } | ||||||
|  |  | ||||||
| interface Error { | interface Error { | ||||||
|   url: string |   data: string | ||||||
|   messagesTable: string[][] |   messagesTable: string[][] | ||||||
| } | } | ||||||
|  |  | ||||||
| export class HTMLValidatorCommand extends Command { | interface Result { | ||||||
|   static usage = { |   data: string | ||||||
|     description: |   isSuccess: boolean | ||||||
|       'CLI for validating multiple html pages using <https://validator.w3.org/>.' |  | ||||||
| } | } | ||||||
|  |  | ||||||
|   async execute(): Promise<number> { | const printResults = (results: Result[]): void => { | ||||||
|     const configPath = path.join(CURRENT_DIRECTORY, CONFIG_FILE_NAME) |   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 override usage = { | ||||||
|  |     description: | ||||||
|  |       "CLI for validating HTML pages using <https://validator.w3.org/>.", | ||||||
|  |   } | ||||||
|  |  | ||||||
|  |   public currentWorkingDirectory = Option.String( | ||||||
|  |     "--current-working-directory", | ||||||
|  |     process.cwd(), | ||||||
|  |     { | ||||||
|  |       description: "The current working directory.", | ||||||
|  |       validator: typanion.isString(), | ||||||
|  |     }, | ||||||
|  |   ) | ||||||
|  |  | ||||||
|  |   public async execute(): Promise<number> { | ||||||
|  |     const configPath = path.join(this.currentWorkingDirectory, CONFIG_FILE_NAME) | ||||||
|     try { |     try { | ||||||
|       if (!(await isExistingPath(configPath))) { |       let configData: string | ||||||
|  |       try { | ||||||
|  |         configData = await fs.promises.readFile(configPath, { | ||||||
|  |           encoding: "utf-8", | ||||||
|  |         }) | ||||||
|  |       } catch (error) { | ||||||
|         throw new Error( |         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}".`, | ||||||
|         ) |         ) | ||||||
|       } |       } | ||||||
|  |       let config: Config = { urls: [], files: [] } | ||||||
|       const configData = await fs.promises.readFile(configPath, { |  | ||||||
|         encoding: 'utf-8' |  | ||||||
|       }) |  | ||||||
|       let config: Config = { urls: [] } |  | ||||||
|       let isValidConfig = true |  | ||||||
|       try { |       try { | ||||||
|         config = JSON.parse(configData) |         config = JSON.parse(configData) | ||||||
|       } catch { |       } catch { | ||||||
|         isValidConfig = false |  | ||||||
|       } |  | ||||||
|       isValidConfig = isValidConfig && Array.isArray(config.urls) |  | ||||||
|       if (!isValidConfig) { |  | ||||||
|         throw new Error( |         throw new Error( | ||||||
|           `Invalid config file at ${configPath}. Please check the syntax.` |           `Invalid config file at "${configPath}". Please check the 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 } | ||||||
|  |             }) | ||||||
|  |       const files = | ||||||
|  |         config.files == null | ||||||
|  |           ? [] | ||||||
|  |           : config.files.map((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[] = [] |       const errors: Error[] = [] | ||||||
|       let isValid = true |       let isValid = true | ||||||
|       for (const url of config.urls) { |       const loader = ora(`Validating HTML (W3C)...`).start() | ||||||
|         const loader = ora(`Validating ${url}`).start() |       const results: Result[] = [] | ||||||
|         const result = await validateHTML({ |       await Promise.all( | ||||||
|           url, |         dataToValidate.map(async ({ data, type }) => { | ||||||
|           format: 'json', |           try { | ||||||
|           isLocal: true |             let result: ValidateHTMLResult | undefined | ||||||
|  |             if (type === "url") { | ||||||
|  |               result = await validateHTML({ | ||||||
|  |                 htmlData: await getHTMLFromURL(data), | ||||||
|  |               }) | ||||||
|  |             } 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 (error) { | ||||||
|  |                 throw new Error( | ||||||
|  |                   `No file found at "${htmlPath}". Please check the path.`, | ||||||
|  |                 ) | ||||||
|  |               } | ||||||
|  |               result = await validateHTML({ | ||||||
|  |                 htmlData: html, | ||||||
|               }) |               }) | ||||||
|         const isValidHTML = result.messages.length === 0 |  | ||||||
|         if (isValidHTML) { |  | ||||||
|           loader.succeed() |  | ||||||
|             } else { |             } else { | ||||||
|           loader.fail() |               throw new Error("Invalid type") | ||||||
|  |             } | ||||||
|  |             const hasErrors = result.messages.some((message) => { | ||||||
|  |               return ( | ||||||
|  |                 severities.includes(message.type as Severity) || | ||||||
|  |                 severities.includes(message.subType as Severity) | ||||||
|  |               ) | ||||||
|  |             }) | ||||||
|  |             if (!hasErrors) { | ||||||
|  |               results.push({ data, isSuccess: true }) | ||||||
|  |             } else { | ||||||
|  |               results.push({ data, isSuccess: false }) | ||||||
|               const messagesTable: string[][] = [] |               const messagesTable: string[][] = [] | ||||||
|               for (const message of result.messages) { |               for (const message of result.messages) { | ||||||
|  |                 if ( | ||||||
|  |                   !severities.includes(message.type as Severity) && | ||||||
|  |                   !severities.includes(message.subType as Severity) | ||||||
|  |                 ) { | ||||||
|  |                   continue | ||||||
|  |                 } | ||||||
|  |  | ||||||
|                 const row: string[] = [] |                 const row: string[] = [] | ||||||
|             if (message.type === 'error') { |                 if (message.type === "info") { | ||||||
|               row.push(chalk.red(message.type)) |                   if (message.subType === "warning") { | ||||||
|  |                     row.push(chalk.yellow(message.subType)) | ||||||
|                   } else { |                   } else { | ||||||
|               row.push(chalk.yellow(message.type)) |                     row.push(chalk.blue(message.type)) | ||||||
|  |                   } | ||||||
|  |                 } else { | ||||||
|  |                   row.push(chalk.red(message.type)) | ||||||
|                 } |                 } | ||||||
|                 row.push(message.message) |                 row.push(message.message) | ||||||
|             const violation = message as ValidationMessageLocationObject |                 if (message.extract != null) { | ||||||
|             if (violation.extract != null) { |  | ||||||
|                   row.push( |                   row.push( | ||||||
|                 `line: ${violation.lastLine}, column: ${violation.firstColumn}-${violation.lastColumn}` |                     `line: ${message.lastLine}, column: ${message.firstColumn}-${message.lastColumn}`, | ||||||
|                   ) |                   ) | ||||||
|                 } |                 } | ||||||
|                 messagesTable.push(row) |                 messagesTable.push(row) | ||||||
|               } |               } | ||||||
|           errors.push({ url, messagesTable }) |               errors.push({ data, messagesTable }) | ||||||
|               isValid = false |               isValid = false | ||||||
|             } |             } | ||||||
|  |           } catch (error) { | ||||||
|  |             isValid = false | ||||||
|  |             if (error instanceof Error) { | ||||||
|  |               const messagesTable: string[][] = [[error.message]] | ||||||
|  |               errors.push({ data, messagesTable }) | ||||||
|             } |             } | ||||||
|  |           } | ||||||
|  |         }), | ||||||
|  |       ) | ||||||
|       if (!isValid) { |       if (!isValid) { | ||||||
|  |         loader.fail() | ||||||
|  |         printResults(results) | ||||||
|         for (const error of errors) { |         for (const error of errors) { | ||||||
|           console.error(`\n${error.url}`) |           console.error(`\n${error.data}`) | ||||||
|           console.error(table(error.messagesTable)) |           console.error(table(error.messagesTable)) | ||||||
|           console.error('------------------------------') |           console.error("------------------------------") | ||||||
|         } |         } | ||||||
|         console.error() |         console.error() | ||||||
|         throw new Error('HTML validation (W3C) failed!') |         throw new Error("HTML validation (W3C) failed!") | ||||||
|       } |       } | ||||||
|       console.log() |       loader.succeed( | ||||||
|       console.log( |         `${chalk.bold.green("Success:")} HTML validation (W3C) passed! 🎉`, | ||||||
|         `${chalk.bold.green('Success:')} HTML validation (W3C) passed! 🎉` |  | ||||||
|       ) |       ) | ||||||
|  |       printResults(results) | ||||||
|       return 0 |       return 0 | ||||||
|     } catch (error) { |     } catch (error) { | ||||||
|       if (error instanceof Error) { |       if (error instanceof Error) { | ||||||
|         console.error(`${chalk.bold.red('Error:')} ${error.message}`) |         console.error(`${chalk.bold.red("Error:")} ${error.message}`) | ||||||
|       } else { |       } else { | ||||||
|         console.error( |         console.error( | ||||||
|           `${chalk.bold.red('Error:')} HTML validation (W3C) failed!` |           `${chalk.bold.red("Error:")} HTML validation (W3C) failed!`, | ||||||
|         ) |         ) | ||||||
|       } |       } | ||||||
|       return 1 |       return 1 | ||||||
|   | |||||||
| @@ -1,26 +1,421 @@ | |||||||
| 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 { cli } from "../cli.js" | ||||||
| import { HTMLValidatorCommand } from '../HTMLValidatorCommand.js' | import { | ||||||
|  |   HTMLValidatorCommand, | ||||||
|  |   CONFIG_FILE_NAME, | ||||||
|  |   SEVERITIES, | ||||||
|  | } from "../HTMLValidatorCommand.js" | ||||||
|  |  | ||||||
| describe('html-w3c-validator', () => { | const FIXTURES_PATH = path.join(process.cwd(), "src", "__test__", "fixtures") | ||||||
|   afterEach(() => { |  | ||||||
|     jest.clearAllMocks() | await test("html-w3c-validator", async (t) => { | ||||||
|  |   t.afterEach(() => { | ||||||
|  |     sinon.restore() | ||||||
|   }) |   }) | ||||||
|  |  | ||||||
|   it('should be instance of the command', async () => { |   await t.test("should be instance of the command", async () => { | ||||||
|     const command = cli.process([]) |     const command = cli.process([]) | ||||||
|     expect(command).toBeInstanceOf(HTMLValidatorCommand) |     assert(command instanceof HTMLValidatorCommand) | ||||||
|   }) |   }) | ||||||
|  |  | ||||||
|   it('succeeds and validate the html correctly', async () => { |   await t.test( | ||||||
|     const examplePath = path.join(__dirname, '..', '..', 'example') |     "succeeds and validate the html correctly (example)", | ||||||
|     process.chdir(examplePath) |     async () => { | ||||||
|     await execa('rimraf', ['node_modules']) |       const exampleURL = new URL("../../example", import.meta.url) | ||||||
|     await execa('npm', ['install']) |       process.chdir(exampleURL.pathname) | ||||||
|     const { exitCode } = await execa('npm', ['run', 'test:html-w3c-validator']) |       await fs.promises.rm( | ||||||
|     expect(exitCode).toEqual(0) |         path.join(fileURLToPath(exampleURL), "node_modules"), | ||||||
|  |         { recursive: true, force: true }, | ||||||
|  |       ) | ||||||
|  |       await execa("npm", ["install"]) | ||||||
|  |       const { exitCode } = await execa("npm", [ | ||||||
|  |         "run", | ||||||
|  |         "test:html-w3c-validator", | ||||||
|  |       ]) | ||||||
|  |       assert.strictEqual(exitCode, 0) | ||||||
|  |     }, | ||||||
|  |   ) | ||||||
|  |  | ||||||
|  |   await t.test( | ||||||
|  |     "succeeds and validate the html correctly (example without working directory)", | ||||||
|  |     async () => { | ||||||
|  |       const logs: string[] = [] | ||||||
|  |       sinon.stub(console, "log").value((log: string) => { | ||||||
|  |         logs.push(log) | ||||||
|  |       }) | ||||||
|  |       const consoleLogSpy = sinon.spy(console, "log") | ||||||
|  |       const stream = new PassThrough() | ||||||
|  |       const exitCode = await cli.run([], { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }) | ||||||
|  |       stream.end() | ||||||
|  |       assert.strictEqual(exitCode, 0) | ||||||
|  |       assert.strictEqual( | ||||||
|  |         consoleLogSpy.calledWith( | ||||||
|  |           logSymbols.success, | ||||||
|  |           "./example/build/index.html", | ||||||
|  |         ), | ||||||
|  |         true, | ||||||
|  |         logs.join("\n"), | ||||||
|  |       ) | ||||||
|  |       assert.strictEqual( | ||||||
|  |         consoleLogSpy.calledWith( | ||||||
|  |           logSymbols.success, | ||||||
|  |           "./example/build/about.html", | ||||||
|  |         ), | ||||||
|  |         true, | ||||||
|  |         logs.join("\n"), | ||||||
|  |       ) | ||||||
|  |     }, | ||||||
|  |   ) | ||||||
|  |  | ||||||
|  |   await t.test( | ||||||
|  |     "succeeds and validate the html correctly (fixture)", | ||||||
|  |     async () => { | ||||||
|  |       const workingDirectory = path.join(FIXTURES_PATH, "success") | ||||||
|  |       const logs: string[] = [] | ||||||
|  |       sinon.stub(console, "log").value((log: string) => { | ||||||
|  |         logs.push(log) | ||||||
|  |       }) | ||||||
|  |       const consoleLogSpy = sinon.spy(console, "log") | ||||||
|  |       const stream = new PassThrough() | ||||||
|  |       const exitCode = await cli.run( | ||||||
|  |         [`--current-working-directory=${workingDirectory}`], | ||||||
|  |         { | ||||||
|  |           stdin: process.stdin, | ||||||
|  |           stdout: stream, | ||||||
|  |           stderr: stream, | ||||||
|  |         }, | ||||||
|  |       ) | ||||||
|  |       stream.end() | ||||||
|  |       assert.strictEqual(exitCode, 0) | ||||||
|  |       assert.strictEqual( | ||||||
|  |         consoleLogSpy.calledWith(logSymbols.success, "./build/index.html"), | ||||||
|  |         true, | ||||||
|  |         logs.join("\n"), | ||||||
|  |       ) | ||||||
|  |       assert.strictEqual( | ||||||
|  |         consoleLogSpy.calledWith(logSymbols.success, "./build/about.html"), | ||||||
|  |         true, | ||||||
|  |         logs.join("\n"), | ||||||
|  |       ) | ||||||
|  |     }, | ||||||
|  |   ) | ||||||
|  |  | ||||||
|  |   await t.test("fails with not found config", async () => { | ||||||
|  |     const workingDirectory = path.join(FIXTURES_PATH, "error-config-not-found") | ||||||
|  |     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME) | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + | ||||||
|  |           ` No config file found at ${configPath}. Please create "${CONFIG_FILE_NAME}".`, | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |   }) | ||||||
|  |  | ||||||
|  |   await t.test("fails with invalid JSON config", async () => { | ||||||
|  |     const workingDirectory = path.join( | ||||||
|  |       FIXTURES_PATH, | ||||||
|  |       "error-config-invalid-json", | ||||||
|  |     ) | ||||||
|  |     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME) | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + | ||||||
|  |           ` Invalid config file at "${configPath}". Please check the JSON syntax.`, | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |   }) | ||||||
|  |  | ||||||
|  |   await t.test("fails with invalid URLs config", async () => { | ||||||
|  |     const workingDirectory = path.join( | ||||||
|  |       FIXTURES_PATH, | ||||||
|  |       "error-config-invalid-urls", | ||||||
|  |     ) | ||||||
|  |     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME) | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + | ||||||
|  |           ` Invalid config file at "${configPath}". Please include an array of URLs.`, | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |   }) | ||||||
|  |  | ||||||
|  |   await t.test("fails with invalid files config", async () => { | ||||||
|  |     const workingDirectory = path.join( | ||||||
|  |       FIXTURES_PATH, | ||||||
|  |       "error-config-invalid-files", | ||||||
|  |     ) | ||||||
|  |     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME) | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + | ||||||
|  |           ` Invalid config file at "${configPath}". Please include an array of files.`, | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |   }) | ||||||
|  |  | ||||||
|  |   await t.test("fails with invalid files and urls config", async () => { | ||||||
|  |     const workingDirectory = path.join( | ||||||
|  |       FIXTURES_PATH, | ||||||
|  |       "error-config-invalid-files-and-urls", | ||||||
|  |     ) | ||||||
|  |     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME) | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + | ||||||
|  |           ` Invalid config file at "${configPath}". Please add URLs or files.`, | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |   }) | ||||||
|  |  | ||||||
|  |   await t.test("fails with invalid severities config", async () => { | ||||||
|  |     const workingDirectory = path.join( | ||||||
|  |       FIXTURES_PATH, | ||||||
|  |       "error-config-invalid-severities", | ||||||
|  |     ) | ||||||
|  |     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME) | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + | ||||||
|  |           ` Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join( | ||||||
|  |             ", ", | ||||||
|  |           )}).`, | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |   }) | ||||||
|  |  | ||||||
|  |   await t.test("fails with invalid empty severities config", async () => { | ||||||
|  |     const workingDirectory = path.join( | ||||||
|  |       FIXTURES_PATH, | ||||||
|  |       "error-config-invalid-severities-empty", | ||||||
|  |     ) | ||||||
|  |     const configPath = path.join(workingDirectory, CONFIG_FILE_NAME) | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + | ||||||
|  |           ` Invalid config file at "${configPath}". Please add valid severities (${SEVERITIES.join( | ||||||
|  |             ", ", | ||||||
|  |           )}).`, | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |   }) | ||||||
|  |  | ||||||
|  |   await t.test("fails with invalid files paths to check", async () => { | ||||||
|  |     const workingDirectory = path.join( | ||||||
|  |       FIXTURES_PATH, | ||||||
|  |       "error-invalid-files-paths-to-check", | ||||||
|  |     ) | ||||||
|  |     const htmlPath = path.resolve(workingDirectory, "index.html") | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     const messagesTable = [ | ||||||
|  |       [`No file found at "${htmlPath}". Please check the path.`], | ||||||
|  |     ] | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + " HTML validation (W3C) failed!", | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith(table(messagesTable)), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |   }) | ||||||
|  |  | ||||||
|  |   await t.test("fails with invalid W3C HTML", async () => { | ||||||
|  |     const workingDirectory = path.join(FIXTURES_PATH, "error-invalid-w3c-html") | ||||||
|  |     const errors: string[] = [] | ||||||
|  |     sinon.stub(console, "error").value((error: string) => { | ||||||
|  |       errors.push(error) | ||||||
|  |     }) | ||||||
|  |     const consoleErrorSpy = sinon.spy(console, "error") | ||||||
|  |     const stream = new PassThrough() | ||||||
|  |     const exitCode = await cli.run( | ||||||
|  |       [`--current-working-directory=${workingDirectory}`], | ||||||
|  |       { | ||||||
|  |         stdin: process.stdin, | ||||||
|  |         stdout: stream, | ||||||
|  |         stderr: stream, | ||||||
|  |       }, | ||||||
|  |     ) | ||||||
|  |     stream.end() | ||||||
|  |     assert.strictEqual(exitCode, 1) | ||||||
|  |     const messagesTable = [ | ||||||
|  |       [ | ||||||
|  |         chalk.yellow("warning"), | ||||||
|  |         "Consider adding a “lang” attribute to the “html” start tag to declare the language of this document.", | ||||||
|  |         "line: 2, column: 16-6", | ||||||
|  |       ], | ||||||
|  |     ] | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith( | ||||||
|  |         chalk.bold.red("Error:") + " HTML validation (W3C) failed!", | ||||||
|  |       ), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|  |     assert.strictEqual( | ||||||
|  |       consoleErrorSpy.calledWith(table(messagesTable)), | ||||||
|  |       true, | ||||||
|  |       errors.join("\n"), | ||||||
|  |     ) | ||||||
|   }) |   }) | ||||||
| }) | }) | ||||||
|   | |||||||
| @@ -0,0 +1,5 @@ | |||||||
|  | { | ||||||
|  |   "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json", | ||||||
|  |   "urls": [], | ||||||
|  |   "files": [] | ||||||
|  | } | ||||||
| @@ -0,0 +1,4 @@ | |||||||
|  | { | ||||||
|  |   "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json", | ||||||
|  |   "files": "Invalid" | ||||||
|  | } | ||||||
| @@ -0,0 +1 @@ | |||||||
|  | Invalid JSON | ||||||
| @@ -0,0 +1,5 @@ | |||||||
|  | { | ||||||
|  |   "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-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": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-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": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json", | ||||||
|  |   "urls": "Invalid" | ||||||
|  | } | ||||||
| @@ -0,0 +1,4 @@ | |||||||
|  | { | ||||||
|  |   "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-schema.json", | ||||||
|  |   "files": ["./index.html"] | ||||||
|  | } | ||||||
| @@ -0,0 +1,4 @@ | |||||||
|  | { | ||||||
|  |   "$schema": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-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> | ||||||
							
								
								
									
										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": "https://raw.githubusercontent.com/theoludwig/html-w3c-validator/develop/schema/html-w3c-validatorrc-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 { HTMLValidatorCommand } from "./HTMLValidatorCommand.js" | ||||||
| import readPackage from 'read-pkg' | import { packageJSON } from "./packageJSON.js" | ||||||
|  |  | ||||||
| import { HTMLValidatorCommand } from './HTMLValidatorCommand.js' |  | ||||||
|  |  | ||||||
| const packageJSON = readPackage.sync({ cwd: path.join(__dirname, '..') }) |  | ||||||
|  |  | ||||||
| export const cli = new Cli({ | export const cli = new Cli({ | ||||||
|   binaryLabel: packageJSON.name, |   binaryLabel: packageJSON.name, | ||||||
|   binaryName: packageJSON.name, |   binaryName: packageJSON.name, | ||||||
|   binaryVersion: packageJSON.version |   binaryVersion: packageJSON.version, | ||||||
| }) | }) | ||||||
| cli.register(Builtins.HelpCommand) | cli.register(Builtins.HelpCommand) | ||||||
| cli.register(Builtins.VersionCommand) | cli.register(Builtins.VersionCommand) | ||||||
|   | |||||||
							
								
								
									
										10
									
								
								src/index.ts
									
									
									
									
									
								
							
							
						
						
									
										10
									
								
								src/index.ts
									
									
									
									
									
								
							| @@ -1,12 +1,8 @@ | |||||||
| #!/usr/bin/env node | #!/usr/bin/env node | ||||||
| import chalk from 'chalk' | import { Cli } from "clipanion" | ||||||
| import { Cli } from 'clipanion' |  | ||||||
|  |  | ||||||
| import { cli } from './cli.js' | import { cli } from "./cli.js" | ||||||
|  |  | ||||||
| const [, , ...arguments_] = process.argv | const [, , ...arguments_] = process.argv | ||||||
|  |  | ||||||
| cli.runExit(arguments_, Cli.defaultContext).catch(() => { | await cli.runExit(arguments_, Cli.defaultContext) | ||||||
|   console.error(chalk.red('Error occurred...')) |  | ||||||
|   process.exit(1) |  | ||||||
| }) |  | ||||||
|   | |||||||
							
								
								
									
										5
									
								
								src/packageJSON.ts
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										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(async () => { |  | ||||||
|     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(`Failed to validate HTML`) | ||||||
|  |   } | ||||||
|  |   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": { |   "compilerOptions": { | ||||||
|     "target": "ESNext", |     "target": "ESNext", | ||||||
|     "module": "commonjs", |  | ||||||
|     "lib": ["ESNext"], |     "lib": ["ESNext"], | ||||||
|     "moduleResolution": "node", |     "module": "NodeNext", | ||||||
|  |     "moduleResolution": "NodeNext", | ||||||
|     "outDir": "./build", |     "outDir": "./build", | ||||||
|     "rootDir": "./src", |     "rootDir": "./src", | ||||||
|     "noEmit": true, |     "noEmit": true, | ||||||
|     "strict": true, |     "exactOptionalPropertyTypes": false, | ||||||
|     "skipLibCheck": true, |     "checkJs": false | ||||||
|     "esModuleInterop": true |  | ||||||
|   } |   } | ||||||
| } | } | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user