drop the name 'properties' from the configruation options, since we can generate a json output file, a yml, xml, ....just avoids confusion

Author: TheSnoozer

src/main/java/io/github/git/commit/id/gradle/plugin/GitCommitIdPluginGenerationTask.java

@@ -91,7 +91,7 @@ public DirectoryProperty getInput() {
      */
     @OutputFile
     public RegularFileProperty getOutput() {
-        return getGitCommitIdPluginOutputSettingsExtension().getGenerateGitPropertiesFilename();
+        return getGitCommitIdPluginOutputSettingsExtension().getOutputFile();
     }
 
     /**
@@ -240,7 +240,7 @@ public File getDotGitDirectory() {
             @Override
             public boolean shouldGenerateGitPropertiesFile() {
                 return getGitCommitIdPluginOutputSettingsExtension()
-                    .getGenerateGitPropertiesFile().get();
+                    .getShouldGenerateOutputFile().get();
             }
 
             @Override
@@ -256,7 +256,7 @@ public void performPropertiesReplacement(Properties properties) {
             @Override
             public CommitIdPropertiesOutputFormat getPropertiesOutputFormat() {
                 return getGitCommitIdPluginOutputSettingsExtension()
-                    .getGenerateGitPropertiesFormat()
+                    .getOutputFormat()
                     .get();
             }
 
@@ -280,7 +280,7 @@ public File getProjectBaseDir() {
             @Override
             public File getGenerateGitPropertiesFile() {
                 return getGitCommitIdPluginOutputSettingsExtension()
-                    .getGenerateGitPropertiesFilename()
+                    .getOutputFile()
                     .get().getAsFile();
             }
 
@@ -300,7 +300,7 @@ public Charset getPropertiesSourceCharset() {
             @Override
             public boolean shouldPropertiesEscapeUnicode() {
                 return getGitCommitIdPluginOutputSettingsExtension()
-                    .getGenerateGitPropertiesFileWithEscapedUnicode().get();
+                    .getShouldEscapedUnicodeForPropertiesOutput().get();
             }
         };
 

src/main/java/io/github/git/commit/id/gradle/plugin/GitCommitIdPluginOutputSettingsExtension.java

@@ -45,26 +45,26 @@
 public abstract class GitCommitIdPluginOutputSettingsExtension {
 
     /**
-     * Configuration option to enable or disable the generation of a properties file.
+     * Configuration option to enable or disable the generation of an output file.
      * To enable such generation, set this to {@code true}.
      * By default, this setting is disabled (set to {@code false}).
      *
-     * <p>To configure the location of the properties file refer to
-     * {@link #getGenerateGitPropertiesFilename()}, to configure the format (json, properties, ...)
-     * of this file refer to {@link #getGenerateGitPropertiesFormat()}.
+     * <p>To configure the location of the output file refer to
+     * {@link #getOutputFile()}, to configure the format (json, properties, ...)
+     * of this file refer to {@link #getOutputFormat()}.
      */
-    public abstract Property<Boolean> getGenerateGitPropertiesFile();
+    public abstract Property<Boolean> getShouldGenerateOutputFile();
 
     /**
-     * Configuration location of a properties file that can be generated by the plugin.
-     * Defaults to {@code ${project.getBuildDir()}/git.properties}.
+     * Configuration location of an output file that can be generated by the plugin.
+     * Defaults to {@code ${project.getBuildDir()}/git.properties}, formatted as "properties" file.
      *
-     * <p>To enable or disable the generation of such properties file refer to
-     * {@link #getGenerateGitPropertiesFile()}, to configure the format (json, properties, ...)
-     * of this file refer to {@link #getGenerateGitPropertiesFormat()}.
+     * <p>To enable or disable the generation of such output file refer to
+     * {@link #getShouldGenerateOutputFile()}, to configure the format (json, properties, ...)
+     * of this file refer to {@link #getOutputFormat()}.
      */
     // @OutputFile
-    public abstract RegularFileProperty getGenerateGitPropertiesFilename();
+    public abstract RegularFileProperty getOutputFile();
 
     /**
      * Configuration option to enable or disable unicode escaping in the generated properties file.
@@ -84,19 +84,21 @@ public abstract class GitCommitIdPluginOutputSettingsExtension {
      * <p>Hence by default this setting is set to {@code false}.
      * If you so desire and wish for unicode escaping (e.g. \\u6E2C\\u8A66\\u4E2D\\u6587) you
      * can set this to {@code true}.
+     *
+     * <p>Only applies if the {@link #getOutputFormat()} is instructed to generate a "properties" file</p>
      */
-    public abstract Property<Boolean> getGenerateGitPropertiesFileWithEscapedUnicode();
+    public abstract Property<Boolean> getShouldEscapedUnicodeForPropertiesOutput();
 
     /**
-     * Allows to configure the format (json, properties, ...) in which the properties
+     * Allows to configure the format (json, properties, ...) in which the output file
      * should be saved in.
      * To enable or disable the generation of such properties file refer to
-     * {@link #getGenerateGitPropertiesFile()} and to configure the location
-     * of the properties file refer to {@link #getGenerateGitPropertiesFilename()}.
+     * {@link #getShouldGenerateOutputFile()} and to configure the location
+     * of the properties file refer to {@link #getOutputFile()}.
      *
      * <p>By default will assume that the desired format is "properties".
      */
-    public abstract Property<CommitIdPropertiesOutputFormat> getGenerateGitPropertiesFormat();
+    public abstract Property<CommitIdPropertiesOutputFormat> getOutputFormat();
 
     @Inject
     public ProjectLayout getProjectLayout() {
@@ -108,12 +110,12 @@ public ProjectLayout getProjectLayout() {
      */
     @Inject
     public GitCommitIdPluginOutputSettingsExtension() {
-        getGenerateGitPropertiesFile()
+        getShouldGenerateOutputFile()
             .convention(false);
-        getGenerateGitPropertiesFilename().convention(
+        getOutputFile().convention(
             getProjectLayout().getBuildDirectory().file("git.properties"));
-        getGenerateGitPropertiesFileWithEscapedUnicode().convention(false);
-        getGenerateGitPropertiesFormat()
+        getShouldEscapedUnicodeForPropertiesOutput().convention(false);
+        getOutputFormat()
             .convention(CommitIdPropertiesOutputFormat.PROPERTIES);
     }
 }