Skip to content

Commit 728eb4b

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
fix: use repository name in README.md npm package badge (#1109)
## PR Checklist - [x] Addresses an existing open issue: fixes #1108 - [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 Replaces the hardcoded `create-typescript-app` name with `options.repository`. Also adds non-blank strings to unit tests so the snapshots will reflect this.
1 parent 6f3728e commit 728eb4b

File tree

3 files changed

+39
-39
lines changed

3 files changed

+39
-39
lines changed

‎src/steps/writeReadme/generateTopContent.test.ts

+34-34
Original file line numberDiff line numberDiff line change
@@ -5,46 +5,46 @@ import { generateTopContent } from "./generateTopContent.js";
55

66
const optionsBase = {
77
access: "public",
8-
description: "",
8+
description: "Test description",
99
directory: ".",
1010
email: {
1111
github: "[email protected]",
1212
npm: "[email protected]",
1313
},
1414
mode: "create",
15-
owner: "",
16-
repository: "",
17-
title: "",
15+
owner: "test-owner",
16+
repository: "test-repository",
17+
title: "Test Title",
1818
} satisfies Options;
1919

2020
describe("findExistingBadges", () => {
2121
it("generates full contents when there are no existing badges", () => {
2222
expect(generateTopContent(optionsBase, [])).toMatchInlineSnapshot(`
23-
"<h1 align="center"></h1>
23+
"<h1 align="center">Test Title</h1>
2424
25-
<p align="center"></p>
25+
<p align="center">Test description</p>
2626
2727
<p align="center">
2828
<!-- prettier-ignore-start -->
2929
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3030
<a href="#contributors" target="_blank"><img alt="All Contributors: 2" src="https://img.shields.io/badge/all_contributors-17-21bb42.svg" /></a>
3131
<!-- ALL-CONTRIBUTORS-BADGE:END -->
3232
<!-- prettier-ignore-end -->
33-
<a href="https://codecov.io/gh//" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh///branch/main/graph/badge.svg"/></a>
34-
<a href="https://github.com///blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
35-
<a href="https://github.com///blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license//?color=21bb42"></a>
33+
<a href="https://codecov.io/gh/test-owner/test-repository" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh/test-owner/test-repository/branch/main/graph/badge.svg"/></a>
34+
<a href="https://github.com/test-owner/test-repository/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
35+
<a href="https://github.com/test-owner/test-repository/blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license/test-owner/test-repository?color=21bb42"></a>
3636
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
3737
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
38-
<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
38+
<img alt="npm package version" src="https://img.shields.io/npm/v/test-repository?color=21bb42" />
3939
</p>
4040
4141
## Usage
4242
4343
\`\`\`shell
44-
npm i
44+
npm i test-repository
4545
\`\`\`
4646
\`\`\`ts
47-
import { greet } from "";
47+
import { greet } from "test-repository";
4848
4949
greet("Hello, world! 💖");
5050
\`\`\`"
@@ -57,31 +57,31 @@ describe("findExistingBadges", () => {
5757
`<img alt="TypeScript: Strict" src="invalid svg" />`,
5858
]),
5959
).toMatchInlineSnapshot(`
60-
"<h1 align="center"></h1>
60+
"<h1 align="center">Test Title</h1>
6161
62-
<p align="center"></p>
62+
<p align="center">Test description</p>
6363
6464
<p align="center">
6565
<!-- prettier-ignore-start -->
6666
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
6767
<a href="#contributors" target="_blank"><img alt="All Contributors: 2" src="https://img.shields.io/badge/all_contributors-17-21bb42.svg" /></a>
6868
<!-- ALL-CONTRIBUTORS-BADGE:END -->
6969
<!-- prettier-ignore-end -->
70-
<a href="https://codecov.io/gh//" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh///branch/main/graph/badge.svg"/></a>
71-
<a href="https://github.com///blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
72-
<a href="https://github.com///blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license//?color=21bb42"></a>
70+
<a href="https://codecov.io/gh/test-owner/test-repository" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh/test-owner/test-repository/branch/main/graph/badge.svg"/></a>
71+
<a href="https://github.com/test-owner/test-repository/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
72+
<a href="https://github.com/test-owner/test-repository/blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license/test-owner/test-repository?color=21bb42"></a>
7373
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
7474
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
75-
<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
75+
<img alt="npm package version" src="https://img.shields.io/npm/v/test-repository?color=21bb42" />
7676
</p>
7777
7878
## Usage
7979
8080
\`\`\`shell
81-
npm i
81+
npm i test-repository
8282
\`\`\`
8383
\`\`\`ts
84-
import { greet } from "";
84+
import { greet } from "test-repository";
8585
8686
greet("Hello, world! 💖");
8787
\`\`\`"
@@ -94,32 +94,32 @@ describe("findExistingBadges", () => {
9494
`<img alt="Unknown Badge" src="unknown.svg" />`,
9595
]),
9696
).toMatchInlineSnapshot(`
97-
"<h1 align="center"></h1>
97+
"<h1 align="center">Test Title</h1>
9898
99-
<p align="center"></p>
99+
<p align="center">Test description</p>
100100
101101
<p align="center">
102102
<!-- prettier-ignore-start -->
103103
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
104104
<a href="#contributors" target="_blank"><img alt="All Contributors: 2" src="https://img.shields.io/badge/all_contributors-17-21bb42.svg" /></a>
105105
<!-- ALL-CONTRIBUTORS-BADGE:END -->
106106
<!-- prettier-ignore-end -->
107-
<a href="https://codecov.io/gh//" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh///branch/main/graph/badge.svg"/></a>
108-
<a href="https://github.com///blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
109-
<a href="https://github.com///blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license//?color=21bb42"></a>
107+
<a href="https://codecov.io/gh/test-owner/test-repository" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh/test-owner/test-repository/branch/main/graph/badge.svg"/></a>
108+
<a href="https://github.com/test-owner/test-repository/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
109+
<a href="https://github.com/test-owner/test-repository/blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license/test-owner/test-repository?color=21bb42"></a>
110110
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
111111
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
112-
<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
112+
<img alt="npm package version" src="https://img.shields.io/npm/v/test-repository?color=21bb42" />
113113
<img alt="Unknown Badge" src="unknown.svg" />
114114
</p>
115115
116116
## Usage
117117
118118
\`\`\`shell
119-
npm i
119+
npm i test-repository
120120
\`\`\`
121121
\`\`\`ts
122-
import { greet } from "";
122+
import { greet } from "test-repository";
123123
124124
greet("Hello, world! 💖");
125125
\`\`\`"
@@ -129,22 +129,22 @@ describe("findExistingBadges", () => {
129129
it("does not include a greet section when the mode is migrate", () => {
130130
expect(generateTopContent({ ...optionsBase, mode: "migrate" }, []))
131131
.toMatchInlineSnapshot(`
132-
"<h1 align="center"></h1>
132+
"<h1 align="center">Test Title</h1>
133133
134-
<p align="center"></p>
134+
<p align="center">Test description</p>
135135
136136
<p align="center">
137137
<!-- prettier-ignore-start -->
138138
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
139139
<a href="#contributors" target="_blank"><img alt="All Contributors: 2" src="https://img.shields.io/badge/all_contributors-17-21bb42.svg" /></a>
140140
<!-- ALL-CONTRIBUTORS-BADGE:END -->
141141
<!-- prettier-ignore-end -->
142-
<a href="https://codecov.io/gh//" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh///branch/main/graph/badge.svg"/></a>
143-
<a href="https://github.com///blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
144-
<a href="https://github.com///blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license//?color=21bb42"></a>
142+
<a href="https://codecov.io/gh/test-owner/test-repository" target="_blank"><img alt="Codecov Test Coverage" src="https://codecov.io/gh/test-owner/test-repository/branch/main/graph/badge.svg"/></a>
143+
<a href="https://github.com/test-owner/test-repository/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank"><img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" /></a>
144+
<a href="https://github.com/test-owner/test-repository/blob/main/LICENSE.md" target="_blank"><img alt="License: MIT" src="https://img.shields.io/github/license/test-owner/test-repository?color=21bb42"></a>
145145
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
146146
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
147-
<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
147+
<img alt="npm package version" src="https://img.shields.io/npm/v/test-repository?color=21bb42" />
148148
</p>"
149149
`);
150150
});

‎src/steps/writeReadme/generateTopContent.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export function generateTopContent(options: Options, existingBadges: string[]) {
5858
/typescript.*strict/i,
5959
],
6060
[
61-
`<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />`,
61+
`<img alt="npm package version" src="https://img.shields.io/npm/v/${options.repository}?color=21bb42" />`,
6262
/npm.*v/i,
6363
],
6464
] as const) {

‎src/steps/writeReadme/index.test.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ describe("writeReadme", () => {
6666
<a href="https://github.com/sponsors/TestFunding" target="_blank"><img alt="Sponsor: On GitHub" src="https://img.shields.io/badge/sponsor-on_github-21bb42.svg" /></a>
6767
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
6868
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
69-
<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
69+
<img alt="npm package version" src="https://img.shields.io/npm/v/test-repository?color=21bb42" />
7070
</p>
7171
7272
## Usage
@@ -127,7 +127,7 @@ describe("writeReadme", () => {
127127
<a href="https://github.com/sponsors/TestFunding" target="_blank"><img alt="Sponsor: On GitHub" src="https://img.shields.io/badge/sponsor-on_github-21bb42.svg" /></a>
128128
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
129129
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
130-
<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
130+
<img alt="npm package version" src="https://img.shields.io/npm/v/test-repository?color=21bb42" />
131131
</p>
132132
133133
## Usage
@@ -191,7 +191,7 @@ describe("writeReadme", () => {
191191
<a href="https://github.com/sponsors/TestFunding" target="_blank"><img alt="Sponsor: On GitHub" src="https://img.shields.io/badge/sponsor-on_github-21bb42.svg" /></a>
192192
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
193193
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
194-
<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
194+
<img alt="npm package version" src="https://img.shields.io/npm/v/test-repository?color=21bb42" />
195195
</p>
196196
197197
## Usage
@@ -289,7 +289,7 @@ describe("writeReadme", () => {
289289
<a href="https://github.com/sponsors/TestFunding" target="_blank"><img alt="Sponsor: On GitHub" src="https://img.shields.io/badge/sponsor-on_github-21bb42.svg" /></a>
290290
<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
291291
<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
292-
<img alt="npm package version" src="https://img.shields.io/npm/v/create-typescript-app?color=21bb42" />
292+
<img alt="npm package version" src="https://img.shields.io/npm/v/test-repository?color=21bb42" />
293293
<a href="#contributors" target="_blank"><img alt="All Contributors: 2" src="https://img.shields.io/badge/all_contributors-17-21bb42.svg" /></a>
294294
</p>
295295

0 commit comments

Comments
 (0)