Initial diagnostic API for proc-macros. #44125
Merged
Conversation
This file contains 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
This commit introduces the ability to create and emit `Diagnostic` structures from proc-macros, allowing for proc-macro authors to emit warning, error, note, and help messages just like the compiler does.
|
r? @nrc |
carols10cents
added
the
S-waiting-on-review
|
@bors: r+ |
|
📌 Commit 8be132e has been approved by |
alexcrichton
added a commit
to alexcrichton/rust
that referenced
this pull request
Aug 30, 2017
Initial diagnostic API for proc-macros.
This commit introduces the ability to create and emit `Diagnostic` structures from proc-macros, allowing for proc-macro authors to emit warning, error, note, and help messages just like the compiler does.
The API is somewhat based on the diagnostic API already present in `rustc` with several changes that improve usability. The entry point into the diagnostic API is a new `Diagnostic` type which is primarily created through new `error`, `warning`, `help`, and `note` methods on `Span`. The `Diagnostic` type records the diagnostic level, message, and optional `Span` for the top-level diagnostic and contains a `Vec` of all of the child diagnostics. Child diagnostics can be added through builder methods on `Diagnostic`.
A typical use of the API may look like:
```rust
let token = parse_token();
let val = parse_val();
val.span
.error(format!("expected A but found {}", val))
.span_note(token.span, "because of this token")
.help("consider using a different token")
.emit();
```
cc @jseyfried @nrc @dtolnay @alexcrichton
bors
added a commit
that referenced
this pull request
Aug 31, 2017
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 commit introduces the ability to create and emit
Diagnosticstructures from proc-macros, allowing for proc-macro authors to emit warning, error, note, and help messages just like the compiler does.The API is somewhat based on the diagnostic API already present in
rustcwith several changes that improve usability. The entry point into the diagnostic API is a newDiagnostictype which is primarily created through newerror,warning,help, andnotemethods onSpan. TheDiagnostictype records the diagnostic level, message, and optionalSpanfor the top-level diagnostic and contains aVecof all of the child diagnostics. Child diagnostics can be added through builder methods onDiagnostic.A typical use of the API may look like:
cc @jseyfried @nrc @dtolnay @alexcrichton