rife2/bld-pmd
rife2/bld-pmd
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added option to toggle the violation's line number in source file URI

Browse source
This commit is contained in:
Erik C. Thauvin 2024-02-09 21:07:22 -08:00
parent 8218c4c945
commit 9d301b5ef6
1 changed files with 30 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

37
src/main/java/rife/bld/extension/PmdOperation.java
View file

@ -81,6 +81,10 @@ public class PmdOperation extends AbstractOperation<PmdOperation> {
* The path of the ignore file
*/
Path ignoreFile_;
/**
* The include line number toggle.
*/
boolean includeLineNumber_ = true;
/**
* The incremental analysis toggle.
*/
@ -300,6 +304,18 @@ public class PmdOperation extends AbstractOperation<PmdOperation> {
return this;
}
/**
* Enables or disables including the line number for the beginning of the violation in the analyzed source file URI.
* <p>
* While clicking on the URI works in IntelliJ IDEA, Visual Studio Code, etc.; it might not in terminal emulators.
* <p>
* Default: {@code TRUE}
*/
public PmdOperation includeLineNumber(boolean includeLineNumber) {
includeLineNumber_ = includeLineNumber;
return this;
}
/**
* Enables or disables incremental analysis.
*/
@ -399,14 +415,17 @@ public class PmdOperation extends AbstractOperation<PmdOperation> {
}
var numErrors = report.getViolations().size();
if (numErrors > 0) {
var msg = String.format(
"[%s] %d rule violations were found. See the report at: %s", commandName, numErrors,
config.getReportFilePath().toUri());
for (var v : report.getViolations()) {
if (LOGGER.isLoggable(Level.WARNING)) {
LOGGER.log(Level.WARNING, "[{0}] {1}:{2}:\n\t{3} ({4})\n\t\t--> {5}",
final String msg;
if (includeLineNumber_) {
msg = "[{0}] {1}:{2}\n\t{3} ({4})\n\t\t--> {5}";
} else {
msg = "\"[{0}] {1} (line: {2})\\n\\t{3} ({4})\\n\\t\\t--> {5}\"";
}
LOGGER.log(Level.WARNING, msg,
new Object[]{commandName,
v.getFileId().getAbsolutePath(),
v.getFileId().getUriString(),
v.getBeginLine(),
v.getRule().getName(),
v.getRule().getExternalInfoUrl() //TODO bug in PMD?
@ -415,11 +434,15 @@ public class PmdOperation extends AbstractOperation<PmdOperation> {
v.getDescription()});
}
}
var violations = String.format(
"[%s] %d rule violations were found. See the report at: %s", commandName, numErrors,
config.getReportFilePath().toUri());
if (config.isFailOnViolation()) {
throw new RuntimeException(msg); // NOPMD
throw new RuntimeException(violations); // NOPMD
} else {
if (LOGGER.isLoggable(Level.WARNING)) {
LOGGER.warning(msg);
LOGGER.warning(violations);
}
}
} else {