Added TypeName and TypeUsage from OpenAPI Generator. #1726
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Motivation: The types are used by the code renderer that will be brought over from OpenAPI Generator to the new gRPC Swift CodeGenLib. Modifications: Copied the TypeName, TypeUsage and some TypeName extensions that will be used in the context of gRPC, and modified TypeName so it represents only the Swift path of a type. Result: We will be able to bring over the Code Renderer and we will have types representations that can be used by the service translator.
stefanadranca
commented
Nov 28, 2023
| } | ||
|
|
||
| /// A list of components that make up the type name. | ||
| private let components: [Component] |
Collaborator
Author
There was a problem hiding this comment.
I can also use Strings to represent the components (since the struct has only one property). I wanted to check if there is any advantage that I don't see in still having a struct.
Collaborator
There was a problem hiding this comment.
No, we should just use Strings here which means we can simplify more of this type too.
stefanadranca
commented
Nov 29, 2023
Comment on lines
107
to
125
| extension TypeName { | ||
| /// Returns the type name for the String type. | ||
| static var string: Self { .swift("String") } | ||
|
|
||
| /// Returns the type name for the Int type. | ||
| static var int: Self { .swift("Int") } | ||
|
|
||
| /// Returns a type name for a type with the specified name in the | ||
| /// Swift module. | ||
| /// - Parameter name: The name of the type. | ||
| /// - Returns: A TypeName representing the specified type within the Swift module. | ||
| static func swift(_ name: String) -> TypeName { TypeName(swiftKeyPath: ["Swift", name]) } | ||
|
|
||
| /// Returns a type name for a type with the specified name in the | ||
| /// Foundation module. | ||
| /// - Parameter name: The name of the type. | ||
| /// - Returns: A TypeName representing the specified type within the Foundation module. | ||
| static func foundation(_ name: String) -> TypeName { | ||
| TypeName(swiftKeyPath: ["Foundation", name]) |
Collaborator
Author
There was a problem hiding this comment.
This extension is from another file - Builtins.swift. Should I signal this in any way?
glbrntt
requested changes
Nov 29, 2023
| } | ||
|
|
||
| /// A list of components that make up the type name. | ||
| private let components: [Component] |
Collaborator
There was a problem hiding this comment.
No, we should just use Strings here which means we can simplify more of this type too.
Comment on lines
107
to
125
| extension TypeName { | ||
| /// Returns the type name for the String type. | ||
| static var string: Self { .swift("String") } | ||
|
|
||
| /// Returns the type name for the Int type. | ||
| static var int: Self { .swift("Int") } | ||
|
|
||
| /// Returns a type name for a type with the specified name in the | ||
| /// Swift module. | ||
| /// - Parameter name: The name of the type. | ||
| /// - Returns: A TypeName representing the specified type within the Swift module. | ||
| static func swift(_ name: String) -> TypeName { TypeName(swiftKeyPath: ["Swift", name]) } | ||
|
|
||
| /// Returns a type name for a type with the specified name in the | ||
| /// Foundation module. | ||
| /// - Parameter name: The name of the type. | ||
| /// - Returns: A TypeName representing the specified type within the Foundation module. | ||
| static func foundation(_ name: String) -> TypeName { | ||
| TypeName(swiftKeyPath: ["Foundation", name]) |
glbrntt
reviewed
Nov 29, 2023
Comment on lines
66
to
67
| func appending(component: String? = nil) -> Self { | ||
| precondition(component != nil, "The type name must be non-nil.") |
Collaborator
There was a problem hiding this comment.
This is a weird combination, we should just make the String non-optional
glbrntt
requested changes
Nov 29, 2023
Collaborator
glbrntt
left a comment
glbrntt
left a comment
There was a problem hiding this comment.
One nit, looks good otherwise
glbrntt
approved these changes
Nov 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation:
The types are used by the code renderer that will be brought over from OpenAPI Generator to the new gRPC Swift CodeGenLib.
Modifications:
Copied the TypeName, TypeUsage and some TypeName extensions that will be used in the context of gRPC, and modified TypeName so it represents only the Swift path of a type.
Result:
We will be able to bring over the Code Renderer and we will have types representations that can be used by the service translator.