language-servers/tinymist
1
0
Fork 0
mirror of https://github.com/Myriad-Dreamin/tinymist.git synced 2025-11-22 12:34:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

simplify dead code checks and enhance diagnostic messages for unused symbols

Browse source
This commit is contained in:
Hong Jiarong 2025-11-15 21:56:08 +08:00
parent f6b6b679f4
commit c532b4a099
2 changed files with 17 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

6
crates/tinymist-lint/src/dead_code.rs
View file

@ -84,11 +84,7 @@ fn should_skip_definition(def_info: &DefInfo, config: &DeadCodeConfig) -> bool {
matches!( matches!(
def_info.decl.as_ref(), def_info.decl.as_ref(),
Decl::ModuleImport(_) Decl::Pattern(_) | Decl::Spread(_) | Decl::Constant(_) | Decl::Content(_)
| Decl::Pattern(_)
| Decl::Spread(_)
| Decl::Constant(_)
| Decl::Content(_)
) )
} }

25
crates/tinymist-lint/src/dead_code/diagnostic.rs
View file

@ -3,7 +3,7 @@
//! This module creates user-friendly diagnostic messages for unused //! This module creates user-friendly diagnostic messages for unused
//! definitions, with appropriate hints and severity levels. //! definitions, with appropriate hints and severity levels.
use tinymist_analysis::syntax::{DefKind, ExprInfo}; use tinymist_analysis::syntax::{Decl, DefKind, ExprInfo};
use tinymist_project::LspWorld; use tinymist_project::LspWorld;
use typst::diag::{SourceDiagnostic, eco_format}; use typst::diag::{SourceDiagnostic, eco_format};
@ -23,6 +23,9 @@ pub fn generate_diagnostic(
return None; return None;
} }
let is_module_import = matches!(def_info.decl.as_ref(), Decl::ModuleImport(..));
let is_module_like = is_module_import || matches!(def_info.kind, DefKind::Module);
let kind_str = match def_info.kind { let kind_str = match def_info.kind {
DefKind::Function => "function", DefKind::Function => "function",
DefKind::Variable => "variable", DefKind::Variable => "variable",
@ -35,13 +38,16 @@ pub fn generate_diagnostic(
let name = def_info.decl.name(); let name = def_info.decl.name();
// Don't warn about empty names (anonymous items) // Don't warn about empty names (anonymous items)
if name.is_empty() { if name.is_empty() && !is_module_import {
return None; return None;
} }
// Create the base diagnostic // Create the base diagnostic
let mut diag = let mut diag = if is_module_import {
SourceDiagnostic::warning(def_info.span, eco_format!("unused {kind_str}: `{name}`")); SourceDiagnostic::warning(def_info.span, eco_format!("unused module import"))
} else {
SourceDiagnostic::warning(def_info.span, eco_format!("unused {kind_str}: `{name}`"))
};
// Add helpful hints based on the scope and kind // Add helpful hints based on the scope and kind
match def_info.scope { match def_info.scope {
@ -50,11 +56,12 @@ pub fn generate_diagnostic(
"if this parameter is intentionally unused, prefix it with underscore: `_{name}`" "if this parameter is intentionally unused, prefix it with underscore: `_{name}`"
)); ));
} }
DefScope::File | DefScope::Local => { DefScope::File | DefScope::Local if !is_module_like => {
diag = diag.with_hint(eco_format!( diag = diag.with_hint(eco_format!(
"consider removing this {kind_str} or prefixing with underscore: `_{name}`" "consider removing this {kind_str} or prefixing with underscore: `_{name}`"
)); ));
} }
DefScope::File | DefScope::Local => {}
DefScope::Exported => { DefScope::Exported => {
diag = diag.with_hint(eco_format!("this {kind_str} is exported but never used")); diag = diag.with_hint(eco_format!("this {kind_str} is exported but never used"));
} }
@ -71,12 +78,12 @@ pub fn generate_diagnostic(
return None; return None;
} }
} }
DefKind::Module => {
diag =
diag.with_hint("imported modules should be used or the import should be removed");
}
_ => {} _ => {}
} }
if is_module_like {
diag = diag.with_hint("imported modules should be used or the import should be removed");
}
Some(diag) Some(diag)
} }