Add the possibility to show the default values for parameters

CHANGES.md

@@ -26,6 +26,7 @@
 - Fix sslr-magik-toolkit's "Evaluate XPath"-button.
 - Add UndefinedVariable check to Sonar way profile.
 - Add ability to override aliases path and environment path in tasks in VSCode extension.
+- Add `--with-default-values` option to `magik-lint`/`magik-typed-lint` to show the default values for parameters.
 - Several fixes.
 
 ### Breaking changes (reiterated from above)

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/MagikCheckHolder.java

@@ -10,6 +10,7 @@
 import java.util.Set;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
+import java.util.stream.Collectors;
 import org.sonar.check.Rule;
 
 /** MagicCheck holder/factory. */
@@ -21,18 +22,25 @@ public static class Parameter {
     private final String name;
     private final String description;
     private final Object value;
+    private final Object defaultValue;
 
     /**
      * Constructor.
      *
      * @param name Name of parameter.
      * @param description Description of parameter.
      * @param value Value of parameter.
+     * @param defaultValue Default value of parameter.
      */
-    public Parameter(final String name, final String description, final @Nullable Object value) {
+    public Parameter(
+        final String name,
+        final String description,
+        final @Nullable Object value,
+        final @Nullable Object defaultValue) {
       this.name = name;
       this.description = description;
       this.value = value;
+      this.defaultValue = defaultValue;
     }
 
     public String getName() {
@@ -45,7 +53,16 @@ public String getDescription() {
 
     @CheckForNull
     public Object getValue() {
-      return this.value;
+      return this.value != null ? this.value : this.defaultValue;
+    }
+
+    @CheckForNull
+    public Object getDefaultValue() {
+      return this.defaultValue;
+    }
+
+    public boolean isExplicitlySet() {
+      return this.value != null;
     }
   }
 
@@ -71,6 +88,10 @@ public MagikCheckHolder(
     this.metadata = null;
   }
 
+  private Set<Parameter> explicitlySetParameters() {
+    return this.parameters.stream().filter(Parameter::isExplicitlySet).collect(Collectors.toSet());
+  }
+
   /**
    * Get the wrapped check.
    *
@@ -81,7 +102,8 @@ public MagikCheck createCheck() throws ReflectiveOperationException {
     final MagikCheck check = this.checkClass.getDeclaredConstructor().newInstance();
     check.setHolder(this);
 
-    for (final Parameter parameter : this.parameters) {
+    final Set<Parameter> explicitlySetParameters = this.explicitlySetParameters();
+    for (final Parameter parameter : explicitlySetParameters) {
       final String name = parameter.getName();
       final Object value = parameter.getValue();
       check.setParameter(name, value);

magik-checks/src/main/java/nl/ramsolutions/sw/magik/checks/MagikChecksConfiguration.java

@@ -68,31 +68,28 @@ public List<MagikCheckHolder> getAllChecks() {
                   ruleProperty -> {
                     final String propertyKey = MagikChecksConfiguration.propertyKey(ruleProperty);
                     final String configKey = checkKey + "." + propertyKey;
-                    if (!this.properties.hasProperty(configKey)) {
-                      return null;
-                    }
-
-                    // Store parameter.
                     final String description = ruleProperty.description();
-                    final MagikCheckHolder.Parameter parameter;
-                    if (ruleProperty.type().equals("INTEGER")) {
-                      final Integer configValue = this.properties.getPropertyInteger(configKey);
-                      parameter =
-                          new MagikCheckHolder.Parameter(configKey, description, configValue);
-                    } else if (ruleProperty.type().equals("STRING")) {
-                      final String configValue = this.properties.getPropertyString(configKey);
-                      parameter =
-                          new MagikCheckHolder.Parameter(configKey, description, configValue);
-                    } else if (ruleProperty.type().equals("BOOLEAN")) {
-                      final Boolean configValue = this.properties.getPropertyBoolean(configKey);
-                      parameter =
-                          new MagikCheckHolder.Parameter(configKey, description, configValue);
-                    } else {
-                      throw new IllegalStateException(
-                          "Unknown type for property: " + ruleProperty.type());
+                    Object configValue = null;
+                    Object defaultValue = ruleProperty.defaultValue();
+
+                    // Get configured value if it exists
+                    if (this.properties.hasProperty(configKey)) {
+                      if (ruleProperty.type().equals("INTEGER")) {
+                        configValue = this.properties.getPropertyInteger(configKey);
+                        defaultValue = Integer.parseInt(ruleProperty.defaultValue());
+                      } else if (ruleProperty.type().equals("STRING")) {
+                        configValue = this.properties.getPropertyString(configKey);
+                      } else if (ruleProperty.type().equals("BOOLEAN")) {
+                        configValue = this.properties.getPropertyBoolean(configKey);
+                        defaultValue = Boolean.parseBoolean(ruleProperty.defaultValue());
+                      } else {
+                        throw new IllegalStateException(
+                            "Unknown type for property: " + ruleProperty.type());
+                      }
                     }
 
-                    return parameter;
+                    return new MagikCheckHolder.Parameter(
+                        configKey, description, configValue, defaultValue);
                   })
               .filter(Objects::nonNull)
               .collect(Collectors.toSet());

magik-lint/src/main/java/nl/ramsolutions/sw/magik/lint/MagikLint.java

@@ -86,14 +86,15 @@ private List<MagikIssue> runCheckOnFile(final MagikFile magikFile, final MagikCh
   }
 
   /**
-   * Show checks active and inactive checks.
+   * Show enabled and disabled checks.
    *
    * @param writer Writer Write to write output to.
    * @param showDisabled boolean Boolean to show disabled checks or not.
+   * @param showDefaultValues boolean Boolean to show default values for parameters or not.
    * @throws ReflectiveOperationException -
    * @throws IOException -
    */
-  void showChecks(final Writer writer, final boolean showDisabled)
+  void showChecks(final Writer writer, final boolean showDisabled, boolean showDefaultValues)
       throws ReflectiveOperationException, IOException {
     final MagikChecksConfiguration checksConfig =
         new MagikChecksConfiguration(CheckList.getChecks(), this.properties);
@@ -106,42 +107,68 @@ void showChecks(final Writer writer, final boolean showDisabled)
         continue;
       }
 
-      for (final MagikCheckHolder.Parameter parameter : holder.getParameters()) {
-        writer.write(
-            "\t"
-                + parameter.getName()
-                + ":\t"
-                + parameter.getValue()
-                + " "
-                + "("
-                + parameter.getDescription()
-                + ")\n");
+      this.showParameters(writer, holder, showDefaultValues);
+    }
+  }
+
+  /**
+   * Show parameters for a check.
+   *
+   * @param writer Writer Write to write output to.
+   * @param showDefaultValues boolean Boolean to show default values for parameters or not.
+   * @throws ReflectiveOperationException -
+   * @throws IOException -
+   */
+  private void showParameters(
+      final Writer writer, final MagikCheckHolder holder, final boolean showDefaultValues)
+      throws ReflectiveOperationException, IOException {
+    for (final MagikCheckHolder.Parameter parameter : holder.getParameters()) {
+      if (!parameter.isExplicitlySet() && !showDefaultValues) {
+        continue;
       }
+      final String defaultIndicator = !parameter.isExplicitlySet() ? " (default)" : "";
+      writer.write(
+          " ".repeat(2)
+              + "*"
+              + defaultIndicator
+              + " "
+              + parameter.getName()
+              + ":"
+              + " "
+              + parameter.getValue()
+              + " "
+              + "("
+              + parameter.getDescription()
+              + ")\n");
     }
   }
 
   /**
    * Show enabled checks.
    *
    * @param writer Writer Write to write output to.
+   * @param showDefaultValues boolean Boolean to show default values for parameters or not.
    * @throws ReflectiveOperationException -
    * @throws IOException -
    */
-  void showEnabledChecks(final Writer writer) throws ReflectiveOperationException, IOException {
+  void showEnabledChecks(final Writer writer, final Boolean showDefaultValues)
+      throws ReflectiveOperationException, IOException {
     writer.write("Enabled checks:\n");
-    this.showChecks(writer, false);
+    this.showChecks(writer, false, showDefaultValues);
   }
 
   /**
    * Show disabled checks.
    *
    * @param writer Writer Write to write output to.
+   * @param showDefaultValues boolean Boolean to show default values for parameters or not.
    * @throws ReflectiveOperationException -
    * @throws IOException -
    */
-  void showDisabledChecks(final Writer writer) throws ReflectiveOperationException, IOException {
+  void showDisabledChecks(final Writer writer, final boolean showDefaultValues)
+      throws ReflectiveOperationException, IOException {
     writer.write("Disabled checks:\n");
-    this.showChecks(writer, true);
+    this.showChecks(writer, true, showDefaultValues);
   }
 
   /**

magik-lint/src/main/java/nl/ramsolutions/sw/magik/lint/Main.java

@@ -50,6 +50,11 @@ public final class Main {
           .build();
   private static final Option OPTION_SHOW_CHECKS =
       Option.builder().longOpt("show-checks").desc("Show checks and exit").build();
+  private static final Option OPTION_WITH_DEFAULT_VALUES =
+      Option.builder()
+          .longOpt("with-default-values")
+          .desc("Show default values when showing checks")
+          .build();
   private static final Option OPTION_COLUMN_OFFSET =
       Option.builder()
           .longOpt("column-offset")
@@ -64,26 +69,28 @@ public final class Main {
           .hasArg()
           .type(PatternOptionBuilder.NUMBER_VALUE)
           .build();
+  private static final Option OPTION_APPLY_FIXES =
+      Option.builder().longOpt("apply-fixes").desc("Apply fixes automatically").build();
+
   private static final Option OPTION_DEBUG =
       Option.builder().longOpt("debug").desc("Enable showing of debug information").build();
   private static final Option OPTION_VERSION =
       Option.builder().longOpt("version").desc("Show version and exit").build();
   private static final Option OPTION_HELP =
       Option.builder().longOpt("help").desc("Show this help and exit").build();
-  private static final Option OPTION_APPLY_FIXES =
-      Option.builder().longOpt("apply-fixes").desc("Apply fixes automatically").build();
 
   static {
     OPTIONS = new Options();
     OPTIONS.addOption(OPTION_HELP);
     OPTIONS.addOption(OPTION_MSG_TEMPLATE);
     OPTIONS.addOption(OPTION_RCFILE);
     OPTIONS.addOption(OPTION_SHOW_CHECKS);
+    OPTIONS.addOption(OPTION_WITH_DEFAULT_VALUES);
     OPTIONS.addOption(OPTION_COLUMN_OFFSET);
     OPTIONS.addOption(OPTION_MAX_INFRACTIONS);
+    OPTIONS.addOption(OPTION_APPLY_FIXES);
     OPTIONS.addOption(OPTION_DEBUG);
     OPTIONS.addOption(OPTION_VERSION);
-    OPTIONS.addOption(OPTION_APPLY_FIXES);
   }
 
   private static final Map<String, Integer> SEVERITY_EXIT_CODE_MAPPING =
@@ -175,6 +182,13 @@ public static void main(final String[] args)
       Main.initDebugLogger();
     }
 
+    if (commandLine.hasOption(OPTION_WITH_DEFAULT_VALUES)
+        && !commandLine.hasOption(OPTION_SHOW_CHECKS)) {
+      final PrintStream errStream = Main.getErrStream();
+      errStream.println("--with-default-values can only be used with --show-checks");
+      System.exit(1);
+    }
+
     if (commandLine.hasOption(OPTION_VERSION)) {
       final String version = Main.class.getPackage().getImplementationVersion();
       final PrintStream errStream = Main.getErrStream();
@@ -183,24 +197,7 @@ public static void main(final String[] args)
     }
 
     // Read configuration.
-    final MagikToolsProperties properties;
-    if (commandLine.hasOption(OPTION_RCFILE)) {
-      final File rcfile = (File) commandLine.getParsedOptionValue(OPTION_RCFILE);
-      final Path path = rcfile.toPath();
-      if (!Files.exists(path)) {
-        final PrintStream errStream = Main.getErrStream();
-        errStream.println("RC File does not exist: " + path);
-
-        System.exit(1);
-      }
-      properties = new MagikToolsProperties(path);
-    } else {
-      final Path currentWorkingPath = Path.of(".");
-      final Path path = ConfigurationLocator.locateConfiguration(currentWorkingPath);
-      properties =
-          path != null ? new MagikToolsProperties(path) : MagikToolsProperties.DEFAULT_PROPERTIES;
-    }
-
+    final MagikToolsProperties properties = Main.loadProperties(commandLine);
     // Copy configuration from command line.
     Main.copyOptionsToConfig(commandLine, properties);
 
@@ -210,8 +207,9 @@ public static void main(final String[] args)
       final MagikLint lint = new MagikLint(properties, reporter);
       final PrintStream outStream = Main.getOutStream();
       final Writer writer = new PrintWriter(outStream);
-      lint.showEnabledChecks(writer);
-      lint.showDisabledChecks(writer);
+      final boolean showDefaultValues = commandLine.hasOption(OPTION_WITH_DEFAULT_VALUES);
+      lint.showEnabledChecks(writer, showDefaultValues);
+      lint.showDisabledChecks(writer, showDefaultValues);
       writer.flush();
       System.exit(0);
     }
@@ -246,6 +244,27 @@ public static void main(final String[] args)
     System.exit(exitCode);
   }
 
+  private static MagikToolsProperties loadProperties(final CommandLine commandLine)
+      throws ParseException, IOException {
+    if (commandLine.hasOption(OPTION_RCFILE)) {
+      final File rcfile = (File) commandLine.getParsedOptionValue(OPTION_RCFILE);
+      final Path path = rcfile.toPath();
+      if (!Files.exists(path)) {
+        final PrintStream errStream = Main.getErrStream();
+        errStream.println("RC File does not exist: " + path);
+
+        System.exit(1);
+      }
+      return new MagikToolsProperties(path);
+    } else {
+      final Path currentWorkingPath = Path.of(".");
+      final Path path = ConfigurationLocator.locateConfiguration(currentWorkingPath);
+      return path != null
+          ? new MagikToolsProperties(path)
+          : MagikToolsProperties.DEFAULT_PROPERTIES;
+    }
+  }
+
   private static void copyOptionsToConfig(
       final CommandLine commandLine, final MagikToolsProperties properties) {
     if (commandLine.hasOption(OPTION_MAX_INFRACTIONS)) {