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
|
/*
* SonarQube
* Copyright (C) 2009-2022 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.
*/
export enum RuleDescriptionSections {
DEFAULT = 'default',
INTRODUCTION = 'introduction',
ROOT_CAUSE = 'root_cause',
ASSESS_THE_PROBLEM = 'assess_the_problem',
HOW_TO_FIX = 'how_to_fix',
RESOURCES = 'resources'
}
export interface RuleDescriptionContext {
key: string;
displayName: string;
}
export interface RuleDescriptionSection {
key: RuleDescriptionSections;
content: string;
context?: RuleDescriptionContext;
}
|
