Skip to content

Commit f64dba4

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
fix: normalize yaml outputs to always use -1 lineWidth (#2098)
## PR Checklist - [x] Addresses an existing open issue: fixes #2097 - [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 Whatever reason I had for having two different calls to `jsYaml.dump` is, I think, no longer there. This normalizes all YAML printing to go through the standard `formatYaml`. YAML files now always have a blank line between root-level properties. 🎁
1 parent 25e9a51 commit f64dba4

12 files changed

+73
-22
lines changed

‎.github/ISSUE_TEMPLATE/01-bug.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,12 @@ body:
2626
description: Any additional info you'd like to provide.
2727
label: Additional Info
2828
type: textarea
29+
2930
description: Report a bug trying to run the code
31+
3032
labels:
3133
- "type: bug"
34+
3235
name: 🐛 Bug
36+
3337
title: "🐛 Bug: <short description of the bug>"

‎.github/ISSUE_TEMPLATE/02-documentation.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,12 @@ body:
1818
description: Any additional info you'd like to provide.
1919
label: Additional Info
2020
type: textarea
21+
2122
description: Report a typo or missing area of documentation
23+
2224
labels:
2325
- "area: documentation"
26+
2427
name: 📝 Documentation
28+
2529
title: "📝 Documentation: <short description of the request>"

‎.github/ISSUE_TEMPLATE/03-feature.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,12 @@ body:
1818
description: Any additional info you'd like to provide.
1919
label: Additional Info
2020
type: textarea
21+
2122
description: Request that a new feature be added or an existing feature improved
23+
2224
labels:
2325
- "type: feature"
26+
2427
name: 🚀 Feature
28+
2529
title: "🚀 Feature: <short description of the feature>"

‎.github/ISSUE_TEMPLATE/04-tooling.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ body:
2020
description: Any additional info you'd like to provide.
2121
label: Additional Info
2222
type: textarea
23+
2324
description: Report a bug or request an enhancement in repository tooling
25+
2426
labels:
2527
- "area: tooling"
28+
2629
name: 🛠 Tooling
30+
2731
title: "🛠 Tooling: <short description of the change>"

‎src/blocks/blockAllContributors.test.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,10 @@ describe("blockAllContributors", () => {
6868
GITHUB_TOKEN: \${{ secrets.ACCESS_TOKEN }}
6969
uses: JoshuaKGoldberg/[email protected]
7070
71+
7172
name: Contributors
7273
74+
7375
on:
7476
push:
7577
branches:
@@ -187,8 +189,10 @@ describe("blockAllContributors", () => {
187189
GITHUB_TOKEN: \${{ secrets.ACCESS_TOKEN }}
188190
uses: JoshuaKGoldberg/[email protected]
189191
192+
190193
name: Contributors
191194
195+
192196
on:
193197
push:
194198
branches:
@@ -305,8 +309,10 @@ describe("blockAllContributors", () => {
305309
GITHUB_TOKEN: \${{ secrets.ACCESS_TOKEN }}
306310
uses: JoshuaKGoldberg/[email protected]
307311
312+
308313
name: Contributors
309314
315+
310316
on:
311317
push:
312318
branches:

‎src/blocks/blockCTATransitions.test.ts

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,15 @@ describe("blockCTATransitions", () => {
5050
uses: mshick/add-pr-comment@v2
5151
with:
5252
issue: \${{ github.event.pull_request.number }}
53-
message: >-
54-
🤖 Beep boop! I ran \`npx create-typescript-app\` and it updated some
55-
files.
53+
message: |-
54+
🤖 Beep boop! I ran \`npx create-typescript-app\` and it updated some files.
5655
57-
I went ahead and checked those changes into this PR for you. Please
58-
review the latest commit to see if you want to merge it.
56+
I went ahead and checked those changes into this PR for you. Please review the latest commit to see if you want to merge it.
5957
6058
Cheers!
6159
— _The Friendly Bingo Bot_ 💝
6260
63-
> ℹ️ These automatic commits keep your repository up-to-date with new
64-
versions of
65-
[create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).
66-
If you want to opt out, delete your
67-
\`.github/workflows/cta-transitions.yml\` file.
61+
> ℹ️ These automatic commits keep your repository up-to-date with new versions of [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app). If you want to opt out, delete your \`.github/workflows/cta-transitions.yml\` file.
6862
using: composite
6963
",
7064
},
@@ -87,13 +81,16 @@ describe("blockCTATransitions", () => {
8781
- if: steps.check.outcome == 'skipped'
8882
run: echo 'Skipping transition mode because the PR does not appear to be an automated or owner-created update to create-typescript-app.'
8983
84+
9085
name: CTA
9186
87+
9288
on:
9389
pull_request:
9490
branches:
9591
- main
9692
93+
9794
permissions:
9895
pull-requests: write
9996
",

‎src/blocks/blockCTATransitions.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { resolveUses } from "./actions/resolveUses.js";
44
import { blockPackageJson } from "./blockPackageJson.js";
55
import { blockRepositoryBranchRuleset } from "./blockRepositoryBranchRuleset.js";
66
import { createSoloWorkflowFile } from "./files/createSoloWorkflowFile.js";
7-
import { formatYamlAction } from "./files/formatYamlAction.js";
7+
import { formatYaml } from "./files/formatYaml.js";
88

99
export const blockCTATransitions = base.createBlock({
1010
about: {
@@ -28,7 +28,7 @@ export const blockCTATransitions = base.createBlock({
2828
".github": {
2929
actions: {
3030
transition: {
31-
"action.yml": formatYamlAction({
31+
"action.yml": formatYaml({
3232
description: "Runs create-typescript-app in transition mode",
3333
name: "Transition",
3434
runs: {
@@ -65,7 +65,9 @@ export const blockCTATransitions = base.createBlock({
6565
issue: "${{ github.event.pull_request.number }}",
6666
message: [
6767
"🤖 Beep boop! I ran `npx create-typescript-app` and it updated some files.",
68+
"",
6869
"I went ahead and checked those changes into this PR for you. Please review the latest commit to see if you want to merge it.",
70+
"",
6971
"Cheers!",
7072
" — _The Friendly Bingo Bot_ 💝",
7173
"",

‎src/blocks/blockGitHubActionsCI.test.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,10 @@ describe("blockGitHubActionsCI", () => {
4949
steps:
5050
- uses: github/[email protected]
5151
52+
5253
name: Accessibility Alt Text Bot
5354
55+
5456
on:
5557
issue_comment:
5658
types:
@@ -65,6 +67,7 @@ describe("blockGitHubActionsCI", () => {
6567
- edited
6668
- opened
6769
70+
6871
permissions:
6972
issues: write
7073
pull-requests: write
@@ -82,13 +85,16 @@ describe("blockGitHubActionsCI", () => {
8285
echo "Don't worry if the previous step failed."
8386
echo "See https://github.com/actions-ecosystem/action-remove-labels/issues/221."
8487
88+
8589
name: PR Review Requested
8690
91+
8792
on:
8893
pull_request_target:
8994
types:
9095
- review_requested
9196
97+
9298
permissions:
9399
pull-requests: write
94100
",
@@ -153,8 +159,10 @@ describe("blockGitHubActionsCI", () => {
153159
steps:
154160
- uses: github/[email protected]
155161
162+
156163
name: Accessibility Alt Text Bot
157164
165+
158166
on:
159167
issue_comment:
160168
types:
@@ -169,6 +177,7 @@ describe("blockGitHubActionsCI", () => {
169177
- edited
170178
- opened
171179
180+
172181
permissions:
173182
issues: write
174183
pull-requests: write
@@ -186,13 +195,16 @@ describe("blockGitHubActionsCI", () => {
186195
echo "Don't worry if the previous step failed."
187196
echo "See https://github.com/actions-ecosystem/action-remove-labels/issues/221."
188197
198+
189199
name: PR Review Requested
190200
201+
191202
on:
192203
pull_request_target:
193204
types:
194205
- review_requested
195206
207+
196208
permissions:
197209
pull-requests: write
198210
",
@@ -264,8 +276,10 @@ describe("blockGitHubActionsCI", () => {
264276
steps:
265277
- uses: github/[email protected]
266278
279+
267280
name: Accessibility Alt Text Bot
268281
282+
269283
on:
270284
issue_comment:
271285
types:
@@ -280,6 +294,7 @@ describe("blockGitHubActionsCI", () => {
280294
- edited
281295
- opened
282296
297+
283298
permissions:
284299
issues: write
285300
pull-requests: write
@@ -298,8 +313,10 @@ describe("blockGitHubActionsCI", () => {
298313
with:
299314
VAR_WITH: 'true'
300315
316+
301317
name: CI
302318
319+
303320
on:
304321
pull_request: ~
305322
push:
@@ -318,13 +335,16 @@ describe("blockGitHubActionsCI", () => {
318335
echo "Don't worry if the previous step failed."
319336
echo "See https://github.com/actions-ecosystem/action-remove-labels/issues/221."
320337
338+
321339
name: PR Review Requested
322340
341+
323342
on:
324343
pull_request_target:
325344
types:
326345
- review_requested
327346
347+
328348
permissions:
329349
pull-requests: write
330350
",

‎src/blocks/blockGitHubActionsCI.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { blockRemoveFiles } from "./blockRemoveFiles.js";
66
import { blockRepositoryBranchRuleset } from "./blockRepositoryBranchRuleset.js";
77
import { createMultiWorkflowFile } from "./files/createMultiWorkflowFile.js";
88
import { createSoloWorkflowFile } from "./files/createSoloWorkflowFile.js";
9-
import { formatYamlAction } from "./files/formatYamlAction.js";
9+
import { formatYaml } from "./files/formatYaml.js";
1010

1111
export const zActionStep = z.intersection(
1212
z.object({
@@ -46,7 +46,7 @@ export const blockGitHubActionsCI = base.createBlock({
4646
".github": {
4747
actions: {
4848
prepare: {
49-
"action.yml": formatYamlAction({
49+
"action.yml": formatYaml({
5050
description: "Prepares the repo for a typical CI job",
5151
name: "Prepare",
5252
runs: {

‎src/blocks/blockReleaseIt.test.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,24 @@ describe("blockReleaseIt", () => {
8888
8989
Cheers! 📦🚀
9090
91+
9192
name: Post Release
9293
94+
9395
on:
9496
release:
9597
types:
9698
- published
9799
100+
98101
permissions:
99102
issues: write
100103
pull-requests: write
101104
",
102105
"release.yml": "concurrency:
103106
group: \${{ github.workflow }}
104107
108+
105109
jobs:
106110
release:
107111
runs-on: ubuntu-latest
@@ -117,13 +121,16 @@ describe("blockReleaseIt", () => {
117121
NPM_TOKEN: \${{ secrets.NPM_TOKEN }}
118122
uses: JoshuaKGoldberg/[email protected]
119123
124+
120125
name: Release
121126
127+
122128
on:
123129
push:
124130
branches:
125131
- main
126132
133+
127134
permissions:
128135
contents: write
129136
id-token: write
@@ -237,20 +244,24 @@ describe("blockReleaseIt", () => {
237244
238245
Cheers! 📦🚀
239246
247+
240248
name: Post Release
241249
250+
242251
on:
243252
release:
244253
types:
245254
- published
246255
256+
247257
permissions:
248258
issues: write
249259
pull-requests: write
250260
",
251261
"release.yml": "concurrency:
252262
group: \${{ github.workflow }}
253263
264+
254265
jobs:
255266
release:
256267
runs-on: ubuntu-latest
@@ -269,13 +280,16 @@ describe("blockReleaseIt", () => {
269280
NPM_TOKEN: \${{ secrets.NPM_TOKEN }}
270281
uses: JoshuaKGoldberg/[email protected]
271282
283+
272284
name: Release
273285
286+
274287
on:
275288
push:
276289
branches:
277290
- main
278291
292+
279293
permissions:
280294
contents: write
281295
id-token: write

‎src/blocks/files/formatYaml.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,8 @@ const options: jsYaml.DumpOptions = {
2323
};
2424

2525
export function formatYaml(value: unknown) {
26-
return removeUsesQuotes(jsYaml.dump(value, options));
26+
return removeUsesQuotes(jsYaml.dump(value, options)).replaceAll(
27+
/\n(\S)/g,
28+
"\n\n$1",
29+
);
2730
}

‎src/blocks/files/formatYamlAction.ts

Lines changed: 0 additions & 7 deletions
This file was deleted.

0 commit comments

Comments
 (0)