Skip to content

Commit ddf1318

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
fix: base suggested next steps on options (#906)
## PR Checklist - [x] Addresses an existing open issue: fixes #903 - [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 Pulls the logging of next steps (app(s) and/or token(s) to enable) into a dedicated `generateNextSteps` function, with unit tests. `outro` now allows a `variant` for each group, as this new logging isn't the preivously-always-gray code-style logging.
1 parent 6541f8e commit ddf1318

File tree

13 files changed

+344
-22
lines changed

13 files changed

+344
-22
lines changed

‎.eslintrc.cjs

+4
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ module.exports = {
8484
allowConstantLoopConditions: true,
8585
},
8686
],
87+
"@typescript-eslint/prefer-nullish-coalescing": [
88+
"error",
89+
{ ignorePrimitives: true },
90+
],
8791
},
8892
},
8993
{

‎cspell.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
"tada",
3333
"tsup",
3434
"Unstaged",
35-
"wontfix"
35+
"wontfix",
36+
"vitest"
3637
]
3738
}

‎src/create/index.ts

+5-10
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import chalk from "chalk";
44
import { ModeResult } from "../bin/mode.js";
55
import { outro } from "../shared/cli/outro.js";
66
import { StatusCodes } from "../shared/codes.js";
7+
import { generateNextSteps } from "../shared/generateNextSteps.js";
78
import { readOptions } from "../shared/options/readOptions.js";
89
import { runOrRestore } from "../shared/runOrRestore.js";
910
import { createAndEnterRepository } from "./createAndEnterRepository.js";
@@ -34,15 +35,11 @@ export async function create(args: string[]): Promise<ModeResult> {
3435
code: await runOrRestore({
3536
run: async () => {
3637
const { sentToGitHub } = await createWithOptions(inputs);
38+
const nextSteps = generateNextSteps(inputs.options);
3739

3840
outro(
3941
sentToGitHub
40-
? [
41-
{
42-
label:
43-
"Now all you have to do is populate the repository's ACCESS_TOKEN and NPM_TOKEN secrets, and enable the Codecov and Renovate GitHub apps.",
44-
},
45-
]
42+
? nextSteps
4643
: [
4744
{
4845
label:
@@ -59,11 +56,9 @@ export async function create(args: string[]): Promise<ModeResult> {
5956
`git commit -m "feat: initial commit ✨"`,
6057
`git push -u origin main`,
6158
],
59+
variant: "code",
6260
},
63-
{
64-
label:
65-
"If you do, be sure to populate its ACCESS_TOKEN and NPM_TOKEN secrets, and enable the Codecov and Renovate GitHub apps.",
66-
},
61+
...nextSteps,
6762
],
6863
);
6964
},

‎src/initialize/index.ts

+3-4
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { ModeRunner } from "../bin/mode.js";
22
import { outro } from "../shared/cli/outro.js";
33
import { StatusCodes } from "../shared/codes.js";
44
import { ensureGitRepository } from "../shared/ensureGitRepository.js";
5+
import { generateNextSteps } from "../shared/generateNextSteps.js";
56
import { readOptions } from "../shared/options/readOptions.js";
67
import { runOrRestore } from "../shared/runOrRestore.js";
78
import { initializeWithOptions } from "./initializeWithOptions.js";
@@ -31,11 +32,9 @@ export const initialize: ModeRunner = async (args) => {
3132
`git commit -m "feat: initialized repo ✨`,
3233
`git push`,
3334
],
35+
variant: "code",
3436
},
35-
{
36-
label:
37-
"Otherwise, all you have to do is populate the repository's ACCESS_TOKEN and NPM_TOKEN secrets, and enable the Codecov and Renovate GitHub apps.",
38-
},
37+
...generateNextSteps(inputs.options),
3938
]);
4039
},
4140
skipRestore: inputs.options.skipRestore,

‎src/migrate/index.ts

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import { ModeRunner } from "../bin/mode.js";
22
import { outro } from "../shared/cli/outro.js";
33
import { StatusCodes } from "../shared/codes.js";
44
import { ensureGitRepository } from "../shared/ensureGitRepository.js";
5+
import { generateNextSteps } from "../shared/generateNextSteps.js";
56
import { readOptions } from "../shared/options/readOptions.js";
67
import { runOrRestore } from "../shared/runOrRestore.js";
78
import { migrateWithOptions } from "./migrateWithOptions.js";
@@ -31,7 +32,9 @@ export const migrate: ModeRunner = async (args) => {
3132
`git commit -m "migrated repo to create-typescript-app ✨`,
3233
`git push`,
3334
],
35+
variant: "code",
3436
},
37+
...generateNextSteps(inputs.options),
3538
]);
3639
},
3740
skipRestore: inputs.options.skipRestore,

‎src/shared/__snapshots__/generateNextSteps.test.ts.snap

