${formatImage({
127 | url: context.config.logo.url,
128 | alt: "Logo",
129 | height: context.config.logo.height
130 | })}
`
131 | );
132 | }
133 |
134 | /**
135 | * Generates the feature image section of the README
136 | */
137 | function generateFeatureImageSection(context: GenerateReadmeContext): void {
138 | setSection(
139 | context,
140 | "feature_image",
141 | // Don't proceed if there is no feature image to generate an image for
142 | context.config.featureImage.url == null
143 | ? ""
144 | : `${formatImage({
145 | url: context.config.featureImage.url,
146 | alt: "Feature image",
147 | height: context.config.featureImage.height
148 | })}
` 149 | ); 150 | } 151 | 152 | /** 153 | * Generates the Table Of Contents section of the README 154 | */ 155 | function generateTableOfContentsSection(context: GenerateReadmeContext, reserveOnly = false): void { 156 | setSection( 157 | context, 158 | "toc", 159 | `## Table of Contents\n\n` + 160 | (reserveOnly 161 | ? // Only reserve the spot within the README with an empty placeholder that can be replaced later on 162 | `` 163 | : toc(context.str).content) 164 | ); 165 | } 166 | 167 | /** 168 | * Generates the badges section of the README 169 | */ 170 | async function generateBadgesSection(context: GenerateReadmeContext): Promise
Twitter: [@${contributor.twitter}](https://twitter.com/${contributor.twitter})`; 374 | } 375 | 376 | if (contributor.github != null) { 377 | str += `
Github: [@${contributor.github}](https://github.com/${contributor.github})`; 378 | } 379 | 380 | // Also add the role of the contributor, if available 381 | if (contributor.role != null) { 382 | str += `
_${contributor.role}_`; 383 | } 384 | str += "|"; 385 | }); 386 | 387 | return str; 388 | } 389 | 390 | /** 391 | * Generates the maintainers section of the README 392 | */ 393 | function generateMaintainersSection(context: GenerateReadmeContext): void { 394 | const contributors = getContributorsFromPackage(context.pkg); 395 | 396 | setSection(context, "maintainers", contributors.length < 1 ? "" : `## Maintainers\n\n` + generateContributorTable(contributors)); 397 | } 398 | 399 | function guessPreferredFundingUrlForOtherDonations(context: GenerateReadmeContext): string | undefined { 400 | // If a funding url is given, that should take precedence. 401 | if (context.config.donate.other.fundingUrl != null) { 402 | return context.config.donate.other.fundingUrl; 403 | } 404 | 405 | // Otherwise, it might be provided from a "funding" property in the package.json file 406 | if (context.pkg.funding != null) { 407 | if (typeof context.pkg.funding === "string") { 408 | return context.pkg.funding; 409 | } else if (context.pkg.funding.url != null) { 410 | return context.pkg.funding.url; 411 | } 412 | } 413 | 414 | // Otherwise, there's no way to know. 415 | return undefined; 416 | } 417 | 418 | /** 419 | * Generates the backers section of the README 420 | */ 421 | function generateBackersSection(context: GenerateReadmeContext): void { 422 | let content = ""; 423 | 424 | if (context.config.donate.other.donors.length > 0) { 425 | const preferredFundingUrl = guessPreferredFundingUrlForOtherDonations(context); 426 | content += 427 | (preferredFundingUrl != null ? `[Become a sponsor/backer](${preferredFundingUrl}) and get your logo listed here.\n\n` : "") + 428 | generateContributorTable(context.config.donate.other.donors) + 429 | "\n\n"; 430 | } 431 | 432 | if (context.config.donate.openCollective.project != null) { 433 | content += 434 | `### Open Collective\n\n` + 435 | `[Become a sponsor/backer](${CONSTANT.openCollectiveDonateUrl(context.config.donate.openCollective.project)}) and get your logo listed here.\n\n` + 436 | `#### Sponsors\n\n` + 437 | formatUrl({ 438 | url: CONSTANT.openCollectiveContributorsUrl(context.config.donate.openCollective.project), 439 | inner: formatImage({ 440 | url: CONSTANT.openCollectiveSponsorsBadgeUrl(context.config.donate.openCollective.project), 441 | alt: "Sponsors on Open Collective", 442 | width: 500 443 | }) 444 | }) + 445 | "\n\n" + 446 | `#### Backers\n\n` + 447 | formatUrl({ 448 | url: CONSTANT.openCollectiveContributorsUrl(context.config.donate.openCollective.project), 449 | inner: formatImage({ 450 | url: CONSTANT.openCollectiveBackersBadgeUrl(context.config.donate.openCollective.project), 451 | alt: "Backers on Open Collective" 452 | }) 453 | }) + 454 | "\n\n"; 455 | } 456 | 457 | if (context.config.donate.patreon.userId != null && context.config.donate.patreon.username != null) { 458 | content += 459 | `### Patreon\n\n` + 460 | formatUrl({ 461 | url: CONSTANT.patreonDonateUrl(context.config.donate.patreon.userId), 462 | inner: formatImage({ 463 | url: CONSTANT.patreonBadgeUrl(context.config.donate.patreon.username), 464 | alt: "Patrons on Patreon", 465 | width: 200 466 | }) 467 | }) + 468 | "\n\n"; 469 | } 470 | 471 | setSection(context, "backers", context.config.donate.patreon.userId == null && context.config.donate.openCollective.project == null ? "" : `## Backers\n\n` + content); 472 | } 473 | 474 | async function generateLicenseSection(context: GenerateReadmeContext): Promise