Merge pull request #10456 from Bonial-International-GmbH/PJ_badges-markdown

feat: allow overriding `getMarkdownCode`
This commit is contained in:
Johan Haals
2022-03-28 16:12:56 +02:00
committed by GitHub
3 changed files with 8 additions and 1 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-badges-backend': patch
---
allow overriding `DefaultBadgeBuilder.getMarkdownCode`
+2
View File
@@ -122,6 +122,8 @@ export class DefaultBadgeBuilder implements BadgeBuilder {
createBadgeSvg(options: BadgeOptions): Promise<string>;
// (undocumented)
getBadges(): Promise<BadgeInfo[]>;
// (undocumented)
protected getMarkdownCode(params: Badge, badgeUrl: string): string;
}
// Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -70,7 +70,7 @@ export class DefaultBadgeBuilder implements BadgeBuilder {
}
}
private getMarkdownCode(params: Badge, badgeUrl: string): string {
protected getMarkdownCode(params: Badge, badgeUrl: string): string {
let altText = `${params.label}: ${params.message}`;
if (params.description && params.description !== params.label) {
altText = `${params.description}, ${altText}`;