-
-
Notifications
You must be signed in to change notification settings - Fork 80
/
Copy pathgenerateTopContent.test.ts
205 lines (182 loc) · 7.65 KB
/
generateTopContent.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
import { describe, expect, it } from "vitest";
import { Options } from "../../shared/types.js";
import { generateTopContent } from "./generateTopContent.js";
const optionsBase = {
access: "public",
author: undefined,
base: undefined,
createRepository: undefined,
description: "",
email: {
github: "[email protected]",
npm: "[email protected]",
},
excludeAllContributors: undefined,
excludeCompliance: undefined,
excludeLintJson: undefined,
excludeLintKnip: undefined,
excludeLintMd: undefined,
excludeLintPackageJson: undefined,
excludeLintPackages: undefined,
excludeLintPerfectionist: undefined,
excludeLintSpelling: undefined,
excludeLintYml: undefined,
excludeReleases: undefined,
excludeRenovate: undefined,
excludeTests: undefined,
funding: undefined,
logo: undefined,
mode: "create",
owner: "",
repository: "",
skipGitHubApi: false,
skipInstall: undefined,
skipRemoval: undefined,
skipRestore: undefined,
skipUninstall: undefined,
title: "",
} satisfies Options;
describe("findExistingBadges", () => {
it("generates full contents when there are no existing badges", () => {
expect(generateTopContent(optionsBase, [])).toMatchInlineSnapshot(`
"<h1 align=\\"center\\"></h1>
<p align=\\"center\\"></p>
<p align=\\"center\\">
<a href=\\"#contributors\\" target=\\"_blank\\">
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<img alt=\\"All Contributors: 2\\" src=\\"https://img.shields.io/badge/all_contributors-17-21bb42.svg\\" />
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->
</a>
<a href=\\"https://codecov.io/gh//\\" target=\\"_blank\\">
<img alt=\\"Codecov Test Coverage\\" src=\\"https://codecov.io/gh///branch/main/graph/badge.svg\\"/>
</a>
<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>
<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>
<img alt=\\"Style: Prettier\\" src=\\"https://img.shields.io/badge/style-prettier-21bb42.svg\\" />
<img alt=\\"TypeScript: Strict\\" src=\\"https://img.shields.io/badge/typescript-strict-21bb42.svg\\" />
<img alt=\\"npm package version\\" src=\\"https://img.shields.io/npm/v/create-typescript-app?color=21bb42\\" />
</p>
## Usage
\`\`\`shell
npm i
\`\`\`
\`\`\`ts
import { greet } from \\"\\";
greet(\\"Hello, world! 💖\\");
\`\`\`"
`);
});
it("replaces existing contents when there is an existing known badge", () => {
expect(
generateTopContent(optionsBase, [
`<img alt="TypeScript: Strict" src="invalid svg" />`,
]),
).toMatchInlineSnapshot(`
"<h1 align=\\"center\\"></h1>
<p align=\\"center\\"></p>
<p align=\\"center\\">
<a href=\\"#contributors\\" target=\\"_blank\\">
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<img alt=\\"All Contributors: 2\\" src=\\"https://img.shields.io/badge/all_contributors-17-21bb42.svg\\" />
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->
</a>
<a href=\\"https://codecov.io/gh//\\" target=\\"_blank\\">
<img alt=\\"Codecov Test Coverage\\" src=\\"https://codecov.io/gh///branch/main/graph/badge.svg\\"/>
</a>
<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>
<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>
<img alt=\\"Style: Prettier\\" src=\\"https://img.shields.io/badge/style-prettier-21bb42.svg\\" />
<img alt=\\"TypeScript: Strict\\" src=\\"https://img.shields.io/badge/typescript-strict-21bb42.svg\\" />
<img alt=\\"npm package version\\" src=\\"https://img.shields.io/npm/v/create-typescript-app?color=21bb42\\" />
</p>
## Usage
\`\`\`shell
npm i
\`\`\`
\`\`\`ts
import { greet } from \\"\\";
greet(\\"Hello, world! 💖\\");
\`\`\`"
`);
});
it("push existing badges to the end when there is an existing unknown badge", () => {
expect(
generateTopContent(optionsBase, [
`<img alt="Unknown Badge" src="unknown.svg" />`,
]),
).toMatchInlineSnapshot(`
"<h1 align=\\"center\\"></h1>
<p align=\\"center\\"></p>
<p align=\\"center\\">
<a href=\\"#contributors\\" target=\\"_blank\\">
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<img alt=\\"All Contributors: 2\\" src=\\"https://img.shields.io/badge/all_contributors-17-21bb42.svg\\" />
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->
</a>
<a href=\\"https://codecov.io/gh//\\" target=\\"_blank\\">
<img alt=\\"Codecov Test Coverage\\" src=\\"https://codecov.io/gh///branch/main/graph/badge.svg\\"/>
</a>
<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>
<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>
<img alt=\\"Style: Prettier\\" src=\\"https://img.shields.io/badge/style-prettier-21bb42.svg\\" />
<img alt=\\"TypeScript: Strict\\" src=\\"https://img.shields.io/badge/typescript-strict-21bb42.svg\\" />
<img alt=\\"npm package version\\" src=\\"https://img.shields.io/npm/v/create-typescript-app?color=21bb42\\" />
<img alt=\\"Unknown Badge\\" src=\\"unknown.svg\\" />
</p>
## Usage
\`\`\`shell
npm i
\`\`\`
\`\`\`ts
import { greet } from \\"\\";
greet(\\"Hello, world! 💖\\");
\`\`\`"
`);
});
it("does not include a greet section when the mode is migrate", () => {
expect(generateTopContent({ ...optionsBase, mode: "migrate" }, []))
.toMatchInlineSnapshot(`
"<h1 align=\\"center\\"></h1>
<p align=\\"center\\"></p>
<p align=\\"center\\">
<a href=\\"#contributors\\" target=\\"_blank\\">
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
<img alt=\\"All Contributors: 2\\" src=\\"https://img.shields.io/badge/all_contributors-17-21bb42.svg\\" />
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- prettier-ignore-end -->
</a>
<a href=\\"https://codecov.io/gh//\\" target=\\"_blank\\">
<img alt=\\"Codecov Test Coverage\\" src=\\"https://codecov.io/gh///branch/main/graph/badge.svg\\"/>
</a>
<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>
<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>
<img alt=\\"Style: Prettier\\" src=\\"https://img.shields.io/badge/style-prettier-21bb42.svg\\" />
<img alt=\\"TypeScript: Strict\\" src=\\"https://img.shields.io/badge/typescript-strict-21bb42.svg\\" />
<img alt=\\"npm package version\\" src=\\"https://img.shields.io/npm/v/create-typescript-app?color=21bb42\\" />
</p>"
`);
});
});