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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
* SonarQube
* Copyright (C) 2009-2024 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 styled from '@emotion/styled';
import { Button, ButtonVariety } from '@sonarsource/echoes-react';
import {
ButtonSecondary,
HelperHintIcon,
Spinner,
SubHeadingHighlight,
themeBorder,
themeColor,
} from 'design-system';
import * as React from 'react';
import HelpTooltip from '~sonar-aligned/components/controls/HelpTooltip';
import { Profile } from '../../../api/quality-profiles';
import ConfirmButton from '../../../components/controls/ConfirmButton';
import DateFormatter from '../../../components/intl/DateFormatter';
import { translate, translateWithParameters } from '../../../helpers/l10n';
import {
useDeleteRuleMutation,
useRuleDetailsQuery,
useUpdateRuleMutation,
} from '../../../queries/rules';
import { Dict, RuleActivation } from '../../../types/types';
import CustomRuleButton from './CustomRuleButton';
import RuleDetailsCustomRules from './RuleDetailsCustomRules';
import RuleDetailsDescription from './RuleDetailsDescription';
import RuleDetailsHeader from './RuleDetailsHeader';
import RuleDetailsIssues from './RuleDetailsIssues';
import RuleDetailsParameters from './RuleDetailsParameters';
import RuleDetailsProfiles from './RuleDetailsProfiles';
interface Props {
allowCustomRules?: boolean;
canDeactivateInherited?: boolean;
canWrite?: boolean;
onActivate: (profile: string, rule: string, activation: RuleActivation) => void;
onDeactivate: (profile: string, rule: string) => void;
onDelete: (rule: string) => void;
referencedProfiles: Dict<Profile>;
referencedRepositories: Dict<{ key: string; language: string; name: string }>;
ruleKey: string;
selectedProfile?: Profile;
}
export default function RuleDetails(props: Readonly<Props>) {
const {
ruleKey,
allowCustomRules,
canWrite,
referencedProfiles,
canDeactivateInherited,
selectedProfile,
referencedRepositories,
} = props;
const { isLoading: loadingRule, data } = useRuleDetailsQuery({
actives: true,
key: ruleKey,
});
const { mutate: updateRule } = useUpdateRuleMutation();
const { mutate: deleteRule } = useDeleteRuleMutation({}, props.onDelete);
const { rule: ruleDetails, actives = [] } = data ?? {};
const params = ruleDetails?.params ?? [];
const isCustom = !!ruleDetails?.templateKey;
const isEditable = canWrite && !!allowCustomRules && isCustom;
const handleTagsChange = (tags: string[]) => {
updateRule({ key: ruleKey, tags: tags.join() });
};
const handleActivate = () => {
if (selectedProfile) {
const active = actives.find((active) => active.qProfile === selectedProfile.key);
if (active) {
props.onActivate(selectedProfile.key, ruleKey, active);
}
}
};
const handleDeactivate = () => {
if (selectedProfile && actives.find((active) => active.qProfile === selectedProfile.key)) {
props.onDeactivate(selectedProfile.key, ruleKey);
}
};
return (
<StyledRuleDetails className="it__coding-rule-details sw-p-6 sw-mt-6">
<Spinner loading={loadingRule}>
{ruleDetails && (
<>
<RuleDetailsHeader
canWrite={canWrite}
onTagsChange={handleTagsChange}
referencedRepositories={referencedRepositories}
ruleDetails={ruleDetails}
/>
<RuleDetailsDescription canWrite={canWrite} ruleDetails={ruleDetails} />
{params.length > 0 && <RuleDetailsParameters params={params} />}
{isEditable && (
<div className="coding-rules-detail-description sw-flex sw-items-center">
{/* `templateRule` is used to get rule meta data, `customRule` is used to get parameter values */}
{/* it's expected to pass the same rule to both parameters */}
<CustomRuleButton customRule={ruleDetails} templateRule={ruleDetails}>
{({ onClick }) => (
<ButtonSecondary
className="js-edit-custom"
id="coding-rules-detail-custom-rule-change"
onClick={onClick}
>
{translate('edit')}
</ButtonSecondary>
)}
</CustomRuleButton>
<ConfirmButton
confirmButtonText={translate('delete')}
isDestructive
modalBody={translateWithParameters(
'coding_rules.delete.custom.confirm',
ruleDetails.name,
)}
modalHeader={translate('coding_rules.delete_rule')}
onConfirm={() => deleteRule({ key: ruleKey })}
>
{({ onClick }) => (
<>
<Button
className="sw-ml-2 js-delete"
id="coding-rules-detail-rule-delete"
onClick={onClick}
variety={ButtonVariety.DangerOutline}
>
{translate('delete')}
</Button>
<HelpTooltip
className="sw-ml-2"
overlay={
<div className="sw-py-4">
{translate('coding_rules.custom_rule.removal')}
</div>
}
>
<HelperHintIcon />
</HelpTooltip>
</>
)}
</ConfirmButton>
</div>
)}
{ruleDetails.isTemplate && (
<RuleDetailsCustomRules
canChange={allowCustomRules && canWrite}
ruleDetails={ruleDetails}
/>
)}
{!ruleDetails.isTemplate && (
<RuleDetailsProfiles
activations={actives}
canDeactivateInherited={canDeactivateInherited}
onActivate={handleActivate}
onDeactivate={handleDeactivate}
referencedProfiles={referencedProfiles}
ruleDetails={ruleDetails}
/>
)}
{!ruleDetails.isTemplate && ruleDetails.type !== 'SECURITY_HOTSPOT' && (
<RuleDetailsIssues ruleDetails={ruleDetails} />
)}
<div className="sw-my-8" data-meta="available-since">
<SubHeadingHighlight as="h3">
{translate('coding_rules.available_since')}
</SubHeadingHighlight>
<DateFormatter date={ruleDetails.createdAt} />
</div>
</>
)}
</Spinner>
</StyledRuleDetails>
);
}
const StyledRuleDetails = styled.div`
box-sizing: border-box;
border-radius: 4px;
background-color: ${themeColor('filterbar')};
border: ${themeBorder('default', 'filterbarBorder')};
overflow-x: hidden;
`;
|
