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
|
/*
* SonarQube
* Copyright (C) 2009-2018 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import { stringify } from 'querystring';
import { omitNil } from '../../../helpers/request';
import { getHostUrl, getProjectUrl, getPathUrlAsString } from '../../../helpers/urls';
import { getLocalizedMetricName } from '../../../helpers/l10n';
export type BadgeColors = 'white' | 'black' | 'orange';
export type BadgeFormats = 'md' | 'url';
export interface BadgeOptions {
branch?: string;
color?: BadgeColors;
format?: BadgeFormats;
project?: string;
metric?: string;
pullRequest?: string;
}
export enum BadgeType {
measure = 'measure',
qualityGate = 'quality_gate',
marketing = 'marketing'
}
export function getBadgeSnippet(type: BadgeType, options: BadgeOptions) {
const url = getBadgeUrl(type, options);
const { branch, format = 'md', metric = 'alert_status', project } = options;
if (format === 'url') {
return url;
} else {
let label;
let projectUrl;
switch (type) {
case BadgeType.marketing:
label = 'SonarCloud';
break;
case BadgeType.measure:
label = getLocalizedMetricName({ key: metric });
break;
case BadgeType.qualityGate:
default:
label = 'Quality gate';
break;
}
if (project) {
projectUrl = getPathUrlAsString(getProjectUrl(project, branch), false);
}
const mdImage = ``;
return projectUrl ? `[${mdImage}](${projectUrl})` : mdImage;
}
}
export function getBadgeUrl(
type: BadgeType,
{ branch, project, color = 'white', metric = 'alert_status', pullRequest }: BadgeOptions
) {
switch (type) {
case BadgeType.marketing:
return `${getHostUrl()}/images/project_badges/sonarcloud-${color}.svg`;
case BadgeType.qualityGate:
return `${getHostUrl()}/api/project_badges/quality_gate?${stringify(
omitNil({ branch, project, pullRequest })
)}`;
case BadgeType.measure:
default:
return `${getHostUrl()}/api/project_badges/measure?${stringify(
omitNil({ branch, project, metric, pullRequest })
)}`;
}
}
|
