{"id":24461333,"url":"https://github.com/frontend-layers/html-test","last_synced_at":"2025-03-14T09:44:17.067Z","repository":{"id":58463267,"uuid":"532008583","full_name":"Frontend-Layers/html-test","owner":"Frontend-Layers","description":"Node.js library for testing HTML files on the fly and output errors in the console with Gulp.js compatibilities","archived":false,"fork":false,"pushed_at":"2023-05-03T20:55:13.000Z","size":179,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-21T04:19:04.100Z","etag":null,"topics":["gulp","html","html-test","html-validation","html-validations","html5","nodejs","nodejs-modules","test","test-automation","validate","validation","w3c","w3c-validator"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Frontend-Layers.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-09-02T16:52:08.000Z","updated_at":"2023-05-10T18:07:17.000Z","dependencies_parsed_at":"2024-11-19T15:40:17.925Z","dependency_job_id":"77f1fdc3-1671-42ae-84a7-4fc9db82661d","html_url":"https://github.com/Frontend-Layers/html-test","commit_stats":null,"previous_names":["andreymatin/html-test"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-test","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-test/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-test/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Frontend-Layers%2Fhtml-test/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Frontend-Layers","download_url":"https://codeload.github.com/Frontend-Layers/html-test/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243558466,"owners_count":20310572,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gulp","html","html-test","html-validation","html-validations","html5","nodejs","nodejs-modules","test","test-automation","validate","validation","w3c","w3c-validator"],"created_at":"2025-01-21T04:18:58.485Z","updated_at":"2025-03-14T09:44:17.031Z","avatar_url":"https://github.com/Frontend-Layers.png","language":"HTML","readme":"# HTML Test\n\n_Node.js library for testing HTML files on the fly and output errors in the console with Gulp.js compatibilities_\n\n[![License:MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/andreymatin/html-test/LICENSE)\n[![npm](https://img.shields.io/npm/v/html-test.svg)](https://www.npmjs.com/package/html-test)\n\n\u003cimg src=https://raw.githubusercontent.com/andreymatin/html-test/main/screen.png alt=screenshot width=640\u003e\n\n## How to install\n\n### npm\n\n```shell\nnpm i --save-dev html-test\n```\n\n### yarn\n\n```shell\nyarn add --dev html-test\n```\n\n## How to use\n\n```javascript\nimport htmlTest from 'htmlTest';\n\nhtmlTest('./html/**/*.html');\n```\n\n```javascript\nimport htmlTest from 'htmlTest';\n\nhtmlTest('./html/**/*.html', { ignore: 'html/ignore-me/**' });\n```\n\n\n## Gulp.js integration\n\n```javascript\nimport gulp from 'gulp';\nconst { parallel, watch } = gulp;\n\nimport htmlTest from 'htmlTest';\n\nconst htmlTestRes = () =\u003e\n  htmlTest('./html/**/*.html', { ignore: ['html/ignore-me/**', 'node_modules/**'] });\n\nconst watcher = () =\u003e {\n  watch('./html/*.html', htmlTestRes);\n};\n\nexport default\n  parallel(\n    htmlTestRes,\n    watcher\n  )\n```\n\n## Config\n\n- first parameter - source folder\n- ignore - ignored folder/s\n- hide - hide errors for template expression/s - 'js-literals', 'handlebars' etc.\n\nfore exmaple:\n\n```javascript\nhtmlTest('./html/**/*.html', { ignore: ['html/ignore-me/**'], hide: ['js-literals']});\n```\n\n\n## Limitations\n\nAPI limitation is 5 remote requests by one time.\nTo extend it need to add iterations timeout.\nIt means validation will be processed with ignorance\nsome of the requests to avoid waiting delays or\nneed to select prioritized html files.\n\n## Recommendations\n\nIt's created for fast and rought in-development\nresults without boring test delays and information overflow.\nSo it shows critical errors only in a minimalistic way to console.\n\nFor full report with flexible configuration, I recommend:\n\n- automation by gulp.js - https://github.com/center-key/gulp-w3c-html-validator\n- https://validator.w3.org/\n\n## Reference\n\n- Markup Validator Web Service API (https://validator.w3.org/docs/api.html)\n\n## Related Projects\n\nI created this and some additional services for [html-base](https://www.npmjs.com/package/html-base) to improve quality of frontend output. Here is the list:\n\n- [scss-reset](https://www.npmjs.com/package/scss-reset)\n- [scss-mixins-npm](https://www.npmjs.com/package/scss-mixins-npm)\n- [mobile-friendly-test-npm](https://www.npmjs.com/package/mobile-friendly-test-npm)\n- [html-speed](https://www.npmjs.com/package/html-speed)\n- [css-test-npm](https://www.npmjs.com/package/css-test-npm)\n\n## Contributing\n\nFor issues, bugs or imporvements please open an [issue](https://github.com/andreymatin/html-test/issues/new)\n\n\n---\n[MIT License](LICENSE)","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontend-layers%2Fhtml-test","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrontend-layers%2Fhtml-test","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrontend-layers%2Fhtml-test/lists"}