averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-21 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

[Diagnostics][SourceKit] Expose diagnostic educational notes through SourceKit requests

Browse Source
This commit is contained in:
Owen Voorhees
2019-11-11 17:00:42 -08:00
parent dddcfb8348
commit f11df3ee22
6 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
test/SourceKit/Sema/educational_note_diags.swift Normal file
View File

@@ -0,0 +1,13 @@
extension (Int, Int) {}
// RUN: %sourcekitd-test -req=sema %s -- -Xfrontend -enable-descriptive-diagnostics -Xfrontend -diagnostic-documentation-path -Xfrontend /educational/notes/path/prefix %s | %FileCheck %s -check-prefix=DESCRIPTIVE
// DESCRIPTIVE: key.description: "non-nominal type
// DESCRIPTIVE: key.educational_note_paths: [
// DESCRIPTIVE-NEXT: "/educational/notes/path/prefix/nominal-types.md"
// DESCRIPTIVE-NEXT: ]
// RUN: %sourcekitd-test -req=sema %s -- %s | %FileCheck %s -check-prefix=DESCRIPTIVE-DISABLED
// DESCRIPTIVE-DISABLED: key.description: "non-nominal type
// DESCRIPTIVE-DISABLED-NOT: key.educational_note_paths

1
tools/SourceKit/docs/Protocol.md
View File

@@ -418,6 +418,7 @@ of diagnostic entries. A diagnostic entry has this format:
[opts] <key.fixits>: (array) [fixit+] // one or more entries for fixits
[opts] <key.ranges>: (array) [range+] // one or more entries for ranges
[opts] <key.diagnostics>: (array) [diagnostic+] // one or more sub-diagnostic entries
[opts] <key.educational_note_paths>: (array) [string+] // one or more absolute paths of educational notes, formatted as Markdown
}
```

1
tools/SourceKit/include/SourceKit/Core/LangSupport.h
View File

@@ -203,6 +203,7 @@ struct DiagnosticEntryInfoBase {
std::string Filename;
SmallVector<std::pair<unsigned, unsigned>, 2> Ranges;
SmallVector<Fixit, 2> Fixits;
SmallVector<std::string, 1> EducationalNotePaths;
};
struct DiagnosticEntryInfo : DiagnosticEntryInfoBase {

3
tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp
View File

@@ -110,6 +110,9 @@ void EditorDiagConsumer::handleDiagnostic(SourceManager &SM,
}
SKInfo.Description = Text.str();
for (auto notePath : Info.EducationalNotePaths)
SKInfo.EducationalNotePaths.push_back(notePath);
Optional<unsigned> BufferIDOpt;
if (Info.Loc.isValid()) {
BufferIDOpt = SM.findBufferContainingLoc(Info.Loc);

3
tools/SourceKit/tools/sourcekitd/lib/API/Requests.cpp
View File

@@ -2686,6 +2686,9 @@ static void fillDictionaryForDiagnosticInfoBase(
if (!Info.Filename.empty())
Elem.set(KeyFilePath, Info.Filename);
if (!Info.EducationalNotePaths.empty())
Elem.set(KeyEducationalNotePaths, Info.EducationalNotePaths);
if (!Info.Ranges.empty()) {
auto RangesArr = Elem.setArray(KeyRanges);
for (auto R : Info.Ranges) {

1
utils/gyb_sourcekit_support/UIDs.py
View File

@@ -96,6 +96,7 @@ UID_KEYS = [
KEY('Ranges', 'key.ranges'),
KEY('Fixits', 'key.fixits'),
KEY('Diagnostics', 'key.diagnostics'),
KEY('EducationalNotePaths', 'key.educational_note_paths'),
KEY('FormatOptions', 'key.editor.format.options'),
KEY('CodeCompleteOptions', 'key.codecomplete.options'),
KEY('FilterRules', 'key.codecomplete.filterrules'),