Detect a common syntax error case for diagnostic_directive #6718
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
If the user has a global_decl of the form `@diagnostic(...);`, display a note suggesting they remove the `@` to create a diagnostic_directive, if that is their intent.
|
Definitely want a note on the changelog, will also make sure you get listed as a contributor to the release :) |
ErichDonGubler
added
type: enhancement
…ticAttributeNotSupported` render logic
ErichDonGubler
approved these changes
Dec 16, 2024
There was a problem hiding this comment.
Made a few tweaks to the original changes. @e-hat, did you have any thoughts on what I pushed up before merging?
|
@e-hat: Also welcome, and thanks for making diagnostics in |
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.
If the user has a
global_declof the form@diagnostic(...);, display a note suggesting they remove the@to create a globaldiagnostic_directive, which will apply the diagnostic filter to the entire module.Connections
Addresses #6536.
Description
Sometimes the user will intend to declare a
diagnostic_directiveto apply a diagnostic filter to the entire module using the following incorrect syntax, i.e.:The
@symbol is used to declare a scoped diagnostic attribute (diagnostic_attr) but not a globaldiagnostic_directive. This change adds a note to the error message in this case to use the correct syntax:Testing
Added a test
front::wgsl::tests::diagnostic_filter::intended_global_directivethat tests the case described above against the expected error message + notes.Checklist
cargo fmt.taplo format.cargo clippy. If applicable, add:--target wasm32-unknown-unknown--target wasm32-unknown-emscriptencargo xtask testto run tests.CHANGELOG.md. See simple instructions inside file.Not sure about some steps in the checklist, maybe these checks are failing because of my local setup.
Also not sure if this small change belongs in the changelog.Thanks.