Skip to content

600.0.0
Compare
Choose a tag to compare
@ahoppen ahoppen released this 13 Sep 18:37
· 675 commits to main since this release
600.0.0
cb53fa1
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

New APIs

  • FixIt now has a new computed property named edits

    • Description: the edits represent the non-overlapping textual edits that need to be performed when the Fix-It is applied.
    • Issue: swiftlang/sourcekit-lsp#909
    • Pull Request: #2314

  • SourceEdit

  • assertMacroExpansion now have new parameters named applyFixIts and fixedSource

    • Description: applyFixIts and fixedSource are used to assert so ensure that the source code after applying Fix-Its matches this string.
    • Issue: #2015
    • Pull Request: #2021

  • DeclSyntaxEnum, StmtSyntaxEnum, ExprSyntaxEnum, TypeSyntaxEnum, and PatternSyntaxEnum

    • Description: Enum to exhaustively switch over all different syntax nodes of each base type.
    • Pull Request: #2351

  • WithOptionalCodeBlock

    • Description: A trait for syntax nodes that have an optional code block, such as FunctionDeclSyntax and InitializerDeclSyntax.
    • Pull Request: #2359

  • CodeBlockSyntax

    • Description: CodeBlockSyntax is now SyntaxParseable, so it can be used with string interpolations.
    • Pull Request: #2361

  • ThrowsClause

    • Description: The throwsSpecifier for the effects nodes (AccessorEffectSpecifiers, FunctionEffectSpecifiers, TypeEffectSpecifiers, EffectSpecifiers) has been replaced with throwsClause, which captures both the throws specifier and the (optional) thrown error type, as introduced by SE-0413.
    • Pull Request: #2379

  • String.isValidSwiftIdentifier(for:)

    • Description: SwiftParser adds an extension on String to check if it can be used as an identifier in a given context.
    • Pull Request: #2434

  • MacroDeclSyntax.expand

    • the expand(argumentList:definition:replacements:) method gains a new parameter 'genericReplacements:' that is defaulted to an empty array.
    • The method's signature is now expand(argumentList:definition:replacements:genericReplacements:)
    • Pull Request: #2450

  • SyntaxProtocol.asMacroLexicalContext() and allMacroLexicalContexts(enclosingSyntax:)

    • Description: Produce the lexical context for a given syntax node (if it has one), or the entire stack of lexical contexts enclosing a syntax node, for use in macro expansion.
    • Pull request: #1554

  • TriviaPiece.isComment

    • Description: TriviaPiece now has a computed property isComment that returns true if the trivia piece is a comment.
    • Pull Request: #2469

  • New assertMacroExpansion API with option to specify macro specifications with macroSpecs argument

    • Description: macroSpecs can have additional specifications like conformances provided by member or extension macro that can be used for macro expansion.
    • Issue: #2031
    • Pull Request: #2327

  • BasicFormat.inferIndentation(of:)

    • Description: Uses heuristics to infer the indentation width used in a syntax tree.
    • Pull Request: #2514

  • IncrementalEdit stores replacement text

    • Description: IncrementalEdit used to store the range that was replaced and the length of the replacement but not the replacement bytes by itself. IncrementalEdit now has a replacement property that contains the replacement bytes.
    • Pull Request: #2527

  • Type specifiers

    • Description: AttributedTypeSyntax can now contain multiple specifiers and these types are used to model the list of specifiers. Additionally, type specifiers can now contain arguments, like borrow(data). To facilitate this, the following new types were introduces: LifetimeSpecifierArgumentListSyntax, LifetimeSpecifierArgumentSyntax, LifetimeSpecifierArgumentsSyntax, LifetimeTypeSpecifierSyntax, SimpleTypeSpecifierSyntax, TypeSpecifierListSyntax
    • Pull request: #2433

  • DeclGroupSyntax.introducer

  • ExprSyntax.interpretedAsVersionTuple

    • Description: With the change to parse #if canImport(MyModule, _version: 1.2.3) as a function call instead of a dedicated syntax node, 1.2.3 natively gets parsed as a member access 3 to the 1.2 float literal. This property allows the reinterpretation of such an expression as a version tuple.
    • Pull request: #2025

  • SyntaxProtocol.node(at:)

    • Description: Given a SyntaxIdentifier, returns the Syntax node with that identifier
    • Pull request: #2594

  • SyntaxIdentifier.IndexInTree

    • Description: Uniquely identifies a syntax node within a tree. This is similar to SyntaxIdentifier but does not store the root ID of the tree. It can thus be transferred across trees that are structurally equivalent, for example two copies of the same tree that live in different processes. The only public functions on this type are toOpaque and init(fromOpaque:), which allow serialization of the IndexInTree.
    • Pull request: #2594

  • SyntaxIdentifier conformance to Comparable:

    • Description: A SyntaxIdentifier compares less than another SyntaxIdentifier if the node at that identifier occurs first during a depth-first traversal of the tree.
    • Pull request: #2594

  • SyntaxIdentifier.indexInTree and SyntaxIdentifier.fromIndexInTree

    • Description: SyntaxIdentifier.indexInTree allows the retrieval of a SyntaxIdentifier that identifies the syntax node independent of the syntax tree. SyntaxIdentifier.fromIndexInTree allows the creation for a SyntaxIdentifier from a tree-agnostic SyntaxIdentifier.IndexInTree and the tree's root node.
    • Pull request: #2594

  • SwiftSyntaxMacrosGenericTestSupport

    • Description: A version of the SwiftSyntaxMacrosTestSupport module that doesn't depend on Foundation or XCTest and can thus be used to write macro tests using swift-testing. Since swift-syntax can't depend on swift-testing (which would incur a circular dependency since swift-testing depends on swift-syntax), users need to manually specify a failure handler like the following, that fails the swift-testing test: Issue.record("\($0.message)", fileID: $0.location.fileID, filePath: $0.location.filePath, line: $0.location.line, column: $0.location.column)
    • Pull request: #2647

  • TokenSyntax.identifier

    • Description: Adds an identifier property to TokenSyntax which returns a canonicalized representation of an identifier that strips away backticks.
    • Pull request: #2576

