plone / plone/meta

Validate that template's markup is valid

Open
#153 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

04 type: enhancement 13 prio: normal 42 lvl: moderate
Dominant language
Python
Stars
6
Forks
7
Avg merge
2d 19h
Merged PRs (30d)
5

Description

There was a template with broken HTML, we should know that automatically, so we can fix that whenever that happens, i.e. a pre-commit hook 🎉

@petschki found out this: https://github.com/Lucas-C/pre-commit-hooks-lxml/tree/master/pre_commit_hooks we could create a pre-commit hook here in plone/meta or somewhere else in collective, the location is not that important, to validate that our template files are actually valid 💯

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the plone/meta configuration and the referenced pre-commit-hooks-lxml project to understand how a markup-validation hook could fit. Define done as automatically detecting invalid HTML in template files through a pre-commit hook, with the hook location and validation coverage agreed for this repository.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.