microsoft / microsoft/tsdoc

tsdoc-html-tag-missing-equals erroneously flagging boolean attributes

Open
#367 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
5k
Forks
162
Avg merge
17h 24m
Merged PRs (30d)
8

Description

This valid html with a boolean attribute fails linting

<dialog open>
</dialog>

tsdoc-html-tag-missing-equals: The HTML element has an invalid attribute: Expecting "=" after HTML attribute name eslint(tsdoc/syntax)

And there seems to be no way to disable granular rules, #220.

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 with the TSDoc ESLint rule reported as tsdoc-html-tag-missing-equals and reproduce the diagnostic using the

example. Done means valid boolean HTML attributes no longer trigger the missing-equals error while attributes requiring values still do.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.