From 4c93fd36ee8af3232421f4f708a3fb3213aa135f Mon Sep 17 00:00:00 2001 From: Patrick Jungermann Date: Sat, 26 Mar 2022 01:11:48 +0100 Subject: [PATCH] feat: allow overriding `getMarkdownCode` allow overriding `DefaultBadgeBuilder.getMarkdownCode` Signed-off-by: Patrick Jungermann --- .changeset/fresh-bulldogs-own.md | 5 +++++ plugins/badges-backend/api-report.md | 2 ++ .../src/lib/BadgeBuilder/DefaultBadgeBuilder.ts | 2 +- 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 .changeset/fresh-bulldogs-own.md diff --git a/.changeset/fresh-bulldogs-own.md b/.changeset/fresh-bulldogs-own.md new file mode 100644 index 0000000000..7772262efe --- /dev/null +++ b/.changeset/fresh-bulldogs-own.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-badges-backend': patch +--- + +allow overriding `DefaultBadgeBuilder.getMarkdownCode` diff --git a/plugins/badges-backend/api-report.md b/plugins/badges-backend/api-report.md index 01b14cc8ee..0660d23fdb 100644 --- a/plugins/badges-backend/api-report.md +++ b/plugins/badges-backend/api-report.md @@ -122,6 +122,8 @@ export class DefaultBadgeBuilder implements BadgeBuilder { createBadgeSvg(options: BadgeOptions): Promise; // (undocumented) getBadges(): Promise; + // (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) diff --git a/plugins/badges-backend/src/lib/BadgeBuilder/DefaultBadgeBuilder.ts b/plugins/badges-backend/src/lib/BadgeBuilder/DefaultBadgeBuilder.ts index 7f9d2580f9..78e34351a0 100644 --- a/plugins/badges-backend/src/lib/BadgeBuilder/DefaultBadgeBuilder.ts +++ b/plugins/badges-backend/src/lib/BadgeBuilder/DefaultBadgeBuilder.ts @@ -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}`;