Add an optional diagnostic category to diagnostics #2981
Conversation
A diagnostic category provides a category name that is used to identify a set of related diagnostics. It can also include a documentation path to provide more information about those diagnostics, to help guide the user in resolving them. Always render a category as [#CategoryName] at the end of the diagnostic message. When we are producing colored output and there is a documentation path, make the category name a hyperlink to the documentation using the OSC 8 scheme.
DougGregor
force-pushed
the
diagnostic-category
branch
from
efd0aeb to
01c7c33
Compare
|
@swift-ci please test |
|
@swift-ci please test macOS |
Sources/SwiftDiagnostics/DiagnosticDecorators/ANSIDiagnosticDecorator.swift
Show resolved
Hide resolved
|
|
||
| /// Forms a hyperlink to the given URL with the given text. | ||
| static func hyperlink(_ text: String, to url: String) -> String { | ||
| "\u{001B}]8;;\(url)\u{001B}\\\(text)\u{001B}]8;;\u{001B}\\" |
There was a problem hiding this comment.
Uh, interesting. I did not know that terminals support hyperlinks. ✨
There was a problem hiding this comment.
Do you know which terminal applications support this functionality? I don't think it's universal (the VT-100 certainly didn't have the feature.)
There was a problem hiding this comment.
Looks like Apple's Terminal.app doesn't support it. Allegedly Konsole doesn't either, although I don't have a copy handy.
There was a problem hiding this comment.
(Also, as an aside, you may want to escape both strings.)
There was a problem hiding this comment.
There's a list of terminals supporting this at https://github.com/Alhadis/OSC8-Adoption/. Terminal.app doesn't, but it doesn't blow up on it, either; it just shows the text (not the link), which is fine.
Since we're creating a hyperlink to it, we want a URL here.
DougGregor
force-pushed
the
diagnostic-category
branch
from
01c7c33 to
e3b4abf
Compare
|
@swift-ci please test |
|
@swift-ci please test Linux |
|
@swift-ci please test Windows |
DougGregor
force-pushed
the
diagnostic-category
branch
from
0897ff5 to
d877261
Compare
|
@swift-ci please test |
|
@swift-ci please test Windows |
|
@swift-ci please test platform Windows |
|
@swift-ci please test macOS |
|
@swift-ci please test Windows |
|
@swift-ci Please test Windows |
4 participants
A diagnostic category provides a category name that is used to identify a set of related diagnostics. It can also include a documentation path to provide more information about those diagnostics, to help guide the user in resolving them.
Always render a category as
[#CategoryName]at the end of the diagnostic message. When we are producing colored output and there is a documentation path, make the category name a hyperlink to the documentation using the OSC 8 scheme.