mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
791312fb74
* [Diagnostics] Turn educational notes on-by-default * [Diagnostics] Only include educational notes in printed output if -print-educational-notes is passed * Make -print-educational-notes a driver option * [Diagnostics] Issue a printed remark if educational notes are available, but disabled * [docs] Update educational notes documentation and add a contributing guide * [Diagnostics] Cleanup PrintingDiagnosticConsumer handling of edu notes * Revert "[Diagnostics] Issue a printed remark if educational notes are available, but disabled" For now, don't notify users if edu notes are available but disabled. This decision can be reevaluated later.
85 lines
3.3 KiB
Swift
85 lines
3.3 KiB
Swift
// RUN: not %target-swift-frontend -color-diagnostics -print-educational-notes -diagnostic-documentation-path %S/test-docs/ -typecheck %s 2>&1 | %FileCheck %s --match-full-lines --strict-whitespace
|
||
// RUN: not %target-swift-frontend -no-color-diagnostics -print-educational-notes -diagnostic-documentation-path %S/test-docs/ -typecheck %s 2>&1 | %FileCheck %s --match-full-lines --strict-whitespace --check-prefix=NO-COLOR
|
||
// RUN: not %target-swift-frontend -enable-experimental-diagnostic-formatting -print-educational-notes -diagnostic-documentation-path %S/test-docs/ -typecheck %s 2>&1 | %FileCheck %s --check-prefix=CHECK-DESCRIPTIVE
|
||
|
||
// A diagnostic with no educational notes
|
||
let x = 1 +
|
||
// CHECK:{{.*}}[0m[0;1;31merror: [0m[1mexpected expression after operator
|
||
// CHECK-NOT: {{-+$}}
|
||
|
||
// NO-COLOR:{{.*}}error: expected expression after operator
|
||
// NO-COLOR-NOT: {{-+$}}
|
||
|
||
// A diagnostic with an educational note using supported markdown features
|
||
extension (Int, Int) {}
|
||
// CHECK:{{.*}}[0m[0;1;31merror: [0m[1mnon-nominal type '(Int, Int)' cannot be extended
|
||
// CHECK-NEXT:[0mextension (Int, Int) {}
|
||
// CHECK-NEXT:[0;1;32m^ ~~~~~~~~~~
|
||
// CHECK-NEXT:[0m[0m[1mNominal Types[0m
|
||
// CHECK-NEXT:--------------
|
||
// CHECK-EMPTY:
|
||
// CHECK-NEXT:Nominal types documentation content. This is a paragraph
|
||
// CHECK-EMPTY:
|
||
// CHECK-NEXT: blockquote
|
||
// CHECK-NEXT: {{$}}
|
||
// CHECK-NEXT: - item 1
|
||
// CHECK-NEXT: - item 2
|
||
// CHECK-NEXT: - item 3
|
||
// CHECK-NEXT: {{$}}
|
||
// CHECK-NEXT: let x = 42
|
||
// CHECK-NEXT: if x > 0 {
|
||
// CHECK-NEXT: print("positive")
|
||
// CHECK-NEXT: }
|
||
// CHECK-NEXT: {{$}}
|
||
// CHECK-NEXT:Type 'MyClass'
|
||
// CHECK-EMPTY:
|
||
// CHECK-NEXT:[Swift](swift.org)
|
||
// CHECK-EMPTY:
|
||
// CHECK-NEXT:[0m[1mbold[0m italics
|
||
// CHECK-NEXT:--------------
|
||
// CHECK-NEXT:[0m[1mHeader 1[0m
|
||
// CHECK-NEXT:[0m[1mHeader 3[0m
|
||
|
||
// NO-COLOR:{{.*}}error: non-nominal type '(Int, Int)' cannot be extended
|
||
// NO-COLOR-NEXT:extension (Int, Int) {}
|
||
// NO-COLOR-NEXT:^ ~~~~~~~~~~
|
||
// NO-COLOR-NEXT:Nominal Types
|
||
// NO-COLOR-NEXT:--------------
|
||
// NO-COLOR-EMPTY:
|
||
// NO-COLOR-NEXT:Nominal types documentation content. This is a paragraph
|
||
// NO-COLOR-EMPTY:
|
||
// NO-COLOR-NEXT: blockquote
|
||
// NO-COLOR-NEXT: {{$}}
|
||
// NO-COLOR-NEXT: - item 1
|
||
// NO-COLOR-NEXT: - item 2
|
||
// NO-COLOR-NEXT: - item 3
|
||
// NO-COLOR-NEXT: {{$}}
|
||
// NO-COLOR-NEXT: let x = 42
|
||
// NO-COLOR-NEXT: if x > 0 {
|
||
// NO-COLOR-NEXT: print("positive")
|
||
// NO-COLOR-NEXT: }
|
||
// NO-COLOR-NEXT: {{$}}
|
||
// NO-COLOR-NEXT:Type 'MyClass'
|
||
// NO-COLOR-EMPTY:
|
||
// NO-COLOR-NEXT:[Swift](swift.org)
|
||
// NO-COLOR-EMPTY:
|
||
// NO-COLOR-NEXT:bold italics
|
||
// NO-COLOR-NEXT:--------------
|
||
// NO-COLOR-NEXT:Header 1
|
||
// NO-COLOR-NEXT:Header 3
|
||
|
||
// CHECK-DESCRIPTIVE: educational-notes.swift
|
||
// CHECK-DESCRIPTIVE-NEXT: | // A diagnostic with an educational note
|
||
// CHECK-DESCRIPTIVE-NEXT: | extension (Int, Int) {}
|
||
// CHECK-DESCRIPTIVE-NEXT: | ^ error: expected expression after operator
|
||
// CHECK-DESCRIPTIVE-NEXT: |
|
||
|
||
// CHECK-DESCRIPTIVE: educational-notes.swift
|
||
// CHECK-DESCRIPTIVE-NEXT: | // A diagnostic with an educational note
|
||
// CHECK-DESCRIPTIVE-NEXT: | extension (Int, Int) {}
|
||
// CHECK-DESCRIPTIVE-NEXT: | ~~~~~~~~~~
|
||
// CHECK-DESCRIPTIVE-NEXT: | ^ error: non-nominal type '(Int, Int)' cannot be extended
|
||
// CHECK-DESCRIPTIVE-NEXT: |
|
||
// CHECK-DESCRIPTIVE-NEXT: Nominal Types
|
||
// CHECK-DESCRIPTIVE-NEXT: -------------
|