Audit public API on SyntaxProtocol
#1912
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
This gives the file a little order and makes it easier to spot naming inconsistencies.
This property seems to be pretty useless and probably dates back to a completely different design of the syntax tree where implicit nodes were a thing.
|
@swift-ci Please test |
The position and range API on `SyntaxProtocol` was a little inconsistent and misleading. Clean it up so that we have `totalLength` (including trivia), `contentLength` (excluding trivia) and a matching pair for `byteRange`.
ahoppen
force-pushed
the
ahoppen/syntaxprotocol-api
branch
from
0de6b19 to
5bfa847
Compare
|
@swift-ci Please test |
|
@swift-ci Please test Windows |
bnbarham
reviewed
Jul 18, 2023
Comment on lines
-228
to
+234
| public var detached: Self { | ||
| var detached: Self { |
There was a problem hiding this comment.
I very much dislike that we switch between visibility on the extension and visibility on each member here 😅. Ie. just below does the opposite.
There was a problem hiding this comment.
Let’s enable the swift-format rule that we don’t have an access level on an extension in a follow-up PR.
Sources/SwiftSyntax/Syntax.swift
Outdated
| } | ||
|
|
||
| /// The textual byte length of this node exluding leading and trailing trivia. | ||
| @available(*, deprecated, message: "Use contentLength.utf8Length") |
There was a problem hiding this comment.
I wonder if the content name could work for the other places we're using trimmed right now? Or if this should be trimmedLength? I'm not sure content means "not including leading/trailing trivia" to me.
| return totalLength.utf8Length | ||
| } | ||
|
|
||
| /// The textual byte length of this node exluding leading and trailing trivia. |
There was a problem hiding this comment.
Suggested change
| /// The textual byte length of this node exluding leading and trailing trivia. | |
| /// The textual byte length of this node excluding leading and trailing trivia. |
bnbarham
approved these changes
Jul 22, 2023
|
@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.
First, re-arrange the properties in
SyntaxProtocolto group them logically.Then, I found two areas of improvement:
isImplicitSyntaxProtocolSyntaxProtocolwas a little inconsistent and misleading. Clean it up so that we havetotalLength(including trivia),contentLength(excluding trivia) and a matching pair forbyteRange.