Deprecations

  • Child Choice Node Casts

    • Description: is, as, and cast methods for types not contained in the choice node are marked as deprecated. The deprecated methods will emit a warning, indicating that the cast will always fail.
    • Issue: #2092
    • Pull Request: #2184
    • Migration steps: Remove the is, as or cast methods because they will always fail.

  • IncrementalParseTransition:

    • Description: The initializer IncrementalParseTransition.init(previousTree:edits:lookaheadRanges:reusedNodeCallback:) is marked as deprecated. Use IncrementalParseTransition.init(previousIncrementalParseResult:edits:reusedNodeCallback:) instead.
    • Issue: #2267
    • Pull request: #2272
    • Migration steps: Call IncrementalParseTransition.init(previousIncrementalParseResult:edits:reusedNodeCallback:) instead.

  • MacroExpansion{Error|Warning|FixIt}Message moved to the SwiftSyntaxMacros module

    • Description: Move the MacroExpansion{Error|Warning|FixIt}Message types from the SwiftSyntaxMacroExpansion module to SwiftSyntaxMacros. Deprecated typealiases in SwiftSyntaxMacroExpansion forward to SwiftSyntaxMacros.
    • Pull request: #2338
    • Notes: The expansion diagnostic messages were defined in SwiftSyntaxMacroExpansion, which is intended as an implementation detail of the plugin server and should not need to be imported by macros.

  • EditorPlaceholderDeclSyntax and EditorPlaceholderExprSyntax:

    • Description: EditorPlaceholderDeclSyntax and EditorPlaceholderExprSyntax are now deprecated and placeholders are instead parsed as identifiers within a MissingDeclSyntax or DeclReferenceExprSyntax.
    • Pull request: #2237

  • AttributedTypeSyntax.specifier has renamed to specifiers and changed to be a collection

    • Description: Types can have multiple specifiers now and the syntax tree has been modified to reflect that.
    • Pull request: #2433

  • CanImportExprSyntax and CanImportVersionInfoSyntax

    • Description: Instead of parsing canImport inside #if directives as a special expression node, parse it as a functionc call expression. This is in-line with how the swift(>=6.0) and compiler(>=6.0) directives are parsed.
    • Pull request: #2025

