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
|
/*
* SonarQube
* Copyright (C) 2009-2023 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 { HttpStatusCode } from 'axios';
import { throwGlobalError } from '../helpers/error';
import { axiosToCatch, getJSON, post, postJSON } from '../helpers/request';
import { CleanCodeAttribute, SoftwareImpact } from '../types/clean-code-taxonomy';
import { GetRulesAppResponse, SearchRulesResponse } from '../types/coding-rules';
import { SearchRulesQuery } from '../types/rules';
import {
RestRuleDetails,
RestRuleParameter,
RuleActivation,
RuleDetails,
RulesUpdateRequest,
} from '../types/types';
const RULES_ENDPOINT = '/api/v2/clean-code-policy/rules';
export interface CreateRuleData {
key: string;
markdownDescription: string;
name: string;
parameters?: Partial<RestRuleParameter>[];
status?: string;
templateKey: string;
cleanCodeAttribute: CleanCodeAttribute;
impacts: SoftwareImpact[];
}
export function getRulesApp(): Promise<GetRulesAppResponse> {
return getJSON('/api/rules/app').catch(throwGlobalError);
}
export function searchRules(data: SearchRulesQuery): Promise<SearchRulesResponse> {
return getJSON('/api/rules/search', data).catch(throwGlobalError);
}
export function listRules(data: SearchRulesQuery): Promise<SearchRulesResponse> {
return getJSON('/api/rules/list', data).catch(throwGlobalError);
}
export function getRuleRepositories(parameters: {
q: string;
}): Promise<Array<{ key: string; language: string; name: string }>> {
return getJSON('/api/rules/repositories', parameters).then(
({ repositories }) => repositories,
throwGlobalError,
);
}
export function getRuleDetails(parameters: {
actives?: boolean;
key: string;
}): Promise<{ actives?: RuleActivation[]; rule: RuleDetails }> {
return getJSON('/api/rules/show', parameters).catch(throwGlobalError);
}
export function getRuleTags(parameters: { ps?: number; q: string }): Promise<string[]> {
return getJSON('/api/rules/tags', parameters).then((r) => r.tags, throwGlobalError);
}
export function createRule(data: CreateRuleData): Promise<RestRuleDetails> {
return axiosToCatch.post<RuleDetails>(RULES_ENDPOINT, data).catch(({ response }) => {
// do not show global error if the status code is 409
// this case should be handled inside a component
if (response && response.status === HttpStatusCode.Conflict) {
return Promise.reject(response);
}
return throwGlobalError(response);
});
}
export function deleteRule(parameters: { key: string }) {
return post('/api/rules/delete', parameters).catch(throwGlobalError);
}
export function updateRule(data: RulesUpdateRequest): Promise<RuleDetails> {
return postJSON('/api/rules/update', data).then((r) => r.rule, throwGlobalError);
}
|
