Add support for emitting serialized diagnostics (.dia) files #1628
+128
−2
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
davbeck
requested review from
aaronsky,
adincebic,
brentleyjones,
keith,
luispadron and
mattrobmattrob
as code owners
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Contributor
|
@davbeck Do these files contain absolute paths or something user / host specific? |
Author
|
They are relative to the project root. My understanding is that swift uses the path from the file map and since rules_swift uses paths relative to the project, the diagnostic files contain relative paths. Here's an example: [Target].output_file_map.json: "Apps/Dasher/Layers/Foundation/Core/Sources/Retry/RetryAsync.swift": {
"ast-dump": "bazel-out/darwin_arm64-fastbuild/bin/Apps/Dasher/Layers/Foundation/Core/Core_objs/Sources/Retry/RetryAsync.swift.ast",
"const-values": "bazel-out/darwin_arm64-fastbuild/bin/Apps/Dasher/Layers/Foundation/Core/Core_objs/Sources/Retry/RetryAsync.swift.swiftconstvalues",
"diagnostics": "bazel-out/darwin_arm64-fastbuild/bin/Apps/Dasher/Layers/Foundation/Core/Core_objs/Sources/Retry/RetryAsync.swift.dia",
"object": "bazel-out/darwin_arm64-fastbuild/bin/Apps/Dasher/Layers/Foundation/Core/Core_objs/Sources/Retry/RetryAsync.swift.o"
},Will produce a diagnostic file like this: This is different from the files that swift package manager creates because it uses absolute paths in it output file map. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds a new feature swift.emit_diagnostics that enables the Swift compiler to output serialized diagnostics files (.dia). These machine-readable files can be consumed by IDEs, migration tools, and other static analysis utilities.
What I'm using this for at the moment is to replicate the behavior of
swift package migrate(see https://github.com/swiftlang/swift-package-manager/blob/main/Sources/Commands/PackageCommands/Migrate.swift). The .dia files contain fixits and categories so you can use them to automatically apply fixits for a specific category of warnings.I think these files have the potential to be useful in other ways too. For instance these could be connected to Xcode (or another IDE), which was mentioned in #304. Or they could be used to give AI better context similar to what is discussed in https://tuist.dev/blog/2025/11/27/teaching-ai-to-read-xcode-builds.
Full disclosure: most of these changes were made using Cursor and only verified on 1 project. I pieced together the input for the compiler based on source code in the swift package manager.