+183
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
2+
3+
exports[`generateNextSteps > {"excludeAllContributors":false,"excludeReleases":false,"excludeRenovate":false,"excludeTests":false} 1`] = `
4+
[
5+
{
6+
"label": "Be sure to:",
7+
"lines": [
8+
"- enable the GitHub apps:
9+
- Codecov (https://github.com/apps/codecov)
10+
- Renovate (https://github.com/apps/renovate)",
11+
"- populate the secrets:
12+
- ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
13+
- NPM_TOKEN (an npm access token with automation permissions)",
14+
],
15+
},
16+
]
17+
`;
18+
19+
exports[`generateNextSteps > {"excludeAllContributors":false,"excludeReleases":false,"excludeRenovate":false,"excludeTests":true} 1`] = `
20+
[
21+
{
22+
"label": "Be sure to:",
23+
"lines": [
24+
"- enable the Renovate GitHub app (https://github.com/apps/renovate).",
25+
"- populate the secrets:
26+
- ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
27+
- NPM_TOKEN (an npm access token with automation permissions)",
28+
],
29+
},
30+
]
31+
`;
32+
33+
exports[`generateNextSteps > {"excludeAllContributors":false,"excludeReleases":false,"excludeRenovate":true,"excludeTests":false} 1`] = `
34+
[
35+
{
36+
"label": "Be sure to:",
37+
"lines": [
38+
"- enable the Codecov GitHub app (https://github.com/apps/codecov).",
39+
"- populate the secrets:
40+
- ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
41+
- NPM_TOKEN (an npm access token with automation permissions)",
42+
],
43+
},
44+
]
45+
`;
46+
47+
exports[`generateNextSteps > {"excludeAllContributors":false,"excludeReleases":false,"excludeRenovate":true,"excludeTests":true} 1`] = `
48+
[
49+
{
50+
"label": "Be sure to populate the secrets:
51+
- ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
52+
- NPM_TOKEN (an npm access token with automation permissions)",
53+
},
54+
]
55+
`;
56+
57+
exports[`generateNextSteps > {"excludeAllContributors":false,"excludeReleases":true,"excludeRenovate":false,"excludeTests":false} 1`] = `
58+
[
59+
{
60+
"label": "Be sure to:",
61+
"lines": [
62+
"- enable the GitHub apps:
63+
- Codecov (https://github.com/apps/codecov)
64+
- Renovate (https://github.com/apps/renovate)",
65+
"- populate the ACCESS_TOKEN secret (a GitHub PAT with repo and workflow permissions).",
66+
],
67+
},
68+
]
69+
`;
70+
71+
exports[`generateNextSteps > {"excludeAllContributors":false,"excludeReleases":true,"excludeRenovate":false,"excludeTests":true} 1`] = `
72+
[
73+
{
74+
"label": "Be sure to:",
75+
"lines": [
76+
"- enable the Renovate GitHub app (https://github.com/apps/renovate).",
77+
"- populate the ACCESS_TOKEN secret (a GitHub PAT with repo and workflow permissions).",
78+
],
79+
},
80+
]
81+
`;
82+
83+
exports[`generateNextSteps > {"excludeAllContributors":false,"excludeReleases":true,"excludeRenovate":true,"excludeTests":false} 1`] = `
84+
[
85+
{
86+
"label": "Be sure to:",
87+
"lines": [
88+
"- enable the Codecov GitHub app (https://github.com/apps/codecov).",
89+
"- populate the ACCESS_TOKEN secret (a GitHub PAT with repo and workflow permissions).",
90+
],
91+
},
92+
]
93+
`;
94+
95+
exports[`generateNextSteps > {"excludeAllContributors":false,"excludeReleases":true,"excludeRenovate":true,"excludeTests":true} 1`] = `
96+
[
97+
{
98+
"label": "Be sure to populate the ACCESS_TOKEN secret (a GitHub PAT with repo and workflow permissions).",
99+
},
100+
]
101+
`;
102+
103+
exports[`generateNextSteps > {"excludeAllContributors":true,"excludeReleases":false,"excludeRenovate":false,"excludeTests":false} 1`] = `
104+
[
105+
{
106+
"label": "Be sure to:",
107+
"lines": [
108+
"- enable the GitHub apps:
109+
- Codecov (https://github.com/apps/codecov)
110+
- Renovate (https://github.com/apps/renovate)",
111+
"- populate the secrets:
112+
- ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
113+
- NPM_TOKEN (an npm access token with automation permissions)",
114+
],
115+
},
116+
]
117+
`;
118+
119+
exports[`generateNextSteps > {"excludeAllContributors":true,"excludeReleases":false,"excludeRenovate":false,"excludeTests":true} 1`] = `
120+
[
121+
{
122+
"label": "Be sure to:",
123+
"lines": [
124+
"- enable the Renovate GitHub app (https://github.com/apps/renovate).",
125+
"- populate the secrets:
126+
- ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
127+
- NPM_TOKEN (an npm access token with automation permissions)",
128+
],
129+
},
130+
]
131+
`;
132+
133+
exports[`generateNextSteps > {"excludeAllContributors":true,"excludeReleases":false,"excludeRenovate":true,"excludeTests":false} 1`] = `
134+
[
135+
{
136+
"label": "Be sure to:",
137+
"lines": [
138+
"- enable the Codecov GitHub app (https://github.com/apps/codecov).",
139+
"- populate the secrets:
140+
- ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
141+
- NPM_TOKEN (an npm access token with automation permissions)",
142+
],
143+
},
144+
]
145+
`;
146+
147+
exports[`generateNextSteps > {"excludeAllContributors":true,"excludeReleases":false,"excludeRenovate":true,"excludeTests":true} 1`] = `
148+
[
149+
{
150+
"label": "Be sure to populate the secrets:
151+
- ACCESS_TOKEN (a GitHub PAT with repo and workflow permissions)
152+
- NPM_TOKEN (an npm access token with automation permissions)",
153+
},
154+
]
155+
`;
156+
157+
exports[`generateNextSteps > {"excludeAllContributors":true,"excludeReleases":true,"excludeRenovate":false,"excludeTests":false} 1`] = `
158+
[
159+
{
160+
"label": "Be sure to enable the GitHub apps:
161+
- Codecov (https://github.com/apps/codecov)
162+
- Renovate (https://github.com/apps/renovate)",
163+
},
164+
]
165+
`;
166+
167+
exports[`generateNextSteps > {"excludeAllContributors":true,"excludeReleases":true,"excludeRenovate":false,"excludeTests":true} 1`] = `
168+
[
169+
{
170+
"label": "Be sure to enable the Renovate GitHub app (https://github.com/apps/renovate).",
171+
},
172+
]
173+
`;
174+
175+
exports[`generateNextSteps > {"excludeAllContributors":true,"excludeReleases":true,"excludeRenovate":true,"excludeTests":false} 1`] = `
176+
[
177+
{
178+
"label": "Be sure to enable the Codecov GitHub app (https://github.com/apps/codecov).",
179+
},
180+
]
181+
`;
182+
183+
exports[`generateNextSteps > {"excludeAllContributors":true,"excludeReleases":true,"excludeRenovate":true,"excludeTests":true} 1`] = `[]`;

