Add symbolName property for some syntax nodes #2583
Conversation
This file contains 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
Matejkob
commented
Apr 2, 2024
Matejkob
commented
Apr 2, 2024
Matejkob
commented
Apr 3, 2024
|
I think it only makes sense to offer it for nodes that have a
|
Matejkob
changed the title
|
Depending on: #2593 |
ahoppen
reviewed
Apr 8, 2024
|
Thanks for the review Alex 🫶 |
ahoppen
approved these changes
Apr 10, 2024
`FunctionDecl`, `InitializerDecl`, `SubscriptDecl`, `EnumCaseElement`, and `MacroDecl` gained a new computed property: `symbolName` The `symbolName` property provides a string representation of the declaration's name along with its parameter labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`.
bnbarham
approved these changes
Apr 11, 2024
|
@swift-ci please smoke test |
hamishknight
approved these changes
Apr 16, 2024
| @@ -2,6 +2,11 @@ | |||
|
|
|||
| ## New APIs | |||
|
|
|||
| - `FunctionDecl`, `InitializerDecl`, `SubscriptDecl`, `EnumCaseElement`, and `MacroDecl` gained a new computed property: `symbolName` | |||
| - Description: The `symbolName` property provides a string representation of the declaration's name along with its parameter labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`. | |||
There was a problem hiding this comment.
Nit: These are called argument labels in TSPL, and we have e.g SyntaxClassification.argumentLabel, I think we probably ought to be consistent.
Suggested change
| - Description: The `symbolName` property provides a string representation of the declaration's name along with its parameter labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`. | |
| - Description: The `symbolName` property provides a string representation of the declaration's name along with its argument labels. For example, a function `func greet(name: String)` will have the symbol name `greet(name:)`. |
| extension FunctionDeclSyntax { | ||
| /// The symbol name of the function declaration. | ||
| /// | ||
| /// The symbol name is a string representation of the function name along with its parameter labels. |
There was a problem hiding this comment.
Suggested change
| /// The symbol name is a string representation of the function name along with its parameter labels. | |
| /// The symbol name is a string representation of the function name along with its argument labels. |
| extension InitializerDeclSyntax { | ||
| /// The symbol name of the initializer declaration. | ||
| /// | ||
| /// The symbol name is a string representation of the initializer along with its parameter labels. |
There was a problem hiding this comment.
Suggested change
| /// The symbol name is a string representation of the initializer along with its parameter labels. | |
| /// The symbol name is a string representation of the initializer along with its argument labels. |
| extension SubscriptDeclSyntax { | ||
| /// The symbol name of the subscript declaration. | ||
| /// | ||
| /// The symbol name is a string representation of the subscript along with its parameter labels. |
There was a problem hiding this comment.
Suggested change
| /// The symbol name is a string representation of the subscript along with its parameter labels. | |
| /// The symbol name is a string representation of the subscript along with its argument labels. |
| extension MacroDeclSyntax { | ||
| /// The symbol name of the macro declaration. | ||
| /// | ||
| /// The symbol name is a string representation of the macro name along with its parameter labels. |
There was a problem hiding this comment.
Suggested change
| /// The symbol name is a string representation of the macro name along with its parameter labels. | |
| /// The symbol name is a string representation of the macro name along with its argument labels. |
| } | ||
| } | ||
|
|
||
| /// Generates the symbol name by combining the base name and parameter labels. |
There was a problem hiding this comment.
Suggested change
| /// Generates the symbol name by combining the base name and parameter labels. | |
| /// Generates the symbol name by combining the base name and argument labels. |
|
This resembles struct SymbolBaseName {
enum Kind { case normal, subscript, initializer, deinitializer }
var asString: String {get}
var kind: Kind {get}
var isOperator: Bool {get}
}
struct SymbolName {
var asString: String {get}
var baseName: SymbolBaseName {get}
var argumentLabels: some Collection<String> {get}
}WDYT? |
|
That is a great idea, @rintaro. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
FunctionDecl,InitializerDecl,SubscriptDecl,EnumCaseElement, andMacroDeclgained a new computed property:symbolNameThe
symbolNameproperty provides a string representation of the declaration's name along with its parameter labels. For example, a functionfunc greet(name: String)will have the symbol namegreet(name:).Resolves #2488