Skip to content

Commit e49f518

Browse files
authoredJan 15, 2025··
fix: don't wrap words in blockPackageJson description (#1874)
## 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. 💖
1 parent 3d651f2 commit e49f518

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed
 

‎src/next/blocks/blockPackageJson.test.ts

+13-10
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,19 @@ import { describe, expect, test } from "vitest";
44
import { blockPackageJson } from "./blockPackageJson.js";
55
import { optionsBase } from "./options.fakes.js";
66

7+
const options = {
8+
...optionsBase,
9+
description: `A very very very very very very very very very very very very very very very very long <em><code>HTML-ish</code> description</em> ending with an emoji. 🧵`,
10+
};
11+
712
describe("blockPackageJson", () => {
813
test("without addons or mode", () => {
9-
const creation = testBlock(blockPackageJson, {
10-
options: optionsBase,
11-
});
14+
const creation = testBlock(blockPackageJson, { options });
1215

1316
expect(creation).toMatchInlineSnapshot(`
1417
{
1518
"files": {
16-
"package.json": "{"name":"test-repository","version":"0.0.0","description":"Test description","repository":{"type":"git","url":"git+https://github.com/test-owner/test-repository.git"},"license":"MIT","author":{"email":"npm@email.com"},"type":"module","main":"lib/index.js","files":["README.md","package.json"]}",
19+
"package.json": "{"name":"test-repository","version":"0.0.0","description":"A very very very very very very very very very very very very very very very very long HTML-ish description ending with an emoji. 🧵","repository":{"type":"git","url":"git+https://github.com/test-owner/test-repository.git"},"license":"MIT","author":{"email":"npm@email.com"},"type":"module","main":"lib/index.js","files":["README.md","package.json"]}",
1720
},
1821
"scripts": [
1922
{
@@ -30,13 +33,13 @@ describe("blockPackageJson", () => {
3033
test("migration mode", () => {
3134
const creation = testBlock(blockPackageJson, {
3235
mode: "migrate",
33-
options: optionsBase,
36+
options,
3437
});
3538

3639
expect(creation).toMatchInlineSnapshot(`
3740
{
3841
"files": {
39-
"package.json": "{"name":"test-repository","version":"0.0.0","description":"Test description","repository":{"type":"git","url":"git+https://github.com/test-owner/test-repository.git"},"license":"MIT","author":{"email":"npm@email.com"},"type":"module","main":"lib/index.js","files":["README.md","package.json"]}",
42+
"package.json": "{"name":"test-repository","version":"0.0.0","description":"A very very very very very very very very very very very very very very very very long HTML-ish description ending with an emoji. 🧵","repository":{"type":"git","url":"git+https://github.com/test-owner/test-repository.git"},"license":"MIT","author":{"email":"npm@email.com"},"type":"module","main":"lib/index.js","files":["README.md","package.json"]}",
4043
},
4144
"scripts": [
4245
{
@@ -67,13 +70,13 @@ describe("blockPackageJson", () => {
6770
other: true,
6871
},
6972
},
70-
options: optionsBase,
73+
options,
7174
});
7275

7376
expect(creation).toMatchInlineSnapshot(`
7477
{
7578
"files": {
76-
"package.json": "{"name":"test-repository","version":"0.0.0","description":"Test description","repository":{"type":"git","url":"git+https://github.com/test-owner/test-repository.git"},"license":"MIT","author":{"email":"npm@email.com"},"type":"module","main":"lib/index.js","files":["README.md","package.json"],"dependencies":{"is-odd":"1.2.3"},"other":true}",
79+
"package.json": "{"name":"test-repository","version":"0.0.0","description":"A very very very very very very very very very very very very very very very very long HTML-ish description ending with an emoji. 🧵","repository":{"type":"git","url":"git+https://github.com/test-owner/test-repository.git"},"license":"MIT","author":{"email":"npm@email.com"},"type":"module","main":"lib/index.js","files":["README.md","package.json"],"dependencies":{"is-odd":"1.2.3"},"other":true}",
7780
},
7881
"scripts": [
7982
{
@@ -102,13 +105,13 @@ describe("blockPackageJson", () => {
102105
other: true,
103106
},
104107
},
105-
options: optionsBase,
108+
options,
106109
});
107110

108111
expect(creation).toMatchInlineSnapshot(`
109112
{
110113
"files": {
111-
"package.json": "{"name":"test-repository","version":"0.0.0","description":"Test description","repository":{"type":"git","url":"git+https://github.com/test-owner/test-repository.git"},"license":"MIT","author":{"email":"npm@email.com"},"type":"module","main":"lib/index.js","files":["README.md","package.json"],"dependencies":{"is-odd":"1.2.3"},"devDependencies":{"is-even":"4.5.6"},"other":true}",
114+
"package.json": "{"name":"test-repository","version":"0.0.0","description":"A very very very very very very very very very very very very very very very very long HTML-ish description ending with an emoji. 🧵","repository":{"type":"git","url":"git+https://github.com/test-owner/test-repository.git"},"license":"MIT","author":{"email":"npm@email.com"},"type":"module","main":"lib/index.js","files":["README.md","package.json"],"dependencies":{"is-odd":"1.2.3"},"devDependencies":{"is-even":"4.5.6"},"other":true}",
112115
},
113116
"scripts": [
114117
{

‎src/next/blocks/blockPackageJson.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ export const blockPackageJson = base.createBlock({
4545
...options.packageData?.devDependencies,
4646
...addons.properties.devDependencies,
4747
};
48-
const description = htmlToText.convert(options.description);
48+
const description = htmlToText.convert(options.description, {
49+
wordwrap: false,
50+
});
4951

5052
return {
5153
files: {

0 commit comments

Comments
 (0)
Please sign in to comment.