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: Parse description as markdown (in addition to HTML) #1934

Closed
2 tasks done
JoshuaKGoldberg opened this issue Feb 15, 2025 · 3 comments · Fixed by #2132
Closed
2 tasks done

🚀 Feature: Parse description as markdown (in addition to HTML) #1934

JoshuaKGoldberg opened this issue Feb 15, 2025 · 3 comments · Fixed by #2132
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request

Comments

@JoshuaKGoldberg
Copy link
Owner

JoshuaKGoldberg commented Feb 15, 2025

Bug Report Checklist

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

💖

@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request labels Feb 15, 2025
@JoshuaKGoldberg JoshuaKGoldberg changed the title 🚀 Feature: Parse CLI description as markdown (in addition to HTML) 🚀 Feature: Parse description as markdown (in addition to HTML) Mar 28, 2025
@JoshuaKGoldberg
Copy link
Owner Author

Also seen in https://github.com/JoshuaKGoldberg/eslint-plugin-erasable-syntax-only/pull/51/files#r2019309343: if transitioning an existing repository, its README.md might have an HTML description to pull from.

@JoshuaKGoldberg
Copy link
Owner Author

JoshuaKGoldberg commented Apr 3, 2025

One last note, neither GitHub nor npm support backticks or other Markdown formatting in repository Abouts:

Screenshot of raw Markdown shown as plain text in a GitHub repo About: "ESLint plugin to granularly enforce TypeScript's erasableSyntaxOnly flag. ❎"

Screenshot of raw Markdown shown as plain text in an npm search result for eslint-plugin-erasable-syntax-only: "ESLint plugin to granularly enforce TypeScript's erasableSyntaxOnly flag. ❎"

Copy link

github-actions bot commented Apr 3, 2025

🎉 This is included in version v2.26.0 🎉

The release is available on:

Cheers! 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: accepting prs Please, send a pull request to resolve this! type: feature New enhancement or request
Projects
None yet
1 participant