-
Notifications
You must be signed in to change notification settings - Fork 27
/
LessVariableNamingConventionCheck.java
93 lines (82 loc) · 3.22 KB
/
LessVariableNamingConventionCheck.java
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
/*
* SonarQube CSS / SCSS / Less Analyzer
* Copyright (C) 2013-2017 David RACODON
* mailto: david.racodon@gmail.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.
*/
package org.sonar.css.checks.less;
import com.google.common.annotations.VisibleForTesting;
import java.text.MessageFormat;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.css.checks.CheckList;
import org.sonar.css.checks.CheckUtils;
import org.sonar.css.checks.Tags;
import org.sonar.plugins.css.api.tree.Tree;
import org.sonar.plugins.css.api.tree.less.LessVariableDeclarationTree;
import org.sonar.plugins.css.api.visitors.DoubleDispatchVisitorCheck;
import org.sonar.squidbridge.annotations.ActivatedByDefault;
import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
@Rule(
key = "less-variable-naming-convention",
name = "Less variables should follow a naming convention",
priority = Priority.MINOR,
tags = {Tags.CONVENTION})
@SqaleConstantRemediation("10min")
@ActivatedByDefault
public class LessVariableNamingConventionCheck extends DoubleDispatchVisitorCheck {
private static final String DEFAULT_FORMAT = "^[a-z][-a-z0-9]*$";
@RuleProperty(
key = "Format",
description = "Regular expression used to check the variable names against. See " + CheckUtils.LINK_TO_JAVA_REGEX_PATTERN_DOC + " for detailed regular expression syntax.",
defaultValue = DEFAULT_FORMAT)
private String format = DEFAULT_FORMAT;
@Override
public void visitLessVariableDeclaration(LessVariableDeclarationTree tree) {
if (!tree.variable().variableName().matches(format)) {
addIssue(tree.variable().variable(), tree.variable().variableName());
}
super.visitLessVariableDeclaration(tree);
}
@VisibleForTesting
void setFormat(String format) {
this.format = format;
}
@Override
public void validateParameters() {
try {
Pattern.compile(format);
} catch (PatternSyntaxException exception) {
throw new IllegalStateException(paramsErrorMessage(), exception);
}
}
private String paramsErrorMessage() {
return CheckUtils.paramsErrorMessage(
this.getClass(),
CheckList.LESS_REPOSITORY_KEY,
"format parameter \"" + format + "\" is not a valid regular expression.");
}
private void addIssue(Tree tree, String value) {
addPreciseIssue(
tree,
MessageFormat.format(
"Rename variable \"{0}\" to match the regular expression: {1}",
value, format));
}
}