Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Add linting of HTML code #471

Open
2 tasks done
devtobi opened this issue Oct 31, 2024 · 1 comment
Open
2 tasks done

[Feature] Add linting of HTML code #471

devtobi opened this issue Oct 31, 2024 · 1 comment
Labels
Priority: Medium The issue contains work with medium priority. Template: Frontend Issues regarding the frontend template. Template: Webcomponent Issues regarding the webcomponent template. Type: Feature The issue is an feature

Comments

@devtobi
Copy link
Member

devtobi commented Oct 31, 2024

Relevant template

refarch-frontend, refarch-webcomponent

Problem description (optional)

Currently we only lint the <template> parts of Vue SFCs in terms of Vue related mechanisms, but we don't check if the is conform to HTML5 standards by the W3C itself.
Thats why we should include a linting tool to scan the HTML parts of our SFCs.

Desired solution

A npm-based solution to lint HTML files should be selected, properly configured and integrated into the lint script.
This allows us to write more clean, maintainable and accessible HTML code.

Considered alternatives (optional)

No response

Additional context (optional)

No response

No duplicate

  • I confirm that this issue is not a duplicate

Code of Conduct

  • I agree to follow this project's Code of Conduct

@devtobi devtobi added Template: Webcomponent Issues regarding the webcomponent template. Template: Frontend Issues regarding the frontend template. Type: Feature The issue is an feature Priority: Medium The issue contains work with medium priority. labels Oct 31, 2024
@devtobi
Copy link
Member Author

devtobi commented Oct 31, 2024

After a quick research I found the following tools:

I suggest to take a long at html-validate as it is the most active project and is almost equally popular in terms of npm downloads with htmlhint (see https://www.npmjs.com/package/html-validate and https://www.npmjs.com/package/htmlhint)

@devtobi devtobi moved this from Open to Accepted in it@M RefArch Templates Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Medium The issue contains work with medium priority. Template: Frontend Issues regarding the frontend template. Template: Webcomponent Issues regarding the webcomponent template. Type: Feature The issue is an feature
Projects
Status: Accepted
Development

No branches or pull requests

1 participant