move the names of things closer to the actual class

Author: TheSnoozer

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

@@ -20,7 +20,6 @@
 import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.plugins.ExtensionAware;
-import pl.project13.core.CommitIdPropertiesOutputFormat;
 
 /**
  * The GitCommitIdPlugin or also known as git-commit-id-gradle-plugin is a plugin
@@ -64,21 +63,21 @@
  * to {@link GitCommitIdPluginGenerationTask}.
  */
 public class GitCommitIdPlugin implements Plugin<Project> {
-    public static final String GIT_COMMIT_ID_EXTENSION_NAME = "gitCommitId";
-    public static final String GIT_COMMIT_ID_TASK_NAME = "gitCommitIdGenerationTask";
-
     /**
      * Apply this plugin to the given target project.
      *
      * @param project The target project
      */
     public void apply(Project project) {
         var extension = project.getExtensions().create(
-                GIT_COMMIT_ID_EXTENSION_NAME, GitCommitIdPluginExtension.class);
+            GitCommitIdPluginExtension.NAME,
+            GitCommitIdPluginExtension.class);
         ((ExtensionAware) extension).getExtensions().create(
-            "outputSettings", GitCommitIdPluginOutputSettingsExtension.class);
+            GitCommitIdPluginOutputSettingsExtension.NAME,
+            GitCommitIdPluginOutputSettingsExtension.class);
         var task = project.getTasks().create(
-                GIT_COMMIT_ID_TASK_NAME, GitCommitIdPluginGenerationTask.class);
+            GitCommitIdPluginGenerationTask.NAME,
+            GitCommitIdPluginGenerationTask.class);
         task.onlyIf(ignore -> extension.getSkip().get() == false);
     }
 }

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

@@ -22,10 +22,8 @@
 import javax.inject.Inject;
 import org.gradle.api.file.DirectoryProperty;
 import org.gradle.api.file.ProjectLayout;
-import org.gradle.api.file.RegularFileProperty;
 import org.gradle.api.provider.ListProperty;
 import org.gradle.api.provider.Property;
-import pl.project13.core.CommitIdPropertiesOutputFormat;
 import pl.project13.core.git.GitDescribeConfig;
 
 /**
@@ -52,6 +50,17 @@
  * </pre>
  */
 public abstract class GitCommitIdPluginExtension {
+    /**
+     * Name of the extension how it's made available to the end-user as
+     * DSL like configuration in the {@code build.gradle}:
+     * <pre>
+     * gitCommitId {
+     *     skip.set(false)
+     * }
+     * </pre>.
+     */
+    public static final String NAME = "gitCommitId";
+
     /**
      * Configuration option to enable or disable more verbose information during the
      * execution of the plugin.

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

@@ -53,6 +53,12 @@
  */
 @CacheableTask
 public class GitCommitIdPluginGenerationTask extends DefaultTask {
+    /**
+     * Name of the task how it's made available to the end-user's
+     * task execution graph.
+     */
+    public static final String NAME = "gitCommitIdGenerationTask";
+
     /**
      * The {@link GitCommitIdPluginExtension} that serves as configuration of the plugin / task.
      *

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

@@ -43,6 +43,20 @@
  * {@link GitCommitIdPluginGenerationTask}.
  */
 public abstract class GitCommitIdPluginOutputSettingsExtension {
+    /**
+     * Name of the extension how it's made available to the end-user as
+     * DSL like configuration in the {@code build.gradle}:
+     * <pre>
+     * gitCommitId {
+     *     outputSettings {
+     *         shouldGenerateOutputFile.set(true)
+     *     }
+     * }
+     * </pre>
+     * As may notice this extension is made available as "nested" extension
+     * of the {@link GitCommitIdPluginExtension}.
+     */
+    public static final String NAME = "outputSettings";
 
     /**
      * Configuration option to enable or disable the generation of an output file.
@@ -85,7 +99,8 @@ public abstract class GitCommitIdPluginOutputSettingsExtension {
      * 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>
+     * <p>Only applies if the {@link #getOutputFormat()} is instructed
+     * to generate a "properties" file</p>
      */
     public abstract Property<Boolean> getShouldEscapedUnicodeForPropertiesOutput();
 

src/test/groovy/io.github.git.commit.id.gradle.plugin/GradleCompabilityTest.groovy

@@ -27,22 +27,22 @@ class GradleCompabilityTest extends AbstractGradleTest {
         def result = runner.build()
         Assertions.assertEquals(
                 TaskOutcome.SUCCESS,
-                result.task(":${GitCommitIdPlugin.GIT_COMMIT_ID_TASK_NAME}")?.outcome,
+                result.task(":${GitCommitIdPluginGenerationTask.NAME}")?.outcome,
                 result.output
         )
 
         and: "running it again should yield an up-to-date"
         result = runner.build()
         Assertions.assertEquals(
                 TaskOutcome.UP_TO_DATE,
-                result.task(":${GitCommitIdPlugin.GIT_COMMIT_ID_TASK_NAME}")?.outcome,
+                result.task(":${GitCommitIdPluginGenerationTask.NAME}")?.outcome,
                 result.output
         )
     }
 
     private static Stream<Arguments> getGradleTestParams() {
         return Stream.of(
-                Arguments.of("8.1.1", Arrays.asList("${GitCommitIdPlugin.GIT_COMMIT_ID_TASK_NAME}")),
+                Arguments.of("8.1.1", Arrays.asList("${GitCommitIdPluginGenerationTask.NAME}")),
                 /*
                 Arguments.of("8.1"),
                 Arguments.of("8.0.2"),

src/test/groovy/io.github.git.commit.id.gradle.plugin/GradleIntegrationTest.groovy

@@ -12,14 +12,14 @@ class GradleIntegrationTest extends AbstractGradleTest {
     private GradleRunner createRunner(projectDir) {
         GradleRunner.create()
                 .withPluginClasspath()
-                .withArguments(":${GitCommitIdPlugin.GIT_COMMIT_ID_TASK_NAME}", "--stacktrace", "--debug")
+                .withArguments(":${GitCommitIdPluginGenerationTask.NAME}", "--stacktrace", "--debug")
                 .withProjectDir(projectDir)
     }
 
     private void assertTaskOutcome(BuildResult result, TaskOutcome expectedTaskOutcome) {
         Assertions.assertEquals(
                 expectedTaskOutcome,
-                result.task(":${GitCommitIdPlugin.GIT_COMMIT_ID_TASK_NAME}")?.outcome,
+                result.task(":${GitCommitIdPluginGenerationTask.NAME}")?.outcome,
                 result.output
         )
     }
@@ -33,7 +33,7 @@ class GradleIntegrationTest extends AbstractGradleTest {
         new File(projectDir, "build.gradle").withWriterAppend("UTF-8") {
             it.write(
                     """
-                    ${GitCommitIdPlugin.GIT_COMMIT_ID_EXTENSION_NAME} {
+                    ${GitCommitIdPluginExtension.NAME} {
                         skip.set($shouldSkip)
                     }
                     """.stripIndent()
@@ -89,9 +89,9 @@ class GradleIntegrationTest extends AbstractGradleTest {
         new File(projectDir, "build.gradle").withWriterAppend("UTF-8") {
             it.write(
                     """
-                    ${GitCommitIdPlugin.GIT_COMMIT_ID_EXTENSION_NAME} {
+                    ${GitCommitIdPluginExtension.NAME} {
                         outputSettings {
-                            generateGitPropertiesFile.set(true)
+                            shouldGenerateOutputFile.set(true)
                         }
                     }
                     """.stripIndent()