feat(lint): handle jsdoc and tsdoc syntax in nounusedimports #5698
+814
−10
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
github-actions
bot
added
A-Project
Danielku15
changed the title
1 task
Danielku15
changed the title
arendjr
approved these changes
Apr 18, 2025
| LazyLock::new(|| Regex::new(r"\{@(link|see)\s*([^}| #\.]+)(?:[^}]+)?\}").unwrap()); | ||
|
|
||
| static JSDOC_TYPE_TAG_REGEX: LazyLock<Regex> = | ||
| LazyLock::new(|| Regex::new(r"@(param|returns|type|typedef)\s*\{([^}]+)}").unwrap()); |
There was a problem hiding this comment.
I suppose the last } doesn't really need escaping, but let's stay on the safe side :)
Suggested change
| LazyLock::new(|| Regex::new(r"@(param|returns|type|typedef)\s*\{([^}]+)}").unwrap()); | |
| LazyLock::new(|| Regex::new(r"@(param|returns|type|typedef)\s*\{([^}]+)\}").unwrap()); |
| } | ||
|
|
||
| fn load_jsdoc_types_from_node(model: &mut JsDocTypeModel, node: &SyntaxNode<JsLanguage>) { | ||
| if let Ok(comment) = JsdocComment::try_from(node) { |
There was a problem hiding this comment.
Do the regular expressions need to be able to work across newlines? If not, maybe you can even use JsdocComment::text_is_jsdoc_comment() only and avoid instantiating the JsdocComment itself. The regular expressions may just work fine on the raw string, so you would avoid some allocation and unnecesssary work in that case.
CodSpeed Performance ReportMerging #5698 will not alter performanceComparing Summary
|
chansuke
reviewed
Apr 19, 2025
| match event { | ||
| WalkEvent::Enter(node) => { | ||
| if AnyJsWithTypeReferencingJsDoc::can_cast(node.kind()) { | ||
| load_jsdoc_types_from_node(&mut self.jsdoc_types, &node); |
There was a problem hiding this comment.
Suggested change
| load_jsdoc_types_from_node(&mut self.jsdoc_types, &node); | |
| load_jsdoc_types_from_node(&mut self.jsdoc_types, node); |
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.
Summary
#4677
Adds the initial foundation for detecting type usage in JSDoc and TSDoc comments to avoid imports being flagged as unused.
use_hook_at_top_level.rs1this.field =initializers in constructor) - Performance impact might be quite high if we handle all assignment expression statements./** @typedef {import('module').Type} Alias */in such cases instead of adding an import?Test Plan
I added a variety of spec-tests which should show that things are mostly working as expected. Especially for TypeScript things should be well covered for most use-cases. For JSDoc I am a bit more reserved.
Footnotes
https://github.com/biomejs/biome/issues/4677#issuecomment-2813648388 ↩