1use anyhow::{anyhow, Result};
2use assistant_slash_command::{
3 ArgumentCompletion, SlashCommand, SlashCommandOutput, SlashCommandOutputSection,
4 SlashCommandResult,
5};
6use fuzzy::{PathMatch, StringMatchCandidate};
7use gpui::{AppContext, Model, Task, View, WeakView};
8use language::{
9 Anchor, BufferSnapshot, DiagnosticEntry, DiagnosticSeverity, LspAdapterDelegate,
10 OffsetRangeExt, ToOffset,
11};
12use project::{DiagnosticSummary, PathMatchCandidateSet, Project};
13use rope::Point;
14use std::{
15 fmt::Write,
16 path::{Path, PathBuf},
17 sync::{atomic::AtomicBool, Arc},
18};
19use ui::prelude::*;
20use util::paths::PathMatcher;
21use util::ResultExt;
22use workspace::Workspace;
23
24use crate::slash_command::create_label_for_command;
25
26pub(crate) struct DiagnosticsSlashCommand;
27
28impl DiagnosticsSlashCommand {
29 fn search_paths(
30 &self,
31 query: String,
32 cancellation_flag: Arc<AtomicBool>,
33 workspace: &View<Workspace>,
34 cx: &mut AppContext,
35 ) -> Task<Vec<PathMatch>> {
36 if query.is_empty() {
37 let workspace = workspace.read(cx);
38 let entries = workspace.recent_navigation_history(Some(10), cx);
39 let path_prefix: Arc<str> = Arc::default();
40 Task::ready(
41 entries
42 .into_iter()
43 .map(|(entry, _)| PathMatch {
44 score: 0.,
45 positions: Vec::new(),
46 worktree_id: entry.worktree_id.to_usize(),
47 path: entry.path.clone(),
48 path_prefix: path_prefix.clone(),
49 is_dir: false, // Diagnostics can't be produced for directories
50 distance_to_relative_ancestor: 0,
51 })
52 .collect(),
53 )
54 } else {
55 let worktrees = workspace.read(cx).visible_worktrees(cx).collect::<Vec<_>>();
56 let candidate_sets = worktrees
57 .into_iter()
58 .map(|worktree| {
59 let worktree = worktree.read(cx);
60 PathMatchCandidateSet {
61 snapshot: worktree.snapshot(),
62 include_ignored: worktree
63 .root_entry()
64 .map_or(false, |entry| entry.is_ignored),
65 include_root_name: true,
66 candidates: project::Candidates::Entries,
67 }
68 })
69 .collect::<Vec<_>>();
70
71 let executor = cx.background_executor().clone();
72 cx.foreground_executor().spawn(async move {
73 fuzzy::match_path_sets(
74 candidate_sets.as_slice(),
75 query.as_str(),
76 None,
77 false,
78 100,
79 &cancellation_flag,
80 executor,
81 )
82 .await
83 })
84 }
85 }
86}
87
88impl SlashCommand for DiagnosticsSlashCommand {
89 fn name(&self) -> String {
90 "diagnostics".into()
91 }
92
93 fn label(&self, cx: &AppContext) -> language::CodeLabel {
94 create_label_for_command("diagnostics", &[INCLUDE_WARNINGS_ARGUMENT], cx)
95 }
96
97 fn description(&self) -> String {
98 "Insert diagnostics".into()
99 }
100
101 fn menu_text(&self) -> String {
102 self.description()
103 }
104
105 fn requires_argument(&self) -> bool {
106 false
107 }
108
109 fn accepts_arguments(&self) -> bool {
110 true
111 }
112
113 fn complete_argument(
114 self: Arc<Self>,
115 arguments: &[String],
116 cancellation_flag: Arc<AtomicBool>,
117 workspace: Option<WeakView<Workspace>>,
118 cx: &mut WindowContext,
119 ) -> Task<Result<Vec<ArgumentCompletion>>> {
120 let Some(workspace) = workspace.and_then(|workspace| workspace.upgrade()) else {
121 return Task::ready(Err(anyhow!("workspace was dropped")));
122 };
123 let query = arguments.last().cloned().unwrap_or_default();
124
125 let paths = self.search_paths(query.clone(), cancellation_flag.clone(), &workspace, cx);
126 let executor = cx.background_executor().clone();
127 cx.background_executor().spawn(async move {
128 let mut matches: Vec<String> = paths
129 .await
130 .into_iter()
131 .map(|path_match| {
132 format!(
133 "{}{}",
134 path_match.path_prefix,
135 path_match.path.to_string_lossy()
136 )
137 })
138 .collect();
139
140 matches.extend(
141 fuzzy::match_strings(
142 &Options::match_candidates_for_args(),
143 &query,
144 false,
145 10,
146 &cancellation_flag,
147 executor,
148 )
149 .await
150 .into_iter()
151 .map(|candidate| candidate.string),
152 );
153
154 Ok(matches
155 .into_iter()
156 .map(|completion| ArgumentCompletion {
157 label: completion.clone().into(),
158 new_text: completion,
159 after_completion: assistant_slash_command::AfterCompletion::Run,
160 replace_previous_arguments: false,
161 })
162 .collect())
163 })
164 }
165
166 fn run(
167 self: Arc<Self>,
168 arguments: &[String],
169 _context_slash_command_output_sections: &[SlashCommandOutputSection<language::Anchor>],
170 _context_buffer: BufferSnapshot,
171 workspace: WeakView<Workspace>,
172 _delegate: Option<Arc<dyn LspAdapterDelegate>>,
173 cx: &mut WindowContext,
174 ) -> Task<SlashCommandResult> {
175 let Some(workspace) = workspace.upgrade() else {
176 return Task::ready(Err(anyhow!("workspace was dropped")));
177 };
178
179 let options = Options::parse(arguments);
180
181 let task = collect_diagnostics(workspace.read(cx).project().clone(), options, cx);
182
183 cx.spawn(move |_| async move {
184 task.await?
185 .map(|output| output.to_event_stream())
186 .ok_or_else(|| anyhow!("No diagnostics found"))
187 })
188 }
189}
190
191#[derive(Default)]
192struct Options {
193 include_warnings: bool,
194 path_matcher: Option<PathMatcher>,
195}
196
197const INCLUDE_WARNINGS_ARGUMENT: &str = "--include-warnings";
198
199impl Options {
200 fn parse(arguments: &[String]) -> Self {
201 let mut include_warnings = false;
202 let mut path_matcher = None;
203 for arg in arguments {
204 if arg == INCLUDE_WARNINGS_ARGUMENT {
205 include_warnings = true;
206 } else {
207 path_matcher = PathMatcher::new(&[arg.to_owned()]).log_err();
208 }
209 }
210 Self {
211 include_warnings,
212 path_matcher,
213 }
214 }
215
216 fn match_candidates_for_args() -> [StringMatchCandidate; 1] {
217 [StringMatchCandidate::new(
218 0,
219 INCLUDE_WARNINGS_ARGUMENT.to_string(),
220 )]
221 }
222}
223
224fn collect_diagnostics(
225 project: Model<Project>,
226 options: Options,
227 cx: &mut AppContext,
228) -> Task<Result<Option<SlashCommandOutput>>> {
229 let error_source = if let Some(path_matcher) = &options.path_matcher {
230 debug_assert_eq!(path_matcher.sources().len(), 1);
231 Some(path_matcher.sources().first().cloned().unwrap_or_default())
232 } else {
233 None
234 };
235
236 let glob_is_exact_file_match = if let Some(path) = options
237 .path_matcher
238 .as_ref()
239 .and_then(|pm| pm.sources().first())
240 {
241 PathBuf::try_from(path)
242 .ok()
243 .and_then(|path| {
244 project.read(cx).worktrees(cx).find_map(|worktree| {
245 let worktree = worktree.read(cx);
246 let worktree_root_path = Path::new(worktree.root_name());
247 let relative_path = path.strip_prefix(worktree_root_path).ok()?;
248 worktree.absolutize(&relative_path).ok()
249 })
250 })
251 .is_some()
252 } else {
253 false
254 };
255
256 let project_handle = project.downgrade();
257 let diagnostic_summaries: Vec<_> = project
258 .read(cx)
259 .diagnostic_summaries(false, cx)
260 .flat_map(|(path, _, summary)| {
261 let worktree = project.read(cx).worktree_for_id(path.worktree_id, cx)?;
262 let mut path_buf = PathBuf::from(worktree.read(cx).root_name());
263 path_buf.push(&path.path);
264 Some((path, path_buf, summary))
265 })
266 .collect();
267
268 cx.spawn(|mut cx| async move {
269 let mut output = SlashCommandOutput::default();
270
271 if let Some(error_source) = error_source.as_ref() {
272 writeln!(output.text, "diagnostics: {}", error_source).unwrap();
273 } else {
274 writeln!(output.text, "diagnostics").unwrap();
275 }
276
277 let mut project_summary = DiagnosticSummary::default();
278 for (project_path, path, summary) in diagnostic_summaries {
279 if let Some(path_matcher) = &options.path_matcher {
280 if !path_matcher.is_match(&path) {
281 continue;
282 }
283 }
284
285 project_summary.error_count += summary.error_count;
286 if options.include_warnings {
287 project_summary.warning_count += summary.warning_count;
288 } else if summary.error_count == 0 {
289 continue;
290 }
291
292 let last_end = output.text.len();
293 let file_path = path.to_string_lossy().to_string();
294 if !glob_is_exact_file_match {
295 writeln!(&mut output.text, "{file_path}").unwrap();
296 }
297
298 if let Some(buffer) = project_handle
299 .update(&mut cx, |project, cx| project.open_buffer(project_path, cx))?
300 .await
301 .log_err()
302 {
303 let snapshot = cx.read_model(&buffer, |buffer, _| buffer.snapshot())?;
304 collect_buffer_diagnostics(&mut output, &snapshot, options.include_warnings);
305 }
306
307 if !glob_is_exact_file_match {
308 output.sections.push(SlashCommandOutputSection {
309 range: last_end..output.text.len().saturating_sub(1),
310 icon: IconName::File,
311 label: file_path.into(),
312 metadata: None,
313 });
314 }
315 }
316
317 // No diagnostics found
318 if output.sections.is_empty() {
319 return Ok(None);
320 }
321
322 let mut label = String::new();
323 label.push_str("Diagnostics");
324 if let Some(source) = error_source {
325 write!(label, " ({})", source).unwrap();
326 }
327
328 if project_summary.error_count > 0 || project_summary.warning_count > 0 {
329 label.push(':');
330
331 if project_summary.error_count > 0 {
332 write!(label, " {} errors", project_summary.error_count).unwrap();
333 if project_summary.warning_count > 0 {
334 label.push_str(",");
335 }
336 }
337
338 if project_summary.warning_count > 0 {
339 write!(label, " {} warnings", project_summary.warning_count).unwrap();
340 }
341 }
342
343 output.sections.insert(
344 0,
345 SlashCommandOutputSection {
346 range: 0..output.text.len(),
347 icon: IconName::Warning,
348 label: label.into(),
349 metadata: None,
350 },
351 );
352
353 Ok(Some(output))
354 })
355}
356
357pub fn collect_buffer_diagnostics(
358 output: &mut SlashCommandOutput,
359 snapshot: &BufferSnapshot,
360 include_warnings: bool,
361) {
362 for (_, group) in snapshot.diagnostic_groups(None) {
363 let entry = &group.entries[group.primary_ix];
364 collect_diagnostic(output, entry, &snapshot, include_warnings)
365 }
366}
367
368fn collect_diagnostic(
369 output: &mut SlashCommandOutput,
370 entry: &DiagnosticEntry<Anchor>,
371 snapshot: &BufferSnapshot,
372 include_warnings: bool,
373) {
374 const EXCERPT_EXPANSION_SIZE: u32 = 2;
375 const MAX_MESSAGE_LENGTH: usize = 2000;
376
377 let (ty, icon) = match entry.diagnostic.severity {
378 DiagnosticSeverity::WARNING => {
379 if !include_warnings {
380 return;
381 }
382 ("warning", IconName::Warning)
383 }
384 DiagnosticSeverity::ERROR => ("error", IconName::XCircle),
385 _ => return,
386 };
387 let prev_len = output.text.len();
388
389 let range = entry.range.to_point(snapshot);
390 let diagnostic_row_number = range.start.row + 1;
391
392 let start_row = range.start.row.saturating_sub(EXCERPT_EXPANSION_SIZE);
393 let end_row = (range.end.row + EXCERPT_EXPANSION_SIZE).min(snapshot.max_point().row) + 1;
394 let excerpt_range =
395 Point::new(start_row, 0).to_offset(&snapshot)..Point::new(end_row, 0).to_offset(&snapshot);
396
397 output.text.push_str("```");
398 if let Some(language_name) = snapshot.language().map(|l| l.code_fence_block_name()) {
399 output.text.push_str(&language_name);
400 }
401 output.text.push('\n');
402
403 let mut buffer_text = String::new();
404 for chunk in snapshot.text_for_range(excerpt_range) {
405 buffer_text.push_str(chunk);
406 }
407
408 for (i, line) in buffer_text.lines().enumerate() {
409 let line_number = start_row + i as u32 + 1;
410 writeln!(output.text, "{}", line).unwrap();
411
412 if line_number == diagnostic_row_number {
413 output.text.push_str("//");
414 let prev_len = output.text.len();
415 write!(output.text, " {}: ", ty).unwrap();
416 let padding = output.text.len() - prev_len;
417
418 let message = util::truncate(&entry.diagnostic.message, MAX_MESSAGE_LENGTH)
419 .replace('\n', format!("\n//{:padding$}", "").as_str());
420
421 writeln!(output.text, "{message}").unwrap();
422 }
423 }
424
425 writeln!(output.text, "```").unwrap();
426 output.sections.push(SlashCommandOutputSection {
427 range: prev_len..output.text.len().saturating_sub(1),
428 icon,
429 label: entry.diagnostic.message.clone().into(),
430 metadata: None,
431 });
432}