‎src/shared/cli/outro.test.ts

+14
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,20 @@ describe("outro", () => {
3434
it("also logs lines when provided", () => {
3535
outro([{ label: "Abc 123", lines: ["one", "two"] }]);
3636

37+
expect(mockConsoleLog.mock.calls).toEqual([
38+
[chalk.blue("Abc 123")],
39+
[],
40+
["one"],
41+
["two"],
42+
[],
43+
[chalk.greenBright(`See ya! 👋`)],
44+
[],
45+
]);
46+
});
47+
48+
it("logs lines as code when variant is specified", () => {
49+
outro([{ label: "Abc 123", lines: ["one", "two"], variant: "code" }]);
50+
3751
expect(mockConsoleLog.mock.calls).toEqual([
3852
[chalk.blue("Abc 123")],
3953
[],

‎src/shared/cli/outro.ts

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
11
import * as prompts from "@clack/prompts";
22
import chalk from "chalk";
33

4-
export interface outroGroup {
4+
export interface OutroGroup {
55
label: string;
66
lines?: string[];
7+
variant?: "code";
78
}
89

9-
export function outro(groups: outroGroup[]) {
10+
export function outro(groups: OutroGroup[]) {
1011
prompts.outro(chalk.blue(`Great, looks like the script finished! 🎉`));
1112

12-
for (const { label, lines } of groups) {
13+
for (const { label, lines, variant } of groups) {
1314
console.log(chalk.blue(label));
1415
console.log();
1516

1617
if (lines) {
1718
for (const line of lines) {
18-
console.log(chalk.gray(line));
19+
console.log(variant === "code" ? chalk.gray(line) : line);
1920
}
2021

2122
console.log();

‎src/shared/generateNextSteps.test.ts

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
import { describe, expect, test } from "vitest";
2+
3+
import { generateNextSteps } from "./generateNextSteps.js";
4+
import { Options } from "./types.js";
5+
6+
const options = {
7+
access: "public",
8+
base: "everything",
9+
description: "Test description.",
10+
email: {
11+
github: "[email protected]",
12+
npm: "[email protected]",
13+
},
14+
logo: undefined,
15+
mode: "create",
16+
owner: "TestOwner",
17+
repository: "test-repository",
18+
title: "Test Title",
19+
} satisfies Options;
20+
21+
describe("generateNextSteps", () => {
22+
for (const excludeAllContributors of [false, true]) {
23+
for (const excludeReleases of [false, true]) {
24+
for (const excludeRenovate of [false, true]) {
25+
for (const excludeTests of [false, true]) {
26+
test(
27+
// eslint-disable-next-line vitest/valid-title
28+
JSON.stringify({
29+
excludeAllContributors,
30+
excludeReleases,
31+
excludeRenovate,
32+
excludeTests,
33+
}),
34+
() => {
35+
expect(
36+
generateNextSteps({
37+
...options,
38+
excludeAllContributors,
39+
excludeReleases,
40+
excludeRenovate,
41+
excludeTests,
42+
}),
43+
).toMatchSnapshot();
44+
},
45+
);
46+
}
47+
}
48+
}
49+
}
50+
});

0 commit comments

Comments
 (0)