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 query: 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(&query);
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(
179 provider: ProviderId,
180 items: Vec<String>,
181 ) -> Vec<ArgumentCompletion> {
182 items
183 .into_iter()
184 .map(|item| ArgumentCompletion {
185 label: item.clone().into(),
186 new_text: format!("{provider} {item}"),
187 run_command: true,
188 })
189 .collect()
190 }
191
192 match args {
193 DocsSlashCommandArgs::NoProvider => {
194 let providers = indexed_docs_registry.list_providers();
195 if providers.is_empty() {
196 return Ok(vec![ArgumentCompletion {
197 label: "No available docs providers.".into(),
198 new_text: String::new(),
199 run_command: false,
200 }]);
201 }
202
203 Ok(providers
204 .into_iter()
205 .map(|provider| ArgumentCompletion {
206 label: provider.to_string().into(),
207 new_text: provider.to_string(),
208 run_command: 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(provider.clone(), 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!("{provider} {package_name}"),
239 run_command: true,
240 })
241 .collect::<Vec<_>>();
242 items.extend(workspace_crate_completions);
243
244 if items.is_empty() {
245 return Ok(vec![ArgumentCompletion {
246 label: format!(
247 "Enter a {package_term} name.",
248 package_term = package_term(&provider)
249 )
250 .into(),
251 new_text: provider.to_string(),
252 run_command: false,
253 }]);
254 }
255
256 Ok(items)
257 }
258 DocsSlashCommandArgs::SearchItemDocs {
259 provider,
260 item_path,
261 ..
262 } => {
263 let store = store?;
264 let items = store.search(item_path).await;
265 Ok(build_completions(provider, items))
266 }
267 }
268 })
269 }
270
271 fn run(
272 self: Arc<Self>,
273 argument: Option<&str>,
274 _workspace: WeakView<Workspace>,
275 _delegate: Option<Arc<dyn LspAdapterDelegate>>,
276 cx: &mut WindowContext,
277 ) -> Task<Result<SlashCommandOutput>> {
278 let Some(argument) = argument else {
279 return Task::ready(Err(anyhow!("missing argument")));
280 };
281
282 let args = DocsSlashCommandArgs::parse(argument);
283 let executor = cx.background_executor().clone();
284 let task = cx.background_executor().spawn({
285 let store = args
286 .provider()
287 .ok_or_else(|| anyhow!("no docs provider specified"))
288 .and_then(|provider| IndexedDocsStore::try_global(provider, cx));
289 async move {
290 let (provider, key) = match args.clone() {
291 DocsSlashCommandArgs::NoProvider => bail!("no docs provider specified"),
292 DocsSlashCommandArgs::SearchPackageDocs {
293 provider, package, ..
294 } => (provider, package),
295 DocsSlashCommandArgs::SearchItemDocs {
296 provider,
297 item_path,
298 ..
299 } => (provider, item_path),
300 };
301
302 if key.trim().is_empty() {
303 bail!(
304 "no {package_term} name provided",
305 package_term = package_term(&provider)
306 );
307 }
308
309 let store = store?;
310
311 if let Some(package) = args.package() {
312 Self::run_just_in_time_indexing(store.clone(), key.clone(), package, executor)
313 .await;
314 }
315
316 let (text, ranges) = if let Some((prefix, _)) = key.split_once('*') {
317 let docs = store.load_many_by_prefix(prefix.to_string()).await?;
318
319 let mut text = String::new();
320 let mut ranges = Vec::new();
321
322 for (key, docs) in docs {
323 let prev_len = text.len();
324
325 text.push_str(&docs.0);
326 text.push_str("\n");
327 ranges.push((key, prev_len..text.len()));
328 text.push_str("\n");
329 }
330
331 (text, ranges)
332 } else {
333 let item_docs = store.load(key.clone()).await?;
334 let text = item_docs.to_string();
335 let range = 0..text.len();
336
337 (text, vec![(key, range)])
338 };
339
340 anyhow::Ok((provider, text, ranges))
341 }
342 });
343
344 cx.foreground_executor().spawn(async move {
345 let (provider, text, ranges) = task.await?;
346 Ok(SlashCommandOutput {
347 text,
348 sections: ranges
349 .into_iter()
350 .map(|(key, range)| SlashCommandOutputSection {
351 range,
352 icon: IconName::FileDoc,
353 label: format!("docs ({provider}): {key}",).into(),
354 })
355 .collect(),
356 run_commands_in_text: false,
357 })
358 })
359 }
360}
361
362fn is_item_path_delimiter(char: char) -> bool {
363 !char.is_alphanumeric() && char != '-' && char != '_'
364}
365
366#[derive(Debug, PartialEq, Clone)]
367pub(crate) enum DocsSlashCommandArgs {
368 NoProvider,
369 SearchPackageDocs {
370 provider: ProviderId,
371 package: String,
372 index: bool,
373 },
374 SearchItemDocs {
375 provider: ProviderId,
376 package: String,
377 item_path: String,
378 },
379}
380
381impl DocsSlashCommandArgs {
382 pub fn parse(argument: &str) -> Self {
383 let Some((provider, argument)) = argument.split_once(' ') else {
384 return Self::NoProvider;
385 };
386
387 let provider = ProviderId(provider.into());
388
389 if let Some((package, rest)) = argument.split_once(is_item_path_delimiter) {
390 if rest.trim().is_empty() {
391 Self::SearchPackageDocs {
392 provider,
393 package: package.to_owned(),
394 index: true,
395 }
396 } else {
397 Self::SearchItemDocs {
398 provider,
399 package: package.to_owned(),
400 item_path: argument.to_owned(),
401 }
402 }
403 } else {
404 Self::SearchPackageDocs {
405 provider,
406 package: argument.to_owned(),
407 index: false,
408 }
409 }
410 }
411
412 pub fn provider(&self) -> Option<ProviderId> {
413 match self {
414 Self::NoProvider => None,
415 Self::SearchPackageDocs { provider, .. } | Self::SearchItemDocs { provider, .. } => {
416 Some(provider.clone())
417 }
418 }
419 }
420
421 pub fn package(&self) -> Option<PackageName> {
422 match self {
423 Self::NoProvider => None,
424 Self::SearchPackageDocs { package, .. } | Self::SearchItemDocs { package, .. } => {
425 Some(package.as_str().into())
426 }
427 }
428 }
429}
430
431/// Returns the term used to refer to a package.
432fn package_term(provider: &ProviderId) -> &'static str {
433 if provider == &DocsDotRsProvider::id() || provider == &LocalRustdocProvider::id() {
434 return "crate";
435 }
436
437 "package"
438}
439
440#[cfg(test)]
441mod tests {
442 use super::*;
443
444 #[test]
445 fn test_parse_docs_slash_command_args() {
446 assert_eq!(
447 DocsSlashCommandArgs::parse(""),
448 DocsSlashCommandArgs::NoProvider
449 );
450 assert_eq!(
451 DocsSlashCommandArgs::parse("rustdoc"),
452 DocsSlashCommandArgs::NoProvider
453 );
454
455 assert_eq!(
456 DocsSlashCommandArgs::parse("rustdoc "),
457 DocsSlashCommandArgs::SearchPackageDocs {
458 provider: ProviderId("rustdoc".into()),
459 package: "".into(),
460 index: false
461 }
462 );
463 assert_eq!(
464 DocsSlashCommandArgs::parse("gleam "),
465 DocsSlashCommandArgs::SearchPackageDocs {
466 provider: ProviderId("gleam".into()),
467 package: "".into(),
468 index: false
469 }
470 );
471
472 assert_eq!(
473 DocsSlashCommandArgs::parse("rustdoc gpui"),
474 DocsSlashCommandArgs::SearchPackageDocs {
475 provider: ProviderId("rustdoc".into()),
476 package: "gpui".into(),
477 index: false,
478 }
479 );
480 assert_eq!(
481 DocsSlashCommandArgs::parse("gleam gleam_stdlib"),
482 DocsSlashCommandArgs::SearchPackageDocs {
483 provider: ProviderId("gleam".into()),
484 package: "gleam_stdlib".into(),
485 index: false
486 }
487 );
488
489 // Adding an item path delimiter indicates we can start indexing.
490 assert_eq!(
491 DocsSlashCommandArgs::parse("rustdoc gpui:"),
492 DocsSlashCommandArgs::SearchPackageDocs {
493 provider: ProviderId("rustdoc".into()),
494 package: "gpui".into(),
495 index: true,
496 }
497 );
498 assert_eq!(
499 DocsSlashCommandArgs::parse("gleam gleam_stdlib/"),
500 DocsSlashCommandArgs::SearchPackageDocs {
501 provider: ProviderId("gleam".into()),
502 package: "gleam_stdlib".into(),
503 index: true
504 }
505 );
506
507 assert_eq!(
508 DocsSlashCommandArgs::parse("rustdoc gpui::foo::bar::Baz"),
509 DocsSlashCommandArgs::SearchItemDocs {
510 provider: ProviderId("rustdoc".into()),
511 package: "gpui".into(),
512 item_path: "gpui::foo::bar::Baz".into()
513 }
514 );
515 assert_eq!(
516 DocsSlashCommandArgs::parse("gleam gleam_stdlib/gleam/int"),
517 DocsSlashCommandArgs::SearchItemDocs {
518 provider: ProviderId("gleam".into()),
519 package: "gleam_stdlib".into(),
520 item_path: "gleam_stdlib/gleam/int".into()
521 }
522 );
523 }
524}