Skip to content

Commit c4025fa

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
fix: skip replacing existing tooling in --mode migrate (#1223)
## PR Checklist - [x] Addresses an existing open issue: fixes #1220 - [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 Gates those elements of `replacements` behind `options.mode` not being `"migrate"`. Which means the end-to-end migration snapshot for `.github/DEVELOPMENT.md` no longer shows removing `## Setup Scripts`! Yay!
1 parent 5cd4a95 commit c4025fa

File tree

4 files changed

+106
-68
lines changed

4 files changed

+106
-68
lines changed

‎script/__snapshots__/migrate-test-e2e.js.snap

+2-36
Original file line numberDiff line numberDiff line change
@@ -101,43 +101,9 @@ exports[`expected file changes > README.md 1`] = `
101101
-\`create-typescript-app\` is a one-stop-shop solution to set up a new or existing repository with the latest and greatest TypeScript tooling.
102102
-It includes options not just for building and testing but also GitHub repository templates, contributor recognition, automated release management, and more.
103103
-
104-
-## Getting Started
105-
-
106-
-First make sure you have the following installed:
107-
-
108-
-- [GitHub CLI](https://cli.github.com) _(you'll need to be logged in)_
109-
-- [Node.js](https://nodejs.org)
110-
-- [pnpm](https://pnpm.io)
111-
-
112-
-Then in an existing repository or in your directory where you'd like to make a new repository:
113-
-
114-
-\`\`\`shell
115-
-npx create-typescript-app
116-
-\`\`\`
117-
-
118-
-That setup script will walk you through using the template.
119-
-You can read more about the supported setup modes in their docs pages:
120-
-
121-
-- [**Creating from the terminal**](./docs/Creation.md): creating a new repository locally on the command-line _(recommended)_
122-
-- [**Initializing from the template**](./docs/Initialization.md): creating a new repository with the [_Use this template_](https://github.com/JoshuaKGoldberg/create-typescript-app/generate) button on GitHub
123-
-- [**Migrating an existing repository**](./docs/Migration.md): adding this template's tooling on top of an existing repository
124-
-
125-
-## Documentation
126-
-
127-
-You can read more about \`create-typescript-app\` and the tooling it supports:
128-
-
129-
-1. [**Tooling**](./docs/Tooling.md): a breakdown of all the pieces this template can set up.
130-
-2. [**Options**](./docs/Options.md): granular options to customize how the template is run.
131-
-3. [**FAQs**](./docs/FAQs.md): frequently asked questions
132-
-
133-
-> [!NOTE]
134-
-> This template is early stage, opinionated, and not endorsed by the TypeScript team.
135-
-> It can be configured to set up a _lot_ of tooling out of the box.
136-
-> If you don't want to use any particular tool, you can always remove it manually.
137-
-
138-
## Development
104+
## Getting Started
139105
140-
See [\`.github/CONTRIBUTING.md\`](./.github/CONTRIBUTING.md), then [\`.github/DEVELOPMENT.md\`](./.github/DEVELOPMENT.md).
106+
First make sure you have the following installed:
141107
@@ ... @@ Thanks! 💖
142108
143109
<!-- ALL-CONTRIBUTORS-LIST:END -->

‎script/migrate-test-e2e.js

-12
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,6 @@ const logoAlt = `Project logo: the TypeScript blue square with rounded corners,
3737
const owner = "JoshuaKGoldberg";
3838
const title = "Create TypeScript App";
3939

40-
const originalDevelopment = (
41-
await fs.readFile(".github/DEVELOPMENT.md")
42-
).toString();
43-
4440
const originalReadme = (await fs.readFile("README.md")).toString();
4541

4642
const originalSnapshots = (
@@ -61,14 +57,6 @@ await fs.writeFile(
6157
) + "\n",
6258
);
6359

64-
// The development setup scripts docs can be ignored from snapshots.
65-
// We manually add them back after hydration to clear them from Git diffs.
66-
await fs.appendFile(
67-
".github/DEVELOPMENT.md",
68-
"\n" +
69-
originalDevelopment.slice(originalDevelopment.indexOf("## Setup Scripts")),
70-
);
71-
7260
// Ignore changes to the README.md all-contributor count and contributors table...
7361
const updatedReadme = (await fs.readFile("README.md")).toString();
7462
await fs.writeFile(

‎src/steps/updateLocalFiles.test.ts

+70
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,75 @@ describe("updateLocalFiles", () => {
383383
`);
384384
});
385385

386+
it("doesn't remove existing tooling when mode is migrate", async () => {
387+
mockReadFileSafeAsJson.mockResolvedValue({});
388+
mockReplaceInFile.mockResolvedValue([]);
389+
390+
await updateLocalFiles({ ...options, mode: "migrate" });
391+
392+
expect(mockReplaceInFile.mock.calls).toMatchInlineSnapshot(`
393+
[
394+
[
395+
{
396+
"allowEmptyPaths": true,
397+
"files": [
398+
"./.github/**/*",
399+
"./*.*",
400+
],
401+
"from": /Create TypeScript App/g,
402+
"to": "Stub Title",
403+
},
404+
],
405+
[
406+
{
407+
"allowEmptyPaths": true,
408+
"files": [
409+
"./.github/**/*",
410+
"./*.*",
411+
],
412+
"from": /JoshuaKGoldberg\\(\\?:\\\\/\\(\\.\\+\\)\\)\\?/g,
413+
"to": [Function],
414+
},
415+
],
416+
[
417+
{
418+
"allowEmptyPaths": true,
419+
"files": "package.json",
420+
"from": /JoshuaKGoldberg/g,
421+
"to": "StubOwner",
422+
},
423+
],
424+
[
425+
{
426+
"allowEmptyPaths": true,
427+
"files": [
428+
"./.github/**/*",
429+
"./*.*",
430+
],
431+
"from": /create-typescript-app/g,
432+
"to": "stub-repository",
433+
},
434+
],
435+
[
436+
{
437+
"allowEmptyPaths": true,
438+
"files": ".eslintrc.cjs",
439+
"from": /\\\\/\\\\\\*\\\\n\\.\\+\\\\\\*\\\\/\\\\n\\\\n/gs,
440+
"to": "",
441+
},
442+
],
443+
[
444+
{
445+
"allowEmptyPaths": true,
446+
"files": "./package.json",
447+
"from": /"author": "\\.\\+"/g,
448+
"to": ""author": "undefined"",
449+
},
450+
],
451+
]
452+
`);
453+
});
454+
386455
it("does not replace an existing description when it does not exist", async () => {
387456
mockReadFileSafeAsJson.mockResolvedValue({});
388457
mockReplaceInFile.mockResolvedValue([]);
@@ -396,6 +465,7 @@ describe("updateLocalFiles", () => {
396465
to: options.description,
397466
});
398467
});
468+
399469
it("replaces an existing description when it exists", async () => {
400470
const existingDescription = "Existing description.";
401471

‎src/steps/updateLocalFiles.ts

+34-20
Original file line numberDiff line numberDiff line change
@@ -21,26 +21,40 @@ export async function updateLocalFiles(options: Options) {
2121
[/create-typescript-app/g, options.repository],
2222
[/\/\*\n.+\*\/\n\n/gs, ``, ".eslintrc.cjs"],
2323
[/"author": ".+"/g, `"author": "${options.author}"`, "./package.json"],
24-
[/"test:create": ".+\n/g, ``, "./package.json"],
25-
[/"test:initialize": ".*/g, ``, "./package.json"],
26-
[/"initialize": ".*/g, ``, "./package.json"],
27-
[/"test:migrate": ".+\n/g, ``, "./package.json"],
28-
[/## Getting Started.*## Development/gs, `## Development`, "./README.md"],
29-
[/\n## Setup Scripts.*$/gs, "", "./.github/DEVELOPMENT.md"],
30-
[`\t\t"src/initialize/index.ts",\n`, ``, "./knip.jsonc"],
31-
[`\t\t"src/migrate/index.ts",\n`, ``, "./knip.jsonc"],
32-
[
33-
`["src/index.ts!", "script/initialize*.js"]`,
34-
`"src/index.ts!"`,
35-
"./knip.jsonc",
36-
],
37-
[`["src/**/*.ts!", "script/**/*.js"]`, `"src/**/*.ts!"`, "./knip.jsonc"],
38-
// Edge case: migration scripts will rewrite README.md attribution
39-
[
40-
/> 💙 This package was templated with .+\./g,
41-
endOfReadmeTemplateLine,
42-
"./README.md",
43-
],
24+
...(options.mode === "migrate"
25+
? []
26+
: ([
27+
// Only creating a new repository should remove these parts.
28+
// Existing ones might coincidentally have them too.
29+
[/"test:create": ".+\n/g, ``, "./package.json"],
30+
[/"test:initialize": ".*/g, ``, "./package.json"],
31+
[/"initialize": ".*/g, ``, "./package.json"],
32+
[/"test:migrate": ".+\n/g, ``, "./package.json"],
33+
[
34+
/## Getting Started.*## Development/gs,
35+
`## Development`,
36+
"./README.md",
37+
],
38+
[/\n## Setup Scripts.*$/gs, "", "./.github/DEVELOPMENT.md"],
39+
[`\t\t"src/initialize/index.ts",\n`, ``, "./knip.jsonc"],
40+
[`\t\t"src/migrate/index.ts",\n`, ``, "./knip.jsonc"],
41+
[
42+
`["src/index.ts!", "script/initialize*.js"]`,
43+
`"src/index.ts!"`,
44+
"./knip.jsonc",
45+
],
46+
[
47+
`["src/**/*.ts!", "script/**/*.js"]`,
48+
`"src/**/*.ts!"`,
49+
"./knip.jsonc",
50+
],
51+
// Edge case: migration scripts will rewrite README.md attribution
52+
[
53+
/> 💙 This package was templated with .+\./g,
54+
endOfReadmeTemplateLine,
55+
"./README.md",
56+
],
57+
] as typeof replacements)),
4458
];
4559

4660
if (existingPackage.description) {

0 commit comments

Comments
 (0)