Closed
Description
Bug Report Checklist
- I have pulled the latest
main
branch of the repository. - I have searched for related issues and found none that matched my issue.
Overview
As of #1819 -> #1820, the description
option can be provided as HTML. Descriptions like:
ESLint plugin to granularly enforce TypeScript's <code>erasableSyntaxOnly</code> flag. ❎
...can be parsed nicely and turned into plain text for non-HTML locations such as package.json
.
A nice next step would be to additionally allow markdown descriptions:
ESLint plugin to granularly enforce TypeScript's `erasableSyntaxOnly` flag. ❎
Backticks like that are not yet supported.
Additional Info
Example of how I discovered this the hard way, forgetting it was HTML only: https://github.com/JoshuaKGoldberg/eslint-plugin-erasable-syntax-only/blob/9cdfa2583a9385656c09dba9e11d03a4c27e1ee0/README.md?plain=1#L4
💖