swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC
https://swiftpackageindex.com/apple/swift-docc-plugin/1.3.0/documentation/swiftdoccplugin
Apache License 2.0
316 stars 54 forks source link

Make --include-extended-types default for Swift 5.9 #57

Closed theMomax closed 1 year ago

theMomax commented 1 year ago

Bug/issue #, if applicable: apple/swift-docc#210

Summary

This PR makes --include-extended-types the default behavior for handling extended types when compiled with a Swift version greater or equal to 5.9. It also introduces the negative counterpart flag --exclude-extended-types, which is available from Swift 5.8. The default behavior for Swift 5.8 remains unchanged (equivalent to --exclude-extended-types).

The DocC documentation for the Plugin has been reworded.

The relevant part of the help text generated by the plugin's help flag has been reworded and shown both flags (--include-extended-types and --exclude-extended-types) along with the default value. The text is the same for Swift 5.8 and Swift 5.9, except for the default value.

Dependencies

None.

Testing

There are unit and integration tests making sure the behavior and help text is as expected for the Swift version the tests are run with. I ran the full bin/test suite with a Swift 5.7, Swift 5.8, and Swift 5.9 toolchain each and tested invocations manually with the same toolchains on a local test target.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

theMomax commented 1 year ago

@swift-ci please test

theMomax commented 1 year ago

@swift-ci please test