[#61] feat: allow customizing enum type name (#67)

Author: krzema12

README.md

@@ -182,6 +182,8 @@ inputs:
 
 Multiple possible values.
 
+You can also optionally define `name` which is a hint for code generators what name can be used as enum type name.
+
 Example:
 ```yaml
 ...
@@ -192,5 +194,11 @@ inputs:
       - user
       - admin
       - guest
+  if_mention:
+    type: enum
+    name: MentionStatus
+    allowed-values:
+      - success
+      - failure
     ...
 ```

src/main/kotlin/it/krzeminski/githubactionstyping/parsing/TypesManifestParsing.kt

@@ -14,6 +14,7 @@ data class TypesManifest(
 @Serializable
 data class ApiItem(
     val type: String? = null,
+    val name: String? = null,
     @SerialName("allowed-values")
     val allowedValues: List<String>? = null,
     val separator: String? = null,

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/Boolean.kt

@@ -4,6 +4,9 @@ import it.krzeminski.githubactionstyping.parsing.ApiItem
 import it.krzeminski.githubactionstyping.validation.ItemValidationResult
 
 fun ApiItem.validateBoolean(): ItemValidationResult {
+    if (this.name != null) {
+        return ItemValidationResult.Invalid("'name' is not allowed for this type.")
+    }
     if (this.allowedValues != null) {
         return ItemValidationResult.Invalid("'allowed-values' is not allowed for this type.")
     }

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/Float.kt

@@ -4,6 +4,9 @@ import it.krzeminski.githubactionstyping.parsing.ApiItem
 import it.krzeminski.githubactionstyping.validation.ItemValidationResult
 
 fun ApiItem.validateFloat(): ItemValidationResult {
+    if (this.name != null) {
+        return ItemValidationResult.Invalid("'name' is not allowed for this type.")
+    }
     if (this.allowedValues != null) {
         return ItemValidationResult.Invalid("'allowed-values' is not allowed for this type.")
     }

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/Integer.kt

@@ -4,6 +4,9 @@ import it.krzeminski.githubactionstyping.parsing.ApiItem
 import it.krzeminski.githubactionstyping.validation.ItemValidationResult
 
 fun ApiItem.validateInteger(): ItemValidationResult {
+    if (this.name != null) {
+        return ItemValidationResult.Invalid("'name' is not allowed for this type.")
+    }
     if (this.allowedValues != null) {
         return ItemValidationResult.Invalid("'allowed-values' is not allowed for this type.")
     }

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/List.kt

@@ -5,6 +5,9 @@ import it.krzeminski.githubactionstyping.validation.ItemValidationResult
 import it.krzeminski.githubactionstyping.validation.validate
 
 fun ApiItem.validateList(): ItemValidationResult {
+    if (this.name != null) {
+        return ItemValidationResult.Invalid("'name' is not allowed for this type.")
+    }
     if (this.listItem == null) {
         return ItemValidationResult.Invalid("List item information must be specified.")
     }

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/String.kt

@@ -4,6 +4,9 @@ import it.krzeminski.githubactionstyping.parsing.ApiItem
 import it.krzeminski.githubactionstyping.validation.ItemValidationResult
 
 fun ApiItem.validateString(): ItemValidationResult {
+    if (this.name != null) {
+        return ItemValidationResult.Invalid("'name' is not allowed for this type.")
+    }
     if (this.allowedValues != null) {
         return ItemValidationResult.Invalid("'allowed-values' is not allowed for this type.")
     }

src/test/kotlin/it/krzeminski/githubactionstyping/validation/ManifestValidationTest.kt

@@ -40,6 +40,11 @@ class ManifestValidationTest : FunSpec({
             val manifest = TypesManifest(
                 inputs = mapOf(
                     "enum-input" to ApiItem(type = "enum", allowedValues = listOf("foo", "bar", "baz")),
+                    "enum-input-with-custom-item-name" to ApiItem(
+                        type = "enum",
+                        name = "SomeItemName",
+                        allowedValues = listOf("foo", "bar", "baz"),
+                    ),
                 ),
             )
 
@@ -51,6 +56,7 @@ class ManifestValidationTest : FunSpec({
                 overallResult = ItemValidationResult.Valid,
                 inputs = mapOf(
                     "enum-input" to ItemValidationResult.Valid,
+                    "enum-input-with-custom-item-name" to ItemValidationResult.Valid,
                 ),
             )
         }
@@ -468,5 +474,33 @@ class ManifestValidationTest : FunSpec({
                 ),
             )
         }
+
+        test("non-enum types with 'name' attribute") {
+            // given
+            val manifest = TypesManifest(
+                inputs = mapOf(
+                    "string-input" to ApiItem(type = "string", name = "SomeName"),
+                    "boolean-input" to ApiItem(type = "boolean", name = "SomeName"),
+                    "integer-input" to ApiItem(type = "integer", name = "SomeName"),
+                    "float-input" to ApiItem(type = "float", name = "SomeName"),
+                    "list-input" to ApiItem(type = "list", name = "SomeName", separator = ",", listItem = ApiItem(type = "string")),
+                ),
+            )
+
+            // when
+            val result = manifest.validate()
+
+            // then
+            result shouldBe ActionValidationResult(
+                overallResult = ItemValidationResult.Invalid("Some typing is invalid."),
+                inputs = mapOf(
+                    "string-input" to ItemValidationResult.Invalid("'name' is not allowed for this type."),
+                    "boolean-input" to ItemValidationResult.Invalid("'name' is not allowed for this type."),
+                    "integer-input" to ItemValidationResult.Invalid("'name' is not allowed for this type."),
+                    "float-input" to ItemValidationResult.Invalid("'name' is not allowed for this type."),
+                    "list-input" to ItemValidationResult.Invalid("'name' is not allowed for this type."),
+                ),
+            )
+        }
     }
 })