Rename "configFilePath" to "configurationFilePath" in GradmExtension (#…

…72)
Omico · Aug 9, 2023 · 9993864 · 9993864
1 parent da9aef9
commit 9993864
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 9 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -133,7 +133,7 @@ You can modify the Gradm configuration file name in `gradm/build.gradle.kts`:
 
 ```kotlin
 gradm {
-    configFilePath = "gradm3.yml" // default: "gradm.yml"
+    configurationFilePath = "gradm3.yml" // default: "gradm.yml"
 }
 ```
 

diff --git a/docs/zh-Hans/getting-started.md b/docs/zh-Hans/getting-started.md
@@ -133,7 +133,7 @@ gradm {
 
 ```kotlin
 gradm {
-    configFilePath = "gradm3.yml" // 默认为 "gradm.yml"
+    configurationFilePath = "gradm3.yml" // 默认为 "gradm.yml"
 }
 ```
 

diff --git a/examples/gradm-getting-started/gradm/build.gradle.kts b/examples/gradm-getting-started/gradm/build.gradle.kts
@@ -16,7 +16,7 @@ repositories {
 
 gradm {
     pluginId = "gradm" // default: "me.omico.gradm.generated"
-    configFilePath = "gradm3.yml" // default: "gradm.yml"
+    configurationFilePath = "gradm3.yml" // default: "gradm.yml"
     debug = true // default: false
     format {
         enabled = true // default: true

diff --git a/gradm-gradle-plugin/src/main/kotlin/me/omico/gradm/internal/GradmExtensionImpl.kt b/gradm-gradle-plugin/src/main/kotlin/me/omico/gradm/internal/GradmExtensionImpl.kt
@@ -41,12 +41,12 @@ internal abstract class GradmExtensionImpl @Inject constructor(
 
     override var pluginId: String by pluginDeclaration::id
 
-    override var configFilePath: String
+    override var configurationFilePath: String
         get() = configFileProperty.asFile.getOrElse(project.file("gradm.yml")).absolutePath
         set(value) {
             val file = project.file(value)
-            require(file.exists()) { "The path you assign for the Gradm config file does not exist." }
-            require(file.isFile) { "Gradm config file must be a file." }
+            require(file.exists()) { "Gradm configuration file does not exist in ${file.absolutePath}." }
+            require(file.isFile) { "Gradm configuration file must be a file." }
             configFileProperty.set(file)
         }
 

diff --git a/gradm-gradle-plugin/src/main/kotlin/me/omico/gradm/task/GradmTask.kt b/gradm-gradle-plugin/src/main/kotlin/me/omico/gradm/task/GradmTask.kt
@@ -95,7 +95,7 @@ abstract class GradmTask : DefaultTask() {
         offlineProperty.set(gradle.startParameter.isOffline)
         workerServiceProperty.set(gradmWorkerServiceProvider)
         projectNameProperty.set(gradmExtension.projectName)
-        configurationFileProperty.set(projectLayout.gradmConfigurationFile(gradmExtension.configFilePath))
+        configurationFileProperty.set(projectLayout.gradmConfigurationFile(gradmExtension.configurationFilePath))
     }
 
     companion object {

diff --git a/gradm-runtime/src/main/kotlin/me/omico/gradm/GradmExtension.kt b/gradm-runtime/src/main/kotlin/me/omico/gradm/GradmExtension.kt
@@ -31,11 +31,11 @@ interface GradmExtension : ExtensionAware {
     var pluginId: String
 
     /**
-     * The Gradm config file path.
+     * The Gradm configuration file path.
      *
      * The default value is `./gradm.yml`.
      */
-    var configFilePath: String
+    var configurationFilePath: String
 
     /**
      * Enable debug mode for Gradm.
-Original file line number
+Diff line change
@@ Expand Up @@
     ```kotlin
     gradm {
-        configFilePath = "gradm3.yml" // default: "gradm.yml"
+        configurationFilePath = "gradm3.yml" // default: "gradm.yml"
     }
     ```
@@ Expand Down @@