SourceKitten Versions Save

Breaking

• Replace many of the public extensions on String, and its internal caching mechanism CacheContainer, with a new StringView type.
  Paul Taykalo

Enhancements

• Allow inline html tags in ObjC doc comments.
  Chris Williams #409 realm/jazzy#976

• Support code formatting in ObjC doc comments with @c, @code and @endcode.
  Bryce Pauken #631

Bug Fixes

• Fix crash when SourceKit returns out of bounds string byte offsets.
  JP Simard

Breaking

• Update Commandant dependency to version 0.17.0, removing the antitypical/Result dependency in favor of the Swift standard library's Result type.
  JP Simard #623

Enhancements

• None.

Bug Fixes

• None.

Breaking

• SourceKitten now requires Swift 5.0 or higher to build.
  JP Simard

Enhancements

• Support building SourceKitten with Swift 5.1.
  Pedro Larroy

• Add new libclang types introduced between 0.49 and 0.59.
  JP Simard

• Add new SwiftDeclarationAttributeKind and SwiftDeclarationKind members introduced in Swift 5.1.
  JP Simard

• SyntaxKind now conforms to CaseIterable.
  JP Simard

Bug Fixes

• Fix Swift response files for paths including special characters.
  John Fairhurst

Breaking

• None.

Enhancements

• Add --spm option to guess the name of a Swift Package Manager module for documentation generation.
  John Fairhurst

• Support doc generation for modules built with Xcode 11.
  John Fairhurst

• Add Module.init?(spmArguments:spmName:inPath) and use in doc command to ensure Swift Package Manager module documentation is up to date.
  John Fairhurst

Bug Fixes

• Fix crash with misplaced documentation comment.
  John Fairhurst

Breaking

• Change Module.init?(spmName:) to Module.init?(spmName:inPath:).
  Norio Nomura

• SourceKitObjectConvertible now has SourceKitObject parameter requirement instead of sourcekitd_object_t. SourceKitObject isn't publicly initializable (this helps memory management).
  Colton Schlosser

• Dictionary and Array now conditionally conform to SourceKitObjectConvertible, instead of crashing when using unexpected types.
  Colton Schlosser

Enhancements

• Add cursorInfoUSR case to the Request.
  Timofey Solonin

• Add a Dictionary<String, SourceKitRepresentable>.referencedUSRs computed property to retrieve referenced USRs from a SourceKit cursor info response.
  Colton Schlosser

Bug Fixes

• Fix testCommandantDocsSPM failed on using Swift Package in Xcode 11, because Xcode 11 does not use SRCROOT as current directory on executing tests in Package.swift.
  Norio Nomura

• Release memory created for sourcekitd requests.
  Colton Schlosser realm/SwiftLint#2812

Breaking

• None.

Enhancements

• Add parsed extension declarations to Swift docs.
  John Fairhurst

• Make File conform to Equatable and Hashable.
  Elliott Williams

Bug Fixes

• None.

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix warnings or errors when compiling in Swift 5 language mode.
  Yi Wang JP Simard

Breaking

• None.

Enhancements

• Introduce XcodeBuildSetting for interacting with project build settings.
  Chris Zielinski

• Improve module name inference for Module.
  Chris Zielinski

• Add Swift 5 support. Add new SwiftDeclarationAttributeKind and SwiftDeclarationKind members and make those enums conform to CaseIterable.
  Norio Nomura

Bug Fixes

• “.swift”-suffixed directory in xcodebuild arguments no longer detected as Swift file.
  Minh Nguyễn #574

• Fix xcodebuild clean path for new build system and Xcode 10.2.
  John Fairhurst realm/jazzy#1057

• Pathnames containing shell-escaped characters in xcodebuild arguments no longer prevent documentation generation.
  John Fairhurst

• swiftc no longer passed as a compiler argument when using doc and the new build system.
  John Fairhurst

Breaking

• SourceKitten now requires Swift 4.2 or higher to build.
  JP Simard

Enhancements

• Add Request.syntaxTree to get a serialized representation of the file's SwiftSyntax tree.
  JP Simard

Bug Fixes

• Fix crash in NSString.location(fromByteOffset:) when using unicode characters.
  JP Simard realm/SwiftLint#2276

This is the last release to support building with Swift 4.0 and Swift 4.1.

Breaking

• None.

Enhancements

• If New Build System is enabled on Xcode, the doc command does not need to use the clean action on xcodebuild.
  Norio Nomura

• Use 'as' bridging on Linux when using Swift 4.2.
  JP Simard

Bug Fixes

• None.