1use std::path::Path;
2use std::sync::atomic::AtomicBool;
3use std::sync::Arc;
4use std::time::Duration;
5
6use anyhow::{anyhow, bail, Result};
7use assistant_slash_command::{
8 ArgumentCompletion, SlashCommand, SlashCommandOutput, SlashCommandOutputSection,
9};
10use gpui::{AppContext, BackgroundExecutor, Model, Task, WeakView};
11use indexed_docs::{
12 DocsDotRsProvider, IndexedDocsRegistry, IndexedDocsStore, LocalRustdocProvider, PackageName,
13 ProviderId,
14};
15use language::LspAdapterDelegate;
16use project::{Project, ProjectPath};
17use ui::prelude::*;
18use util::{maybe, ResultExt};
19use workspace::Workspace;
20
21pub(crate) struct DocsSlashCommand;
22
23impl DocsSlashCommand {
24 pub const NAME: &'static str = "docs";
25
26 fn path_to_cargo_toml(project: Model<Project>, cx: &mut AppContext) -> Option<Arc<Path>> {
27 let worktree = project.read(cx).worktrees(cx).next()?;
28 let worktree = worktree.read(cx);
29 let entry = worktree.entry_for_path("Cargo.toml")?;
30 let path = ProjectPath {
31 worktree_id: worktree.id(),
32 path: entry.path.clone(),
33 };
34 Some(Arc::from(
35 project.read(cx).absolute_path(&path, cx)?.as_path(),
36 ))
37 }
38
39 /// Ensures that the indexed doc providers for Rust are registered.
40 ///
41 /// Ideally we would do this sooner, but we need to wait until we're able to
42 /// access the workspace so we can read the project.
43 fn ensure_rust_doc_providers_are_registered(
44 &self,
45 workspace: Option<WeakView<Workspace>>,
46 cx: &mut AppContext,
47 ) {
48 let indexed_docs_registry = IndexedDocsRegistry::global(cx);
49 if indexed_docs_registry
50 .get_provider_store(LocalRustdocProvider::id())
51 .is_none()
52 {
53 let index_provider_deps = maybe!({
54 let workspace = workspace.clone().ok_or_else(|| anyhow!("no workspace"))?;
55 let workspace = workspace
56 .upgrade()
57 .ok_or_else(|| anyhow!("workspace was dropped"))?;
58 let project = workspace.read(cx).project().clone();
59 let fs = project.read(cx).fs().clone();
60 let cargo_workspace_root = Self::path_to_cargo_toml(project, cx)
61 .and_then(|path| path.parent().map(|path| path.to_path_buf()))
62 .ok_or_else(|| anyhow!("no Cargo workspace root found"))?;
63
64 anyhow::Ok((fs, cargo_workspace_root))
65 });
66
67 if let Some((fs, cargo_workspace_root)) = index_provider_deps.log_err() {
68 indexed_docs_registry.register_provider(Box::new(LocalRustdocProvider::new(
69 fs,
70 cargo_workspace_root,
71 )));
72 }
73 }
74
75 if indexed_docs_registry
76 .get_provider_store(DocsDotRsProvider::id())
77 .is_none()
78 {
79 let http_client = maybe!({
80 let workspace = workspace.ok_or_else(|| anyhow!("no workspace"))?;
81 let workspace = workspace
82 .upgrade()
83 .ok_or_else(|| anyhow!("workspace was dropped"))?;
84 let project = workspace.read(cx).project().clone();
85 anyhow::Ok(project.read(cx).client().http_client().clone())
86 });
87
88 if let Some(http_client) = http_client.log_err() {
89 indexed_docs_registry
90 .register_provider(Box::new(DocsDotRsProvider::new(http_client)));
91 }
92 }
93 }
94
95 /// Runs just-in-time indexing for a given package, in case the slash command
96 /// is run without any entries existing in the index.
97 fn run_just_in_time_indexing(
98 store: Arc<IndexedDocsStore>,
99 key: String,
100 package: PackageName,
101 executor: BackgroundExecutor,
102 ) -> Task<()> {
103 executor.clone().spawn(async move {
104 let (prefix, needs_full_index) = if let Some((prefix, _)) = key.split_once('*') {
105 // If we have a wildcard in the search, we want to wait until
106 // we've completely finished indexing so we get a full set of
107 // results for the wildcard.
108 (prefix.to_string(), true)
109 } else {
110 (key, false)
111 };
112
113 // If we already have some entries, we assume that we've indexed the package before
114 // and don't need to do it again.
115 let has_any_entries = store
116 .any_with_prefix(prefix.clone())
117 .await
118 .unwrap_or_default();
119 if has_any_entries {
120 return ();
121 };
122
123 let index_task = store.clone().index(package.clone());
124
125 if needs_full_index {
126 _ = index_task.await;
127 } else {
128 loop {
129 executor.timer(Duration::from_millis(200)).await;
130
131 if store
132 .any_with_prefix(prefix.clone())
133 .await
134 .unwrap_or_default()
135 || !store.is_indexing(&package)
136 {
137 break;
138 }
139 }
140 }
141 })
142 }
143}
144
145impl SlashCommand for DocsSlashCommand {
146 fn name(&self) -> String {
147 Self::NAME.into()
148 }
149
150 fn description(&self) -> String {
151 "insert docs".into()
152 }
153
154 fn menu_text(&self) -> String {
155 "Insert Documentation".into()
156 }
157
158 fn requires_argument(&self) -> bool {
159 true
160 }
161
162 fn complete_argument(
163 self: Arc<Self>,
164 arguments: &[String],
165 _cancel: Arc<AtomicBool>,
166 workspace: Option<WeakView<Workspace>>,
167 cx: &mut WindowContext,
168 ) -> Task<Result<Vec<ArgumentCompletion>>> {
169 self.ensure_rust_doc_providers_are_registered(workspace, cx);
170
171 let indexed_docs_registry = IndexedDocsRegistry::global(cx);
172 let args = DocsSlashCommandArgs::parse(arguments);
173 let store = args
174 .provider()
175 .ok_or_else(|| anyhow!("no docs provider specified"))
176 .and_then(|provider| IndexedDocsStore::try_global(provider, cx));
177 cx.background_executor().spawn(async move {
178 fn build_completions(items: Vec<String>) -> Vec<ArgumentCompletion> {
179 items
180 .into_iter()
181 .map(|item| ArgumentCompletion {
182 label: item.clone().into(),
183 new_text: item.to_string(),
184 after_completion: assistant_slash_command::AfterCompletion::Run,
185 replace_previous_arguments: false,
186 })
187 .collect()
188 }
189
190 match args {
191 DocsSlashCommandArgs::NoProvider => {
192 let providers = indexed_docs_registry.list_providers();
193 if providers.is_empty() {
194 return Ok(vec![ArgumentCompletion {
195 label: "No available docs providers.".into(),
196 new_text: String::new(),
197 after_completion: false.into(),
198 replace_previous_arguments: false,
199 }]);
200 }
201
202 Ok(providers
203 .into_iter()
204 .map(|provider| ArgumentCompletion {
205 label: provider.to_string().into(),
206 new_text: provider.to_string(),
207 after_completion: false.into(),
208 replace_previous_arguments: false,
209 })
210 .collect())
211 }
212 DocsSlashCommandArgs::SearchPackageDocs {
213 provider,
214 package,
215 index,
216 } => {
217 let store = store?;
218
219 if index {
220 // We don't need to hold onto this task, as the `IndexedDocsStore` will hold it
221 // until it completes.
222 drop(store.clone().index(package.as_str().into()));
223 }
224
225 let suggested_packages = store.clone().suggest_packages().await?;
226 let search_results = store.search(package).await;
227
228 let mut items = build_completions(search_results);
229 let workspace_crate_completions = suggested_packages
230 .into_iter()
231 .filter(|package_name| {
232 !items
233 .iter()
234 .any(|item| item.label.text() == package_name.as_ref())
235 })
236 .map(|package_name| ArgumentCompletion {
237 label: format!("{package_name} (unindexed)").into(),
238 new_text: format!("{package_name}"),
239 after_completion: true.into(),
240 replace_previous_arguments: false,
241 })
242 .collect::<Vec<_>>();
243 items.extend(workspace_crate_completions);
244
245 if items.is_empty() {
246 return Ok(vec![ArgumentCompletion {
247 label: format!(
248 "Enter a {package_term} name.",
249 package_term = package_term(&provider)
250 )
251 .into(),
252 new_text: provider.to_string(),
253 after_completion: false.into(),
254 replace_previous_arguments: false,
255 }]);
256 }
257
258 Ok(items)
259 }
260 DocsSlashCommandArgs::SearchItemDocs { item_path, .. } => {
261 let store = store?;
262 let items = store.search(item_path).await;
263 Ok(build_completions(items))
264 }
265 }
266 })
267 }
268
269 fn run(
270 self: Arc<Self>,
271 arguments: &[String],
272 _workspace: WeakView<Workspace>,
273 _delegate: Option<Arc<dyn LspAdapterDelegate>>,
274 cx: &mut WindowContext,
275 ) -> Task<Result<SlashCommandOutput>> {
276 if arguments.is_empty() {
277 return Task::ready(Err(anyhow!("missing an argument")));
278 };
279
280 let args = DocsSlashCommandArgs::parse(arguments);
281 let executor = cx.background_executor().clone();
282 let task = cx.background_executor().spawn({
283 let store = args
284 .provider()
285 .ok_or_else(|| anyhow!("no docs provider specified"))
286 .and_then(|provider| IndexedDocsStore::try_global(provider, cx));
287 async move {
288 let (provider, key) = match args.clone() {
289 DocsSlashCommandArgs::NoProvider => bail!("no docs provider specified"),
290 DocsSlashCommandArgs::SearchPackageDocs {
291 provider, package, ..
292 } => (provider, package),
293 DocsSlashCommandArgs::SearchItemDocs {
294 provider,
295 item_path,
296 ..
297 } => (provider, item_path),
298 };
299
300 if key.trim().is_empty() {
301 bail!(
302 "no {package_term} name provided",
303 package_term = package_term(&provider)
304 );
305 }
306
307 let store = store?;
308
309 if let Some(package) = args.package() {
310 Self::run_just_in_time_indexing(store.clone(), key.clone(), package, executor)
311 .await;
312 }
313
314 let (text, ranges) = if let Some((prefix, _)) = key.split_once('*') {
315 let docs = store.load_many_by_prefix(prefix.to_string()).await?;
316
317 let mut text = String::new();
318 let mut ranges = Vec::new();
319
320 for (key, docs) in docs {
321 let prev_len = text.len();
322
323 text.push_str(&docs.0);
324 text.push_str("\n");
325 ranges.push((key, prev_len..text.len()));
326 text.push_str("\n");
327 }
328
329 (text, ranges)
330 } else {
331 let item_docs = store.load(key.clone()).await?;
332 let text = item_docs.to_string();
333 let range = 0..text.len();
334
335 (text, vec![(key, range)])
336 };
337
338 anyhow::Ok((provider, text, ranges))
339 }
340 });
341
342 cx.foreground_executor().spawn(async move {
343 let (provider, text, ranges) = task.await?;
344 Ok(SlashCommandOutput {
345 text,
346 sections: ranges
347 .into_iter()
348 .map(|(key, range)| SlashCommandOutputSection {
349 range,
350 icon: IconName::FileDoc,
351 label: format!("docs ({provider}): {key}",).into(),
352 })
353 .collect(),
354 run_commands_in_text: false,
355 })
356 })
357 }
358}
359
360fn is_item_path_delimiter(char: char) -> bool {
361 !char.is_alphanumeric() && char != '-' && char != '_'
362}
363
364#[derive(Debug, PartialEq, Clone)]
365pub(crate) enum DocsSlashCommandArgs {
366 NoProvider,
367 SearchPackageDocs {
368 provider: ProviderId,
369 package: String,
370 index: bool,
371 },
372 SearchItemDocs {
373 provider: ProviderId,
374 package: String,
375 item_path: String,
376 },
377}
378
379impl DocsSlashCommandArgs {
380 pub fn parse(arguments: &[String]) -> Self {
381 let Some(provider) = arguments
382 .get(0)
383 .cloned()
384 .filter(|arg| !arg.trim().is_empty())
385 else {
386 return Self::NoProvider;
387 };
388 let provider = ProviderId(provider.into());
389 let Some(argument) = arguments.get(1) else {
390 return Self::NoProvider;
391 };
392
393 if let Some((package, rest)) = argument.split_once(is_item_path_delimiter) {
394 if rest.trim().is_empty() {
395 Self::SearchPackageDocs {
396 provider,
397 package: package.to_owned(),
398 index: true,
399 }
400 } else {
401 Self::SearchItemDocs {
402 provider,
403 package: package.to_owned(),
404 item_path: argument.to_owned(),
405 }
406 }
407 } else {
408 Self::SearchPackageDocs {
409 provider,
410 package: argument.to_owned(),
411 index: false,
412 }
413 }
414 }
415
416 pub fn provider(&self) -> Option<ProviderId> {
417 match self {
418 Self::NoProvider => None,
419 Self::SearchPackageDocs { provider, .. } | Self::SearchItemDocs { provider, .. } => {
420 Some(provider.clone())
421 }
422 }
423 }
424
425 pub fn package(&self) -> Option<PackageName> {
426 match self {
427 Self::NoProvider => None,
428 Self::SearchPackageDocs { package, .. } | Self::SearchItemDocs { package, .. } => {
429 Some(package.as_str().into())
430 }
431 }
432 }
433}
434
435/// Returns the term used to refer to a package.
436fn package_term(provider: &ProviderId) -> &'static str {
437 if provider == &DocsDotRsProvider::id() || provider == &LocalRustdocProvider::id() {
438 return "crate";
439 }
440
441 "package"
442}
443
444#[cfg(test)]
445mod tests {
446 use super::*;
447
448 #[test]
449 fn test_parse_docs_slash_command_args() {
450 assert_eq!(
451 DocsSlashCommandArgs::parse(&["".to_string()]),
452 DocsSlashCommandArgs::NoProvider
453 );
454 assert_eq!(
455 DocsSlashCommandArgs::parse(&["rustdoc".to_string()]),
456 DocsSlashCommandArgs::NoProvider
457 );
458
459 assert_eq!(
460 DocsSlashCommandArgs::parse(&["rustdoc".to_string(), "".to_string()]),
461 DocsSlashCommandArgs::SearchPackageDocs {
462 provider: ProviderId("rustdoc".into()),
463 package: "".into(),
464 index: false
465 }
466 );
467 assert_eq!(
468 DocsSlashCommandArgs::parse(&["gleam".to_string(), "".to_string()]),
469 DocsSlashCommandArgs::SearchPackageDocs {
470 provider: ProviderId("gleam".into()),
471 package: "".into(),
472 index: false
473 }
474 );
475
476 assert_eq!(
477 DocsSlashCommandArgs::parse(&["rustdoc".to_string(), "gpui".to_string()]),
478 DocsSlashCommandArgs::SearchPackageDocs {
479 provider: ProviderId("rustdoc".into()),
480 package: "gpui".into(),
481 index: false,
482 }
483 );
484 assert_eq!(
485 DocsSlashCommandArgs::parse(&["gleam".to_string(), "gleam_stdlib".to_string()]),
486 DocsSlashCommandArgs::SearchPackageDocs {
487 provider: ProviderId("gleam".into()),
488 package: "gleam_stdlib".into(),
489 index: false
490 }
491 );
492
493 // Adding an item path delimiter indicates we can start indexing.
494 assert_eq!(
495 DocsSlashCommandArgs::parse(&["rustdoc".to_string(), "gpui:".to_string()]),
496 DocsSlashCommandArgs::SearchPackageDocs {
497 provider: ProviderId("rustdoc".into()),
498 package: "gpui".into(),
499 index: true,
500 }
501 );
502 assert_eq!(
503 DocsSlashCommandArgs::parse(&["gleam".to_string(), "gleam_stdlib/".to_string()]),
504 DocsSlashCommandArgs::SearchPackageDocs {
505 provider: ProviderId("gleam".into()),
506 package: "gleam_stdlib".into(),
507 index: true
508 }
509 );
510
511 assert_eq!(
512 DocsSlashCommandArgs::parse(&[
513 "rustdoc".to_string(),
514 "gpui::foo::bar::Baz".to_string()
515 ]),
516 DocsSlashCommandArgs::SearchItemDocs {
517 provider: ProviderId("rustdoc".into()),
518 package: "gpui".into(),
519 item_path: "gpui::foo::bar::Baz".into()
520 }
521 );
522 assert_eq!(
523 DocsSlashCommandArgs::parse(&[
524 "gleam".to_string(),
525 "gleam_stdlib/gleam/int".to_string()
526 ]),
527 DocsSlashCommandArgs::SearchItemDocs {
528 provider: ProviderId("gleam".into()),
529 package: "gleam_stdlib".into(),
530 item_path: "gleam_stdlib/gleam/int".into()
531 }
532 );
533 }
534}