API-Incompatible Changes

  • MacroDefinition used for expanding macros:

    • Description: The MacroDefinition/expansion enum case used to have two values ((MacroExpansionExprSyntax, replacements: [Replacement])), has now gained another value in order to support generic argument replacements in macro expansions: (MacroExpansionExprSyntax, replacements: [Replacement], genericReplacements: [GenericArgumentReplacement])
    • Pull request: #2450
    • Migration steps: Code which exhaustively checked over the enum should be changed to case .expansion(let node, let replacements, let genericReplacements):. Creating the .extension gained a compatibility shim, retaining the previous syntax source compatible (return .expansion(node, replacements: [])).

  • Effect specifiers:

    • Description: The unexpectedAfterThrowsSpecifier node of the various effect specifiers has been removed.
    • Pull request: #2219
    • Migration steps: Check unexpectedBetweenThrowsSpecifierAndThrownError and unexpectedAfterThrownError instead.

  • SyntaxKind removed conformance to CaseIterable

    • Description: SyntaxKind no longer conforms to CaseIterable since there is no good use case to iterate over all syntax kinds.
    • Pull request: #2292
    • Migration steps: Exhaustively check all the syntax nodes that your program supports. There should be no use case to iterate over all cases in SyntaxKind.

  • IntegerLiteralExprSyntax.Radix removed conformance to CaseIterable

    • Description: IntegerLiteralExprSyntax.Radix no longer conforms to CaseIterable since there is no good use case to iterate over all radix kinds.
    • Pull request: #2292
    • Migration steps: There should be no use case to iterate over all cases in IntegerLiteralExprSyntax.Radix.

  • Parser.parseIncrementally(source:parseTransition:) and Parser.parseIncrementally(source:maximumNestingLevel:parseTransition:):

    • Description: The default versions of Parser.parseIncrementally return a IncrementalParseResult instead of a tuple. Access to the struct should be compatible with the tuple in almost all cases unless the tuple is stored into a variable and then destructed or passed to a function that expects a tuple.
    • Issue: #2267
    • Pull request: #2272
    • Migration steps: If necessary, change type annotations from the tuple to the IncrementalParseResult type.

  • SyntaxClassification gained a new case: argumentLabel

    • The new classification case covers the first names of parameters in function-like declarations and the label of arguments in function-like calls.
    • Pull request: #2375
    • Migration steps: In exhaustive switches over SyntaxClassification, cover the new case.

  • SyntaxEnum and SyntaxKind gained new cases: throwsClause

    • The new cases cover the newly introduced ThrowsClauseSyntax
    • Pull request: #2379
    • Migration steps: In exhaustive switches over SyntaxEnum and SyntaxKind, cover the new case.

  • MacroExpansionContext now requires a property lexicalContext:

    • Description: The new property provides the lexical context in which the macro is expanded, and has several paired API changes. Types that conform to MacroExpansionContext will need to implement this property. Additionally, the HostToPluginMessage cases expandFreestandingMacro and expandAttachedMacro now include an optional lexicalContext. Finally, the SyntaxProtocol.expand(macros:in:indentationWidth:) syntactic expansion operation has been deprecated in favor of a new version expand(macros:contextGenerator:indentationWidth:) that takes a function produces a new macro expansion context for each expansion.
    • Pull request: #1554
    • Migration steps: Add the new property lexicalContext to any MacroExpansionContext-conforming types. If implementing the host-to-plugin message protocol, add support for lexicalContext. For macro expansion operations going through SyntaxProtocol.expand, provide a context generator that creates a fresh context including the lexical context.

  • TriviaPiece.isBackslash in SwiftParserDiagnostics removed

    • Description: TriviaPiece.isBackslash was not intended to be public API.
    • Pull request: #2531
    • Migration steps: Use if case .backslash = triviaPiece instead

  • All symbols in SwiftCompilerPluginMessageHandling are now SPI

    • Description: This module is only intended to be used from some internal components. Any other modules should not use them directly.
    • Pull request: #2489
    • Migration steps: Stop using this module.
Assets 2
Loading