Add --output-format option with errorformat and github-actions (#7)

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>

Author: koppor

README.md

@@ -41,6 +41,8 @@ madrlint <madrFile>
                                not exist, it will be created.
 -O, --override                 If the given output file already exists, it will be
                                overwritten.
+--output-format <format>       Format of the diagnostics. Valid values: errorformat,
+                               github-actions. Defaults to errorformat.
 -q, --quiet                    Information not relevant to the lint results will be
                                suppressed.
 ```

app/src/main/java/neutra1/linter/Main.java

@@ -13,6 +13,7 @@
 import neutra1.linter.core.Reporter;
 import neutra1.linter.helper.IgnoreFileHandler;
 import neutra1.linter.helper.LintContext;
+import neutra1.linter.models.enums.OutputFormat;
 import neutra1.linter.rules.AbstractRule;
 import neutra1.linter.rules.IFileRule;
 import neutra1.linter.rules.impl.file.Rule01;
@@ -40,7 +41,7 @@
     name = "madrlint",
     description = "Lint MADR files",
     mixinStandardHelpOptions = true,
-    customSynopsis = "madrlint [-hOqV] [-n <ruleNumber>[,ruleNumber...]>] [-o <outputFile>] <madrFile>",
+    customSynopsis = "madrlint [-hOqV] [-n <ruleNumber>[,ruleNumber...]>] [-o <outputFile>] [--output-format <format>] <madrFile>",
     version="1.0.0"
 )
 public class Main implements Runnable {
@@ -59,6 +60,8 @@ public class Main implements Runnable {
     boolean quietMode;
     @Option(names = {"-n", "--no-warn"}, description = "Disable warnings for certain rules. They can either be declared separately(e.g -n1 -n2) or chained together separated by comma(e.g -n1,2)", split = ",")
     private Set<Integer> disabledRules = new HashSet<>();
+    @Option(names = {"--output-format"}, description = "Format of the diagnostics. Valid values: errorformat, github-actions. Defaults to errorformat.", converter = OutputFormatConverter.class)
+    private OutputFormat outputFormat = OutputFormat.ERRORFORMAT;
     @Option(names = {"-r", "--root"}, description = "Set the root directory of the project. Defaults to current working directory if not specified.")
     private String root;
     @Override
@@ -116,11 +119,11 @@ else if (Files.isDirectory(Paths.get(internalPath))){
         int disabledRuleCount = disabledRules.size();
         int totalRuleCount = rules.size();
         int disabledRelevantRuleCount = rules.stream().filter(rule -> disabledRules.contains(rule.getRuleNumber())).toList().size();
-        if (outputFile == null){  
-            reporter.outputDiagnostics(disabledRuleCount, disabledRelevantRuleCount, totalRuleCount, quietMode);
-        } 
+        if (outputFile == null){
+            reporter.outputDiagnostics(disabledRuleCount, disabledRelevantRuleCount, totalRuleCount, quietMode, outputFormat);
+        }
         else {
-            reporter.outputDiagnostics(outputFile, disabledRuleCount, disabledRelevantRuleCount, totalRuleCount, override, quietMode);
+            reporter.outputDiagnostics(outputFile, disabledRuleCount, disabledRelevantRuleCount, totalRuleCount, override, quietMode, outputFormat);
         }
     }
 
@@ -132,6 +135,18 @@ public static void main(String[] args) {
         System.exit(exitCode);
     }
 
+    static class OutputFormatConverter implements CommandLine.ITypeConverter<OutputFormat> {
+        @Override
+        public OutputFormat convert(String value) {
+            try {
+                return OutputFormat.fromLabel(value);
+            }
+            catch (IllegalArgumentException e){
+                throw new CommandLine.TypeConversionException(e.getMessage());
+            }
+        }
+    }
+
     private String readFile(String filePath) throws IOException{
         Path path = Paths.get(filePath);
         if (!path.isAbsolute()){

app/src/main/java/neutra1/linter/core/Reporter.java

@@ -3,6 +3,7 @@
 import java.util.List;
 
 import neutra1.linter.helper.LintContext;
+import neutra1.linter.models.enums.OutputFormat;
 import neutra1.linter.models.records.Violation;
 
 import java.io.IOException;
@@ -33,16 +34,16 @@ public void report(Violation violation) {
         violationList.add(violation);
     }
 
-    public void outputDiagnostics(int disabledRuleCount, int disabledRelevantRuleCount, int totalRuleCount, boolean quietMode) {
-        StringBuilder diagnosis = getDiagnosis();
+    public void outputDiagnostics(int disabledRuleCount, int disabledRelevantRuleCount, int totalRuleCount, boolean quietMode, OutputFormat outputFormat) {
+        StringBuilder diagnosis = getDiagnosis(outputFormat);
         System.out.println(diagnosis.toString());
         if (!quietMode){
             printInformation(totalRuleCount, disabledRelevantRuleCount, disabledRuleCount);
         }
     }
 
-    public void outputDiagnostics(String outputFile, int disabledRuleCount, int disabledRelevantRuleCount, int totalRuleCount, boolean override, boolean quietMode){
-        StringBuilder diagnosis = getDiagnosis();
+    public void outputDiagnostics(String outputFile, int disabledRuleCount, int disabledRelevantRuleCount, int totalRuleCount, boolean override, boolean quietMode, OutputFormat outputFormat){
+        StringBuilder diagnosis = getDiagnosis(outputFormat);
         Path currentDir = Paths.get(System.getProperty("user.dir"));
         Path outputPath = Paths.get(outputFile);
         if (!outputPath.isAbsolute()){
@@ -60,27 +61,39 @@ public void outputDiagnostics(String outputFile, int disabledRuleCount, int disa
             System.out.println("WARNING: writing to " + outputPath.toString() + " not successful." + "\n" +
                                 "Output defaults to stdout. You can add flag \"--override\" to overwrite it.\n" + 
                                 "If this message still shows up after adding that flag, check path validity and/or write access.\n");
-            outputDiagnostics(disabledRuleCount, disabledRelevantRuleCount, totalRuleCount, quietMode);
+            outputDiagnostics(disabledRuleCount, disabledRelevantRuleCount, totalRuleCount, quietMode, outputFormat);
         }
         if (!quietMode){
             printInformation(totalRuleCount, disabledRelevantRuleCount, disabledRuleCount);
         }
     }
 
-    private StringBuilder getDiagnosis() {
+    private StringBuilder getDiagnosis(OutputFormat outputFormat) {
         StringBuilder diagnosis = new StringBuilder();
         violationList.sort(Comparator.comparingInt(Violation::lineNumber));
         for (Violation v : violationList) {
-            if (v.representativeMadr().isEmpty()){
-                diagnosis.append(LintContext.USER_PATH + ":" + v.lineNumber() + " " + "[" + v.ruleId() + "]" + " " + v.description() + "\n");
+            String file = v.representativeMadr().orElse(LintContext.USER_PATH);
+            if (outputFormat == OutputFormat.GITHUB_ACTIONS){
+                diagnosis.append("::error file=" + escapeGithubProperty(file) + ",line=" + v.lineNumber() +
+                                 ",title=" + escapeGithubProperty(v.ruleId()) + "::" + escapeGithubData(v.description()) + "\n");
             }
             else {
-                diagnosis.append(v.representativeMadr().get() + ":" + v.lineNumber() + " " + "[" + v.ruleId() + "]" + " " + v.description() + "\n");
+                diagnosis.append(file + ":" + v.lineNumber() + " " + "[" + v.ruleId() + "]" + " " + v.description() + "\n");
             }
         }
         return diagnosis;
     }
 
+    // Escaping mandated by GitHub Actions workflow commands, see
+    // https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands
+    private String escapeGithubData(String value){
+        return value.replace("%", "%25").replace("\r", "%0D").replace("\n", "%0A");
+    }
+
+    private String escapeGithubProperty(String value){
+        return escapeGithubData(value).replace(":", "%3A").replace(",", "%2C");
+    }
+
     private void printInformation(int totalRuleCount, int disabledRelevantRuleCount, int disabledRuleCount){
         StringBuilder info = new StringBuilder();
         int violationCount = violationList.size();

app/src/main/java/neutra1/linter/models/enums/OutputFormat.java

@@ -0,0 +1,26 @@
+package neutra1.linter.models.enums;
+
+public enum OutputFormat {
+    ERRORFORMAT("errorformat"),
+    GITHUB_ACTIONS("github-actions");
+
+    private final String label;
+
+    OutputFormat(String label) {
+        this.label = label;
+    }
+
+    @Override
+    public String toString() {
+        return label;
+    }
+
+    public static OutputFormat fromLabel(String label) {
+        for (OutputFormat format : values()) {
+            if (format.label.equalsIgnoreCase(label)) {
+                return format;
+            }
+        }
+        throw new IllegalArgumentException("expected one of: " + ERRORFORMAT + ", " + GITHUB_ACTIONS);
+    }
+}

madrlint.java

@@ -10,6 +10,7 @@
 //SOURCES app/src/main/java/neutra1/linter/models/enums/LinkType.java
 //SOURCES app/src/main/java/neutra1/linter/models/enums/MandatorySection.java
 //SOURCES app/src/main/java/neutra1/linter/models/enums/OptionalSection.java
+//SOURCES app/src/main/java/neutra1/linter/models/enums/OutputFormat.java
 //SOURCES app/src/main/java/neutra1/linter/models/enums/ResourceType.java
 //SOURCES app/src/main/java/neutra1/linter/models/records/BulletListItemInfo.java
 //SOURCES app/src/main/java/neutra1/linter/models/records/HeadingInfo.java