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