Idiomatic naming strategy as opt-in

Sources/_OpenAPIGeneratorCore/Config.swift

@@ -17,15 +17,11 @@ public enum NamingStrategy: String, Sendable, Codable, Equatable {
 
     /// A defensive strategy that can handle any OpenAPI identifier and produce a non-conflicting Swift identifier.
     ///
-    /// This strategy is the default in Swift OpenAPI Generator 1.x.
-    ///
     /// Introduced in [SOAR-0001](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/soar-0001).
     case defensive
 
     /// An idiomatic strategy that produces Swift identifiers that more likely conform to Swift conventions.
     ///
-    /// Opt-in since Swift OpenAPI Generator 1.6.0.
-    ///
     /// Introduced in [SOAR-0013](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/soar-0013).
     case idiomatic
 }
@@ -56,10 +52,10 @@ public struct Config: Sendable {
     /// The naming strategy to use for deriving Swift identifiers from OpenAPI identifiers.
     ///
     /// Defaults to `defensive`.
-    public var namingStrategy: NamingStrategy?
+    public var namingStrategy: NamingStrategy
 
     /// A map of OpenAPI identifiers to desired Swift identifiers, used instead of the naming strategy.
-    public var nameOverrides: [String: String]?
+    public var nameOverrides: [String: String]
 
     /// Additional pre-release features to enable.
     public var featureFlags: FeatureFlags
@@ -80,8 +76,8 @@ public struct Config: Sendable {
         access: AccessModifier,
         additionalImports: [String] = [],
         filter: DocumentFilter? = nil,
-        namingStrategy: NamingStrategy? = nil,
-        nameOverrides: [String: String]? = nil,
+        namingStrategy: NamingStrategy = .defensive,
+        nameOverrides: [String: String] = [:],
         featureFlags: FeatureFlags = []
     ) {
         self.mode = mode

Sources/_OpenAPIGeneratorCore/Translator/CommonTranslations/SwiftSafeNames.swift

@@ -16,27 +16,14 @@ import Foundation
 /// Extra context for the `safeForSwiftCode_` family of functions to produce more appropriate Swift identifiers.
 struct SwiftNameOptions {
 
-    /// An option for controlling capitalization.
-    ///
-    /// Generally, type names are capitalized, for example: `Foo`.
-    /// And member names are not capitalized, for example: `foo`.
-    enum Capitalization {
-
-        /// Capitalize the name, used for type names, for example: `Foo`.
-        case capitalized
-
-        /// Don't capitalize the name, used for member names, for example: `foo`.
-        case noncapitalized
-    }
-
     /// The capitalization option.
-    var capitalization: Capitalization
+    var isCapitalized: Bool
 
     /// Preset options for capitalized names.
-    static let capitalized = SwiftNameOptions(capitalization: .capitalized)
+    static let capitalized = SwiftNameOptions(isCapitalized: true)
 
     /// Preset options for non-capitalized names.
-    static let noncapitalized = SwiftNameOptions(capitalization: .noncapitalized)
+    static let noncapitalized = SwiftNameOptions(isCapitalized: false)
 }
 
 extension String {
@@ -85,8 +72,8 @@ extension String {
 
         let validString = String(UnicodeScalarView(sanitizedScalars))
 
-        //Special case for a single underscore.
-        //We can't add it to the map as its a valid swift identifier in other cases.
+        // Special case for a single underscore.
+        // We can't add it to the map as its a valid swift identifier in other cases.
         if validString == "_" { return "_underscore_" }
 
         guard Self.keywords.contains(validString) else { return validString }
@@ -101,8 +88,9 @@ extension String {
     ///
     /// Check out [SOAR-0013](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/soar-0013) for details.
     func safeForSwiftCode_idiomatic(options: SwiftNameOptions) -> String {
-        let capitalize = options.capitalization == .capitalized
+        let capitalize = options.isCapitalized
         if isEmpty { return capitalize ? "_Empty_" : "_empty_" }
+
         // Detect cases like HELLO_WORLD, sometimes used for constants.
         let isAllUppercase = allSatisfy {
             // Must check that no characters are lowercased, as non-letter characters
@@ -111,7 +99,8 @@ extension String {
         }
 
         // 1. Leave leading underscores as-are
-        // 2. In the middle: word separators: ["_", "-", "/", <space>] -> remove and capitalize next word
+        // 2. In the middle: word separators: ["_", "-", "/", "+", <space>] -> remove and capitalize
+        //    next word
         // 3. In the middle: period: ["."] -> replace with "_"
         // 4. In the middle: drop ["{", "}"] -> replace with ""
 
@@ -124,7 +113,6 @@ extension String {
             case accumulatingFirstWord(AccumulatingFirstWordContext)
             case accumulatingWord
             case waitingForWordStarter
-            case fallback
         }
         var state: State = .preFirstWord
         for index in self[...].indices {
@@ -138,8 +126,7 @@ extension String {
                     buffer.append(char)
                     state = .preFirstWord
                 } else if char.isNumber {
-                    // Prefix with an underscore if the first character is a number.
-                    buffer.append("_")
+                    // The underscore will be added by the defensive strategy.
                     buffer.append(char)
                     state = .accumulatingFirstWord(.init(isAccumulatingInitialUppercase: false))
                 } else if char.isLetter {
@@ -149,8 +136,9 @@ extension String {
                         .init(isAccumulatingInitialUppercase: !capitalize && char.isUppercase)
                     )
                 } else {
-                    // Illegal character, fall back to the defensive strategy.
-                    state = .fallback
+                    // Illegal character, keep and let the defensive strategy deal with it.
+                    state = .accumulatingFirstWord(.init(isAccumulatingInitialUppercase: false))
+                    buffer.append(char)
                 }
             case .accumulatingFirstWord(var context):
                 if char.isLetter || char.isNumber {
@@ -201,7 +189,7 @@ extension String {
                         buffer.append(char)
                     }
                     state = .accumulatingFirstWord(context)
-                } else if ["_", "-", " ", "/"].contains(char) {
+                } else if ["_", "-", " ", "/", "+"].contains(char) {
                     // In the middle of an identifier, these are considered
                     // word separators, so we remove the character and end the current word.
                     state = .waitingForWordStarter
@@ -214,8 +202,9 @@ extension String {
                     // In the middle of an identifier, curly braces are dropped.
                     state = .accumulatingFirstWord(.init(isAccumulatingInitialUppercase: false))
                 } else {
-                    // Illegal character, fall back to the defensive strategy.
-                    state = .fallback
+                    // Illegal character, keep and let the defensive strategy deal with it.
+                    state = .accumulatingFirstWord(.init(isAccumulatingInitialUppercase: false))
+                    buffer.append(char)
                 }
             case .accumulatingWord:
                 if char.isLetter || char.isNumber {
@@ -231,14 +220,15 @@ extension String {
                     buffer.append("_")
                     state = .accumulatingWord
                 } else if ["{", "}"].contains(char) {
-                    // In the middle of an identifier, curly braces are dropped.
+                    // In the middle of an identifier, these are dropped.
                     state = .accumulatingWord
                 } else {
-                    // Illegal character, fall back to the defensive strategy.
-                    state = .fallback
+                    // Illegal character, keep and let the defensive strategy deal with it.
+                    state = .accumulatingWord
+                    buffer.append(char)
                 }
             case .waitingForWordStarter:
-                if ["_", "-", ".", "/", "{", "}"].contains(char) {
+                if ["_", "-", ".", "/", "+", "{", "}"].contains(char) {
                     // Between words, just drop allowed special characters, since
                     // we're already between words anyway.
                     state = .waitingForWordStarter
@@ -247,23 +237,19 @@ extension String {
                     buffer.append(contentsOf: char.uppercased())
                     state = .accumulatingWord
                 } else {
-                    // Illegal character, fall back to the defensive strategy.
-                    state = .fallback
+                    // Illegal character, keep and let the defensive strategy deal with it.
+                    state = .waitingForWordStarter
+                    buffer.append(char)
                 }
-            case .modifying, .fallback: preconditionFailure("Logic error in \(#function), string: '\(self)'")
+            case .modifying: preconditionFailure("Logic error in \(#function), string: '\(self)'")
             }
             precondition(state != .modifying, "Logic error in \(#function), string: '\(self)'")
-            if case .fallback = state { return safeForSwiftCode_defensive(options: options) }
         }
-        if buffer.isEmpty || state == .preFirstWord { return safeForSwiftCode_defensive(options: options) }
-        // Check for keywords
-        let newString = String(buffer)
-        if Self.keywords.contains(newString) { return "_\(newString)" }
-        return newString
+        return String(buffer).safeForSwiftCode_defensive(options: options)
     }
 
     /// A list of word separator characters for the idiomatic naming strategy.
-    private static let wordSeparators: Set<Character> = ["_", "-", " ", "/"]
+    private static let wordSeparators: Set<Character> = ["_", "-", " ", "/", "+"]
 
     /// A list of Swift keywords.
     ///

Sources/_OpenAPIGeneratorCore/Translator/FileTranslator.swift

@@ -50,14 +50,17 @@ extension FileTranslator {
     var context: TranslatorContext {
         let asSwiftSafeName: (String, SwiftNameOptions) -> String
         switch config.namingStrategy {
-        case .defensive, .none: asSwiftSafeName = { $0.safeForSwiftCode_defensive(options: $1) }
+        case .defensive: asSwiftSafeName = { $0.safeForSwiftCode_defensive(options: $1) }
         case .idiomatic: asSwiftSafeName = { $0.safeForSwiftCode_idiomatic(options: $1) }
         }
-        let overrides = config.nameOverrides ?? [:]
-        return TranslatorContext(asSwiftSafeName: { name, options in
-            if let override = overrides[name] { return override }
-            return asSwiftSafeName(name, options)
-        })
+        let overrides = config.nameOverrides
+        return TranslatorContext(
+            asSwiftSafeName: { name, options in
+                if let override = overrides[name] { return override }
+                return asSwiftSafeName(name, options)
+            },
+            namingStrategy: config.namingStrategy
+        )
     }
 }
 
@@ -69,4 +72,7 @@ struct TranslatorContext {
     /// - Parameter string: The string to convert to be safe for Swift.
     /// - Returns: A Swift-safe version of the input string.
     var asSwiftSafeName: (String, SwiftNameOptions) -> String
+
+    /// The naming strategy.
+    var namingStrategy: NamingStrategy
 }

Sources/_OpenAPIGeneratorCore/Translator/TypeAssignment/TypeAssigner.swift

@@ -531,19 +531,33 @@ struct TypeAssigner {
         default:
             let safedType = context.asSwiftSafeName(contentType.originallyCasedType, .noncapitalized)
             let safedSubtype = context.asSwiftSafeName(contentType.originallyCasedSubtype, .noncapitalized)
-            let prefix = "\(safedType)_\(safedSubtype)"
+            let componentSeparator: String
+            let capitalizeNonFirstWords: Bool
+            switch context.namingStrategy {
+            case .defensive:
+                componentSeparator = "_"
+                capitalizeNonFirstWords = false
+            case .idiomatic:
+                componentSeparator = ""
+                capitalizeNonFirstWords = true
+            }
+            let prettifiedSubtype = capitalizeNonFirstWords ? safedSubtype.uppercasingFirstLetter : safedSubtype
+            let prefix = "\(safedType)\(componentSeparator)\(prettifiedSubtype)"
             let params = contentType.lowercasedParameterPairs
             guard !params.isEmpty else { return prefix }
             let safedParams =
                 params.map { pair in
-                    pair.split(separator: "=").map { context.asSwiftSafeName(String($0), .noncapitalized) }
-                        .joined(separator: "_")
+                    pair.split(separator: "=")
+                        .map { component in
+                            let safedComponent = context.asSwiftSafeName(String(component), .noncapitalized)
+                            return capitalizeNonFirstWords ? safedComponent.uppercasingFirstLetter : safedComponent
+                        }
+                        .joined(separator: componentSeparator)
                 }
-                .joined(separator: "_")
-            return prefix + "_" + safedParams
+                .joined(separator: componentSeparator)
+            return prefix + componentSeparator + safedParams
         }
     }
-
 }
 
 extension FileTranslator {

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

@@ -40,9 +40,9 @@ The configuration file has the following keys:
     - `tags`: Operations tagged with these tags will be included in the filter.
     - `paths`: Operations for these paths will be included in the filter.
     - `schemas`: These (additional) schemas will be included in the filter.
-- `namingStrategy` (optional): a string. Customizes the strategy of converting OpenAPI identifiers into Swift identifiers.
+- `namingStrategy` (optional): a string. The strategy of converting OpenAPI identifiers into Swift identifiers.
     - `defensive` (default): Produces non-conflicting Swift identifiers for any OpenAPI identifiers. Check out [SOAR-0001](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/soar-0001) for details.
-    - `idiomatic`: Produces more idiomatic Swift identifiers for OpenAPI identifiers, might produce name conflicts (in that case, switch back to `defensive`.) Check out [SOAR-0013](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/soar-0013) for details.
+    - `idiomatic`: Produces more idiomatic Swift identifiers for OpenAPI identifiers. Might produce name conflicts (in that case, switch back to `defensive`). Check out [SOAR-0013](https://swiftpackageindex.com/apple/swift-openapi-generator/documentation/swift-openapi-generator/soar-0013) for details.
 - `nameOverrides` (optional): a string to string dictionary. Allows customizing how individual OpenAPI identifiers get converted to Swift identifiers.
 - `featureFlags` (optional): array of strings. Each string must be a valid feature flag to enable. For a list of currently supported feature flags, check out [FeatureFlags.swift](https://github.com/apple/swift-openapi-generator/blob/main/Sources/_OpenAPIGeneratorCore/FeatureFlags.swift).
 

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.Package.0.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.Package.1.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.Package.2.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.Package.3.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.Package.4.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/client.Package.5.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.Package.0.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.Package.1.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.Package.2.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.Package.3.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.Package.4.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/Documentation.docc/Tutorials/_Resources/server.Package.5.swift

@@ -1,4 +1,4 @@
-// swift-tools-version: 6.0
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(

Sources/swift-openapi-generator/FilterCommand.swift

@@ -81,15 +81,13 @@ private func timing<Output>(_ title: String, _ operation: @autoclosure () throws
 }
 
 private let sampleConfig = _UserConfig(
-    generate: [.types, .client],
+    generate: [],
     filter: DocumentFilter(
         operations: ["getGreeting"],
         tags: ["greetings"],
         paths: ["/greeting"],
         schemas: ["Greeting"]
-    ),
-    namingStrategy: .idiomatic,
-    nameOverrides: ["SPECIAL_NAME": "SpecialName"]
+    )
 )
 
 enum OutputFormat: String, ExpressibleByArgument {

Sources/swift-openapi-generator/GenerateOptions.swift

@@ -75,8 +75,16 @@ extension _GenerateOptions {
         return []
     }
 
+    /// Returns the naming strategy requested by the user.
+    /// - Parameter config: The configuration specified by the user.
+    /// - Returns: The naming strategy requestd by the user.
     func resolvedNamingStrategy(_ config: _UserConfig?) -> NamingStrategy { config?.namingStrategy ?? .defensive }
+
+    /// Returns the name overrides requested by the user.
+    /// - Parameter config: The configuration specified by the user.
+    /// - Returns: The name overrides requested by the user
     func resolvedNameOverrides(_ config: _UserConfig?) -> [String: String] { config?.nameOverrides ?? [:] }
+
     /// Returns a list of the feature flags requested by the user.
     /// - Parameter config: The configuration specified by the user.
     /// - Returns: A set of feature flags requested by the user.