feat: add URL property to CompilerError and CompilerDiagnostic #5634
+925
−281
Conversation
This file contains hidden or 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
- Enhanced CompilerError and diagnostic structures to include an optional URL property. - Updated related functions to handle the new URL field, ensuring it is preserved during error generation and normalization. - Added tests to verify the inclusion of URL in various error scenarios.
|
Thanks for the contribution! Before we can merge this, we need @Srijan0101 to sign the Salesforce Inc. Contributor License Agreement. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Details
This PR introduces URL property from the
LWCErrorInfotoCompilerDiagnosticandCompilerErrorso that the compiler can show LWC error docs that we are hosting in https://lwc.dev/guide/error_codes in the current and SARIF diagnostics. This approach was initially discussed here: linkDoes this pull request introduce a breaking change?
Does this pull request introduce an observable change?
Once this PR is merged, the users will be able to access 'url' property in the compiler diagnostics along with code, message and other already accessible CompilerDiagnostic properties.
GUS work item
W-20469461