Add yml file extension support

Author: Kyle-Ye

Plugins/OpenAPIGenerator/plugin.swift

@@ -28,17 +28,20 @@ struct SwiftOpenAPIGeneratorPlugin {
                     "Incompatible target called '\(targetName)'. Only Swift source targets can be used with the Swift OpenAPI generator plugin."
             case .noConfigFound(let targetName):
                 return
-                    "No config found in the target named '\(targetName)'. Add a file called 'openapi-generator-config.yaml' to the target's source directory. See documentation for details."
+                    "No config found in the target named '\(targetName)'. Add a file called 'openapi-generator-config.yaml' or 'openapi-generator-config.yml' to the target's source directory. See documentation for details."
             case .noDocumentFound(let targetName):
                 return
-                    "No OpenAPI document found in the target named '\(targetName)'. Add a file called 'openapi.yaml' or 'openapi.json' (can also be a symlink) to the target's source directory. See documentation for details."
+                    "No OpenAPI document found in the target named '\(targetName)'. Add a file called 'openapi.yaml', 'openapi.yml' or 'openapi.json' (can also be a symlink) to the target's source directory. See documentation for details."
             }
         }
 
         var errorDescription: String? {
             description
         }
     }
+    
+    private var supportedConfigFiles: Set<String> { Set(["yaml", "yml"].map { "openapi-generator-config." + $0 }) }
+    private var supportedDocFiles: Set<String> { Set(["yaml", "yml", "json"].map { "openapi." + $0 }) }
 
     func createBuildCommands(
         pluginWorkDirectory: PackagePlugin.Path,
@@ -47,21 +50,14 @@ struct SwiftOpenAPIGeneratorPlugin {
         targetName: String
     ) throws -> [Command] {
         let inputFiles = sourceFiles
-        guard let config = inputFiles.first(where: { $0.path.lastComponent == "openapi-generator-config.yaml" })?.path
-        else {
+        guard let config = inputFiles.first(where: {
+            supportedConfigFiles.contains($0.path.lastComponent)
+        })?.path else {
             throw Error.noConfigFound(targetName: targetName)
         }
-        guard
-            let doc = inputFiles.first(where: {
-                switch $0.path.lastComponent {
-                case "openapi.yaml", "openapi.json":
-                    return true
-                default:
-                    return false
-                }
-            })?
-            .path
-        else {
+        guard let doc = inputFiles.first(where: {
+            supportedDocFiles.contains($0.path.lastComponent)
+        })?.path else {
             throw Error.noDocumentFound(targetName: targetName)
         }
         let genSourcesDir = pluginWorkDirectory.appending("GeneratedSources")

Sources/swift-openapi-generator/Documentation.docc/Articles/Configuring-the-generator.md

@@ -10,7 +10,9 @@ The command-line tool also uses the same configuration file.
 
 ### Create a configuration file
 
-The configuration file is named `openapi-generator-config.yaml` and must exist in the target source directory.
+The configuration file is named `openapi-generator-config.yaml` or `openapi-generator-config.yml` and must exist in the target source directory.
+
+> In the following tutorial, we will use `openapi-generator-config.yaml` as an example.
 
 ```
 .

scripts/check-license-headers.sh

@@ -62,8 +62,10 @@ read -ra PATHS_TO_CHECK_FOR_LICENSE <<< "$( \
   ":(exclude)**/Package.resolved" \
   ":(exclude)**/README.md" \
   ":(exclude)**/openapi.yaml" \
+  ":(exclude)**/openapi.yml" \
   ":(exclude)**/petstore.yaml" \
   ":(exclude)**/openapi-generator-config.yaml" \
+  ":(exclude)**/openapi-generator-config.yml" \
   | xargs -0 \
 )"