Add an article that describes how macros should be versioned when updating their swift-syntax dependency #2024
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
ahoppen
force-pushed
the
ahoppen/macro-versioning
branch
2 times, most recently
from
0843072 to
9263dee
Compare
bnbarham
approved these changes
Aug 8, 2023
|
|
||
| ## Representation of New Syntax with Old swift-syntax Versions | ||
|
|
||
| In case that a swift-syntax verison is used that is older than the compiler’s version, then swift-syntax will not be able to represent the new syntactic structures (like new statements) in the source file because it doesn’t know about them. |
There was a problem hiding this comment.
Suggested change
| In case that a swift-syntax verison is used that is older than the compiler’s version, then swift-syntax will not be able to represent the new syntactic structures (like new statements) in the source file because it doesn’t know about them. | |
| If a swift-syntax verison is used that is older than the compiler’s version, then swift-syntax will not be able to represent the new syntactic structures (like new statements) in the source file because it doesn’t know about them. |
| @@ -0,0 +1,29 @@ | |||
| # Updating a Macro to a New Major Swift-syntax Version | |||
There was a problem hiding this comment.
Nitpick: Swift-syntax here vs swift-syntax below. Personally I wouldn't title case it
There was a problem hiding this comment.
Damn, I didn’t double-check the output of titlecase.com here
ahoppen
force-pushed
the
ahoppen/macro-versioning
branch
from
9263dee to
e3471c9
Compare
|
@swift-ci Please test |
tevelee
reviewed
Aug 8, 2023
|
|
||
| For simplicity, this article assumes that `509` is the current swift-syntax version and `510` the next, but everything applies to any other major swift-syntax version update, including version jumps to `600`. | ||
|
|
||
| When staring to write a macro, no special considerations need to be made with regard in terms of versioning. Depending on swift-syntax as with `from: "509.0.0"` will make sure that the macro receives any bug fix updates to swift-syntax 509. For example, a macro depending on swift-syntax 509 might be released as version 1.0, 1.2, 2.0, … |
There was a problem hiding this comment.
Suggested change
| When staring to write a macro, no special considerations need to be made with regard in terms of versioning. Depending on swift-syntax as with `from: "509.0.0"` will make sure that the macro receives any bug fix updates to swift-syntax 509. For example, a macro depending on swift-syntax 509 might be released as version 1.0, 1.2, 2.0, … | |
| When starting to write a macro, no special considerations need to be made with regard to versioning. Depending on swift-syntax as with `from: "509.0.0"` will make sure that the macro receives any bug fix updates to swift-syntax 509. For example, a macro depending on swift-syntax 509 might be released as version 1.0, 1.2, 2.0, … |
There was a problem hiding this comment.
Thanks for catching these typos @tevelee
kimdv
approved these changes
Aug 8, 2023
…ating their swift-syntax dependency
ahoppen
force-pushed
the
ahoppen/macro-versioning
branch
from
e3471c9 to
be755dd
Compare
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
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.
No description provided.