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

🐛 Bug: Use wordwrap: false in blockPackageJson description conversion #1873

Closed
3 tasks done
JoshuaKGoldberg opened this issue Jan 15, 2025 · 0 comments · Fixed by #1874
Closed
3 tasks done

🐛 Bug: Use wordwrap: false in blockPackageJson description conversion #1873

JoshuaKGoldberg opened this issue Jan 15, 2025 · 0 comments · Fixed by #1874
Assignees
Labels
status: accepting prs Please, send a pull request to resolve this! type: bug Something isn't working :(

Comments

@JoshuaKGoldberg
Copy link
Owner

Bug Report Checklist

  • I have tried restarting my IDE and the issue persists.
  • I have pulled the latest main branch of the repository.
  • I have searched for related issues and found none that matched my issue.

Expected

blockPackageJson converts options.description from potentially HTML to plain text for printing in the package.json. This should not wrap across lines - it should be on one line.

Actual

wordwrap defaults to true, so this does wrap words:

const description = htmlToText.convert(options.description);

I see a \n added in there for long descriptions.

Additional Info

Prototyped in #1839.

💖

@JoshuaKGoldberg JoshuaKGoldberg added type: bug Something isn't working :( status: accepting prs Please, send a pull request to resolve this! labels Jan 15, 2025
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Jan 15, 2025
JoshuaKGoldberg added a commit that referenced this issue Jan 15, 2025
## PR Checklist

- [x] Addresses an existing open issue: fixes #1873
- [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

2af8204 shows the `\n` in the test.

💖
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: bug Something isn't working :(
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant