🚀 Feature: Allow description to safely include HTML tags #1819
Assignees
Labels
status: accepting prs
Please, send a pull request to resolve this!
type: feature
New enhancement or request
Comments
JoshuaKGoldberg
added
type: feature
3 tasks
JoshuaKGoldberg
added a commit
that referenced
this issue
Dec 31, 2024
## PR Checklist - [x] Addresses an existing open issue: fixes #1819 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/create-typescript-app/blob/main/.github/CONTRIBUTING.md) were taken ## Overview Uses [`html-to-text`](https://www.npmjs.com/package/html-to-text) to remove any HTML tags from descriptions. This ended up being a fun exploration of defaulting. As suggested in the issue, if the `README.md` has a CTA-style paragraph that strictly matches the `package.json` after removing HTML tags, then it's used. 💖
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Bug Report Checklist
mainbranch of the repository.Overview
I sometimes include HTML tags in the
README.mddisplays of repository descriptions. For example, in https://github.com/JoshuaKGoldberg/without-undefined-properties:package.json:"Copies an object without its undefined properties. 🫥"README.md:Copies an object without its <code>undefined</code> properties. 🫥I'll make it so that if a README.md includes the same description as
package.json-modulo HTML tags- then it will be allowed as-is.Additional Info
💖
The text was updated successfully, but these errors were encountered: