Skip to content

Commit 91cb22b

Browse files
JoshuaKGoldbergJoshuaKGoldberg
authored
feat: manually generate all-contributors table in memory (#1867)
## PR Checklist - [x] Addresses an existing open issue: fixes #1845 - [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 As with the prototype in #1839, does as close a job as possible to what all-contributors creates internally. Unlike the prototype, implements this in `blockAllContributors`, not in `blockReadme`. And it adds `badges` and `sections` as addons. 💖
1 parent 444de1c commit 91cb22b

8 files changed

+176
-88
lines changed

‎package.json

+2
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
"input-from-script": "0.1.0-alpha.4",
5757
"js-yaml": "^4.1.0",
5858
"lazy-value": "^3.0.0",
59+
"lodash": "^4.17.21",
5960
"npm-user": "^6.1.1",
6061
"object-strings-deep": "^0.1.1",
6162
"octokit": "^4.0.2",
@@ -82,6 +83,7 @@
8283
"@types/git-url-parse": "9.0.3",
8384
"@types/html-to-text": "9.0.4",
8485
"@types/js-yaml": "4.0.9",
86+
"@types/lodash": "^4.17.14",
8587
"@types/node": "22.10.2",
8688
"@types/parse-author": "2.0.3",
8789
"@vitest/coverage-v8": "2.1.8",

‎pnpm-lock.yaml

+11
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/next/base.ts

+11-9
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ import { readDescription } from "./readDescription.js";
2222
import { readDocumentation } from "./readDocumentation.js";
2323
import { swallowError } from "./utils/swallowError.js";
2424

25+
const zContributor = z.object({
26+
avatar_url: z.string(),
27+
contributions: z.array(z.string()),
28+
login: z.string(),
29+
name: z.string(),
30+
profile: z.string(),
31+
});
32+
33+
export type Contributor = z.infer<typeof zContributor>;
34+
2535
export const base = createBase({
2636
options: {
2737
access: z
@@ -36,15 +46,7 @@ export const base = createBase({
3646
.optional()
3747
.describe('value to set in `package.json`\'s `"bin"` property'),
3848
contributors: z
39-
.array(
40-
z.object({
41-
avatar_url: z.string(),
42-
contributions: z.array(z.string()),
43-
login: z.string(),
44-
name: z.string(),
45-
profile: z.string(),
46-
}),
47-
)
49+
.array(zContributor)
4850
.optional()
4951
.describe("AllContributors contributors to store in .all-contributorsrc"),
5052
description: z

‎src/next/blocks/blockAllContributors.test.ts

+58-5
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,19 @@ describe("blockAllContributors", () => {
1111
expect(creation).toMatchInlineSnapshot(`
1212
{
1313
"addons": [
14+
{
15+
"addons": {
16+
"badges": [
17+
"<!-- prettier-ignore-start -->
18+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
19+
<a href="#contributors" target="_blank"><img alt="👪 All Contributors: undefined" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-undefined-21bb42.svg" /></a>
20+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
21+
<!-- prettier-ignore-end -->",
22+
],
23+
"sections": undefined,
24+
},
25+
"block": [Function],
26+
},
1427
{
1528
"addons": {
1629
"secrets": [
@@ -52,7 +65,6 @@ describe("blockAllContributors", () => {
5265
"scripts": [
5366
{
5467
"commands": [
55-
"pnpx all-contributors-cli generate",
5668
"pnpx all-contributors-cli add test-owner code,content,doc,ideas,infra,maintenance,projectManagement,tool",
5769
],
5870
"phase": 3,
@@ -62,14 +74,25 @@ describe("blockAllContributors", () => {
6274
`);
6375
});
6476

65-
it("includes contributors when not provided", () => {
77+
it("includes contributors when provided", () => {
6678
const creation = testBlock(blockAllContributors, {
6779
options: {
6880
...optionsBase,
6981
contributors: [
7082
{
7183
avatar_url: "https://avatars.githubusercontent.com/u/3335181?v=4",
72-
contributions: ["bug", "ideas"],
84+
contributions: [
85+
"bug",
86+
"code",
87+
"design",
88+
"doc",
89+
"ideas",
90+
"infra",
91+
"maintenance",
92+
"review",
93+
"test",
94+
"tool",
95+
],
7396
login: "JoshuaKGoldberg",
7497
name: "Josh Goldberg",
7598
profile: "http://www.joshuakgoldberg.com",
@@ -81,6 +104,37 @@ describe("blockAllContributors", () => {
81104
expect(creation).toMatchInlineSnapshot(`
82105
{
83106
"addons": [
107+
{
108+
"addons": {
109+
"badges": [
110+
"<!-- prettier-ignore-start -->
111+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
112+
<a href="#contributors" target="_blank"><img alt="👪 All Contributors: 1" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-1-21bb42.svg" /></a>
113+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
114+
<!-- prettier-ignore-end -->",
115+
],
116+
"sections": [
117+
"## Contributors
118+
119+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
120+
<!-- prettier-ignore-start -->
121+
<!-- markdownlint-disable -->
122+
<table>
123+
<tbody>
124+
<tr>
125+
<td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg"/><br /><sub><b>Josh Goldberg</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=author%3AJoshuaKGoldberg" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/create-typescript-app/commits?author=JoshuaKGoldberg" title="Code">💻</a> <a href="#design-JoshuaKGoldberg" title="Design">🎨</a> <a href="https://github.com/JoshuaKGoldberg/create-typescript-app/commits?author=JoshuaKGoldberg" title="Documentation">📖</a> <a href="#ideas-JoshuaKGoldberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-JoshuaKGoldberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a> <a href="https://github.com/JoshuaKGoldberg/create-typescript-app/pulls?q=is%3Apr+reviewed-by%3AJoshuaKGoldberg" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/JoshuaKGoldberg/create-typescript-app/commits?author=JoshuaKGoldberg" title="Tests">⚠️</a> <a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a></td>
126+
</tr>
127+
</tbody>
128+
</table>
129+
130+
<!-- markdownlint-restore -->
131+
<!-- prettier-ignore-end -->
132+
133+
<!-- ALL-CONTRIBUTORS-LIST:END -->",
134+
],
135+
},
136+
"block": [Function],
137+
},
84138
{
85139
"addons": {
86140
"secrets": [
@@ -94,7 +148,7 @@ describe("blockAllContributors", () => {
94148
},
95149
],
96150
"files": {
97-
".all-contributorsrc": "{"badgeTemplate":"\\t<a href=\\"#contributors\\" target=\\"_blank\\"><img alt=\\"👪 All Contributors: <%= contributors.length %>\\" src=\\"https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-<%= contributors.length %>-21bb42.svg\\" /></a>","contributors":[{"avatar_url":"https://avatars.githubusercontent.com/u/3335181?v=4","contributions":["bug","ideas"],"login":"JoshuaKGoldberg","name":"Josh Goldberg","profile":"http://www.joshuakgoldberg.com"}],"contributorsSortAlphabetically":true,"projectName":"test-repository","projectOwner":"test-owner"}",
151+
".all-contributorsrc": "{"badgeTemplate":"\\t<a href=\\"#contributors\\" target=\\"_blank\\"><img alt=\\"👪 All Contributors: <%= contributors.length %>\\" src=\\"https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-<%= contributors.length %>-21bb42.svg\\" /></a>","contributors":[{"avatar_url":"https://avatars.githubusercontent.com/u/3335181?v=4","contributions":["bug","code","design","doc","ideas","infra","maintenance","review","test","tool"],"login":"JoshuaKGoldberg","name":"Josh Goldberg","profile":"http://www.joshuakgoldberg.com"}],"contributorsSortAlphabetically":true,"projectName":"test-repository","projectOwner":"test-owner"}",
98152
".github": {
99153
"workflows": {
100154
"contributors.yml": "jobs:
@@ -122,7 +176,6 @@ describe("blockAllContributors", () => {
122176
"scripts": [
123177
{
124178
"commands": [
125-
"pnpx all-contributors-cli generate",
126179
"pnpx all-contributors-cli add test-owner code,content,doc,ideas,infra,maintenance,projectManagement,tool",
127180
],
128181
"phase": 3,

‎src/next/blocks/blockAllContributors.ts

+82-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1+
import _ from "lodash";
2+
13
import { createSoloWorkflowFile } from "../../steps/writing/creation/dotGitHub/createSoloWorkflowFile.js";
2-
import { base } from "../base.js";
4+
import { base, Contributor } from "../base.js";
5+
import { blockREADME } from "./blockREADME.js";
36
import { blockRepositorySecrets } from "./blockRepositorySecrets.js";
47
import { CommandPhase } from "./phases.js";
58

@@ -8,8 +11,21 @@ export const blockAllContributors = base.createBlock({
811
name: "AllContributors",
912
},
1013
produce({ options }) {
14+
const contributions = options.contributors?.length;
1115
return {
1216
addons: [
17+
blockREADME({
18+
badges: [
19+
`<!-- prettier-ignore-start -->
20+
\t<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
21+
\t<a href="#contributors" target="_blank"><img alt="👪 All Contributors: ${contributions}" src="https://img.shields.io/badge/%F0%9F%91%AA_all_contributors-${contributions}-21bb42.svg" /></a>
22+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
23+
\t<!-- prettier-ignore-end -->`,
24+
],
25+
sections: options.contributors
26+
? [printAllContributorsTable(options.contributors)]
27+
: undefined,
28+
}),
1329
blockRepositorySecrets({
1430
secrets: [
1531
{
@@ -52,7 +68,6 @@ export const blockAllContributors = base.createBlock({
5268
scripts: [
5369
{
5470
commands: [
55-
`pnpx all-contributors-cli generate`,
5671
`pnpx all-contributors-cli add ${options.owner} code,content,doc,ideas,infra,maintenance,projectManagement,tool`,
5772
],
5873
phase: CommandPhase.Process,
@@ -61,3 +76,68 @@ export const blockAllContributors = base.createBlock({
6176
};
6277
},
6378
});
79+
80+
function printAllContributorsTable(contributors: Contributor[]) {
81+
return [
82+
`## Contributors`,
83+
``,
84+
`<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->`,
85+
`<!-- prettier-ignore-start -->`,
86+
`<!-- markdownlint-disable -->`,
87+
`<table>`,
88+
` <tbody>`,
89+
` <tr>`,
90+
// This intentionally uses the same sort as all-contributors-cli:
91+
// https://github.com/all-contributors/cli/blob/74bc388bd6f0ae2658e6495e9d3781d737438a97/src/generate/index.js#L76
92+
..._.sortBy(contributors, "name").flatMap((contributor, i) => {
93+
const row = printContributorCell(contributor);
94+
95+
return i && i % 7 === 0 ? [` </tr>`, ` <tr>`, row] : [row];
96+
}),
97+
` </tr>`,
98+
` </tbody>`,
99+
`</table>`,
100+
``,
101+
`<!-- markdownlint-restore -->`,
102+
`<!-- prettier-ignore-end -->`,
103+
``,
104+
`<!-- ALL-CONTRIBUTORS-LIST:END -->`,
105+
].join("\n");
106+
}
107+
108+
function printContributorCell(contributor: Contributor) {
109+
return [
110+
` <td align="center" valign="top" width="14.28%">`,
111+
`<a href="${contributor.profile}">`,
112+
`<img src="${contributor.avatar_url}?s=100" width="100px;" alt="${contributor.name}"/>`,
113+
`<br />`,
114+
`<sub><b>${contributor.name}</b></sub></a><br />`,
115+
...contributor.contributions
116+
.map((contribution) => {
117+
switch (contribution) {
118+
case "bug":
119+
return `<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/issues?q=author%3A${contributor.login}" title="Bug reports">🐛</a>`;
120+
case "code":
121+
return `<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/commits?author=${contributor.login}" title="Code">💻</a>`;
122+
case "design":
123+
return `<a href="#design-${contributor.login}" title="Design">🎨</a>`;
124+
case "doc":
125+
return `<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/commits?author=${contributor.login}" title="Documentation">📖</a>`;
126+
case "ideas":
127+
return `<a href="#ideas-${contributor.login}" title="Ideas, Planning, & Feedback">🤔</a>`;
128+
case "infra":
129+
return `<a href="#infra-${contributor.login}" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a>`;
130+
case "maintenance":
131+
return `<a href="#maintenance-${contributor.login}" title="Maintenance">🚧</a>`;
132+
case "review":
133+
return `<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/pulls?q=is%3Apr+reviewed-by%3A${contributor.login}" title="Reviewed Pull Requests">👀</a>`;
134+
case "test":
135+
return `<a href="https://github.com/JoshuaKGoldberg/create-typescript-app/commits?author=${contributor.login}" title="Tests">⚠️</a>`;
136+
case "tool":
137+
return `<a href="#tool-${contributor.login}" title="Tools">🔧</a>`;
138+
}
139+
})
140+
.join(" "),
141+
`</td>`,
142+
].join("");
143+
}

0 commit comments

Comments
 (0)