ndmitchell / ndmitchell/hlint

XHTML doctype in HTML reports, but not valid xml

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

Nobody has claimed this yet.

Dominant language
Haskell
Stars
1.6k
Forks
210
PR merge metrics
No merged PRs in 30d

Description

The html reports have xhtml doctype and a xhtml+xml content type, but the file is not valid xml. The reason is the < operator in the javascript code.

I suggest changing to a HMTL 5 doctype tag.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
 ...

Running the report through the w3c html validator (https://validator.w3.org/) also reports some other errors.

Contributor guide

No contributing guide indexed for this repository

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 locating the HTML report generator or template and inspect the JavaScript containing the < operator. Run a generated report through the W3C HTML validator and review the reported errors. Done means the report's doctype and content type match its actual format, with the noted validation problems addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, javascript
Domain
tooling, web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.