fix(macro): make smartLink() error message more informative #11042
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.
Summary
For sidebar macros, if there is a bad URL used, then the
smartLink
function throws a confusing flaw:Error: wrong xref macro used (consider changing which macro you use)
. This doesn't give much information about the buggy URL.Also, the printed stack trace doesn't help in this situation to narrow down the location. Stack trace code line numbers are not the same because
.ts
file gets converted to.js
.Solution
In the error message log path sent to the smartLink function. This will help sidebar macro maintainers to quickly figure out erroneous paths.
Before
After
How did you test this change?
In local dev environment reproduced #11040 issue and tested output before and after the fix.