{"id":19380358,"url":"https://github.com/atata-framework/atata-cli-htmlvalidate","last_synced_at":"2025-07-30T17:42:15.400Z","repository":{"id":47895880,"uuid":"375625855","full_name":"atata-framework/atata-cli-htmlvalidate","owner":"atata-framework","description":"C#/.NET library that provides an API for html-validate NPM package","archived":false,"fork":false,"pushed_at":"2025-07-12T09:08:44.000Z","size":126,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-07-25T14:24:52.062Z","etag":null,"topics":["api","atata","cli","html-validate","html-validation"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atata-framework.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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,"zenodo":null},"funding":{"open_collective":"atata"}},"created_at":"2021-06-10T08:28:02.000Z","updated_at":"2025-07-12T09:08:48.000Z","dependencies_parsed_at":"2024-03-05T03:00:23.012Z","dependency_job_id":"29c4e200-17b7-406f-a0eb-59b20b3240da","html_url":"https://github.com/atata-framework/atata-cli-htmlvalidate","commit_stats":{"total_commits":90,"total_committers":1,"mean_commits":90.0,"dds":0.0,"last_synced_commit":"3ff7af50c5f14030e976ac850dd6d7c45460a062"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":"atata-framework/atata-repository-template","purl":"pkg:github/atata-framework/atata-cli-htmlvalidate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-htmlvalidate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-htmlvalidate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-htmlvalidate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-htmlvalidate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atata-framework","download_url":"https://codeload.github.com/atata-framework/atata-cli-htmlvalidate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atata-framework%2Fatata-cli-htmlvalidate/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267761753,"owners_count":24140487,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["api","atata","cli","html-validate","html-validation"],"created_at":"2024-11-10T09:13:43.812Z","updated_at":"2025-07-30T17:42:15.355Z","avatar_url":"https://github.com/atata-framework.png","language":"C#","funding_links":["https://opencollective.com/atata"],"categories":[],"sub_categories":[],"readme":"# Atata.Cli.HtmlValidate\n\n[![NuGet](http://img.shields.io/nuget/v/Atata.Cli.HtmlValidate.svg?style=flat)](https://www.nuget.org/packages/Atata.Cli.HtmlValidate/)\n[![GitHub release](https://img.shields.io/github/release/atata-framework/atata-cli-htmlvalidate.svg)](https://github.com/atata-framework/atata-cli-htmlvalidate/releases)\n[![Build status](https://dev.azure.com/atata-framework/atata-cli-htmlvalidate/_apis/build/status/atata-cli-htmlvalidate-ci?branchName=main)](https://dev.azure.com/atata-framework/atata-cli-htmlvalidate/_build/latest?definitionId=43\u0026branchName=main)\n[![Slack](https://img.shields.io/badge/join-Slack-green.svg?colorB=4EB898)](https://join.slack.com/t/atata-framework/shared_invite/zt-5j3lyln7-WD1ZtMDzXBhPm0yXLDBzbA)\n[![Atata docs](https://img.shields.io/badge/docs-Atata_Framework-orange.svg)](https://atata.io)\n[![X](https://img.shields.io/badge/follow-@AtataFramework-blue.svg)](https://x.com/AtataFramework)\n\n**Atata.Cli.HtmlValidate** is a C#/.NET library that provides an API for [html-validate](https://www.npmjs.com/package/html-validate) NPM package.\n\n*The package targets .NET Standard 2.0, which supports .NET 5+, .NET Framework 4.6.1+ and .NET Core/Standard 2.0+.*\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [HtmlValidateOptions Properties](#htmlvalidateoptions-properties)\n- [HtmlValidateResult Properties](#htmlvalidateresult-properties)\n- [Feedback](#feedback)\n- [Thanks](#thanks)\n- [SemVer](#semver)\n- [License](#license)\n\n## Features\n\nProvides C#/.NET API for [html-validate CLI](https://html-validate.org/usage/cli.html).\nCheck out \u003chttps://html-validate.org\u003e documentation for more info.\n\n## Installation\n\n### NuGet Package\n\nInstall [`Atata.Cli.HtmlValidate`](https://www.nuget.org/packages/Atata.Cli.HtmlValidate/) NuGet package.\n\n- Package Manager:\n  ```\n  Install-Package Atata.Cli.HtmlValidate\n  ```\n\n- .NET CLI:\n  ```\n  dotnet add package Atata.Cli.HtmlValidate\n  ```\n\n### NPM Package\n\nRequires [html-validate](https://www.npmjs.com/package/html-validate) NPM package to be installed.\n\n- Using NPM Command:\n  ```\n  npm install -g html-validate\n  ```\n- Using [Atata.Cli.Npm](https://www.nuget.org/packages/Atata.Cli.Npm/) .NET library:\n  ```cs\n  new NpmCli()\n      .InstallIfMissing(HtmlValidateCli.Name, global: true);\n  ```\n- Using its own `HtmlValidateCli` class:\n  ```cs\n  new HtmlValidateCli()\n      .RequireVersion(\"5.1.1\");\n  ```\n\n## Usage\n\nThe main class is `HtmlValidateCli` located in `Atata.Cli.HtmlValidate` namespace.\n\n### Validate HTML File\n\n```cs\nHtmlValidateResult result1 = HtmlValidateCli.InDirectory(\"some/dir\")\n    .Validate(\"testme.html\");\n```\n\n### Validate HTML File With Options\n\n```cs\nvar options = new HtmlValidateOptions\n{\n    Config = \"someconfig.json\",\n    Formatter = HtmlValidateFormatter.Codeframe(\"output.txt\")\n};\n\nHtmlValidateResult result3 = HtmlValidateCli.InDirectory(\"some/dir\")\n    .Validate(\"testme.html\", options);\n```\n\n### Validate HTML File Asynchronously\n\n```cs\nHtmlValidateResult result2 = await HtmlValidateCli.InDirectory(\"some/dir\")\n    .ValidateAsync(\"testme.html\");\n```\n\n## HtmlValidateOptions Properties\n\n- **`HtmlValidateFormatter Formatter { get; set; }`**\\\n  Gets or sets the formatter.\n- **`int? MaxWarnings { get; set; }`**\\\n  Gets or sets the maximum allowed warnings count.\n  The default value is `null`, which means that warnings are allowed.\n  Use `0` to disallow warnings.\n- **`string Config { get; set; }`**\\\n  Gets or sets the configuration file path (full or relative to CLI `WorkingDirectory`).\n- **`string[] Extensions { get; set; }`**\\\n  Gets or sets the file extensions to use when searching for files in directories.\n  For example: `\"html\"`, `\"vue\"`, etc.\n\n## HtmlValidateResult Properties\n\n- **`bool IsSuccessful { get; }`**\\\n  Gets a value indicating whether this result is successful.\n- **`string Output { get; }`**\\\n  Gets the text output of result.\n\n## Community\n\n- Slack: [https://atata-framework.slack.com](https://join.slack.com/t/atata-framework/shared_invite/zt-5j3lyln7-WD1ZtMDzXBhPm0yXLDBzbA)\n- X: https://x.com/AtataFramework\n- Stack Overflow: https://stackoverflow.com/questions/tagged/atata\n\n## Feedback\n\nAny feedback, issues and feature requests are welcome.\n\nIf you faced an issue please report it to [Atata.Cli.HtmlValidate Issues](https://github.com/atata-framework/atata-cli-htmlvalidate/issues),\n[ask a question on Stack Overflow](https://stackoverflow.com/questions/ask?tags=atata+csharp) using [atata](https://stackoverflow.com/questions/tagged/atata) tag\nor use another [Atata Contact](https://atata.io/contact/) way.\n\n## Contributing\n\nCheck out [Contributing Guidelines](CONTRIBUTING.md) for details.\n\n## Thanks\n\nThe library is implemented thanks to the sponsorship of **[Lombiq Technologies](https://lombiq.com/)**.\n\n## SemVer\n\nAtata Framework follows [Semantic Versioning 2.0](https://semver.org/).\nThus backward compatibility is followed and updates within the same major version\n(e.g. from 1.3 to 1.4) should not require code changes.\n\n## License\n\nAtata is an open source software, licensed under the Apache License 2.0.\nSee [LICENSE](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatata-framework%2Fatata-cli-htmlvalidate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatata-framework%2Fatata-cli-htmlvalidate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatata-framework%2Fatata-cli-htmlvalidate/lists"}