-
-
Notifications
You must be signed in to change notification settings - Fork 542
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(linter): implement useSymbolDescription
#5232
Conversation
CodSpeed Performance ReportMerging #5232 will not alter performanceComparing Summary
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! All good, however the diagnostic needs a rework
crates/biome_js_analyze/src/lint/nursery/use_symbol_description.rs
Outdated
Show resolved
Hide resolved
"Provide a description for the symbol." | ||
}, | ||
) | ||
.note(markup! { | ||
"Explicit description can be useful in debugging and making purpose of the symbol clearer." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please follow the rule pillars: https://biomejs.dev/linter/#rule-pillars
In this case the first one is missing, which should be at line 69. The phrase at line 69 is the third pillar.
a9d1e65
to
14729a4
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this rule should cover empty strings/template literals too. What do you think?
ed36ad5
to
335a4d6
Compare
Summary
Implement symbol-description. Makes sure that
Symbol()
constructor always has description param.Closes #5231
Test Plan