extension_suggest.rs

  1use std::collections::HashMap;
  2use std::path::Path;
  3use std::sync::{Arc, OnceLock};
  4
  5use db::kvp::KEY_VALUE_STORE;
  6use editor::Editor;
  7use extension::ExtensionStore;
  8use gpui::{Model, VisualContext};
  9use language::Buffer;
 10use ui::{SharedString, ViewContext};
 11use workspace::{
 12    notifications::{simple_message_notification, NotificationId},
 13    Workspace,
 14};
 15
 16const SUGGESTIONS_BY_EXTENSION_ID: &[(&str, &[&str])] = &[
 17    ("astro", &["astro"]),
 18    ("beancount", &["beancount"]),
 19    ("clojure", &["bb", "clj", "cljc", "cljs", "edn"]),
 20    ("csharp", &["cs"]),
 21    ("dart", &["dart"]),
 22    ("dockerfile", &["Dockerfile"]),
 23    ("elisp", &["el"]),
 24    ("elixir", &["ex", "exs", "heex"]),
 25    ("elm", &["elm"]),
 26    ("erlang", &["erl", "hrl"]),
 27    ("fish", &["fish"]),
 28    (
 29        "git-firefly",
 30        &[
 31            ".gitconfig",
 32            ".gitignore",
 33            "COMMIT_EDITMSG",
 34            "EDIT_DESCRIPTION",
 35            "MERGE_MSG",
 36            "NOTES_EDITMSG",
 37            "TAG_EDITMSG",
 38            "git-rebase-todo",
 39        ],
 40    ),
 41    ("gleam", &["gleam"]),
 42    ("glsl", &["vert", "frag"]),
 43    ("graphql", &["gql", "graphql"]),
 44    ("haskell", &["hs"]),
 45    ("html", &["htm", "html", "shtml"]),
 46    ("java", &["java"]),
 47    ("kotlin", &["kt"]),
 48    ("latex", &["tex"]),
 49    ("log", &["log"]),
 50    ("lua", &["lua"]),
 51    ("make", &["Makefile"]),
 52    ("nix", &["nix"]),
 53    ("nu", &["nu"]),
 54    ("ocaml", &["ml", "mli"]),
 55    ("php", &["php"]),
 56    ("prisma", &["prisma"]),
 57    ("purescript", &["purs"]),
 58    ("r", &["r", "R"]),
 59    ("racket", &["rkt"]),
 60    ("rescript", &["res", "resi"]),
 61    ("ruby", &["rb", "erb"]),
 62    ("scheme", &["scm"]),
 63    ("scss", &["scss"]),
 64    ("sql", &["sql"]),
 65    ("svelte", &["svelte"]),
 66    ("swift", &["swift"]),
 67    ("templ", &["templ"]),
 68    ("terraform", &["tf", "tfvars", "hcl"]),
 69    ("toml", &["Cargo.lock", "toml"]),
 70    ("vue", &["vue"]),
 71    ("wgsl", &["wgsl"]),
 72    ("zig", &["zig"]),
 73];
 74
 75fn suggested_extensions() -> &'static HashMap<&'static str, Arc<str>> {
 76    static SUGGESTIONS_BY_PATH_SUFFIX: OnceLock<HashMap<&str, Arc<str>>> = OnceLock::new();
 77    SUGGESTIONS_BY_PATH_SUFFIX.get_or_init(|| {
 78        SUGGESTIONS_BY_EXTENSION_ID
 79            .into_iter()
 80            .flat_map(|(name, path_suffixes)| {
 81                let name = Arc::<str>::from(*name);
 82                path_suffixes
 83                    .into_iter()
 84                    .map(move |suffix| (*suffix, name.clone()))
 85            })
 86            .collect()
 87    })
 88}
 89
 90#[derive(Debug, PartialEq, Eq, Clone)]
 91struct SuggestedExtension {
 92    pub extension_id: Arc<str>,
 93    pub file_name_or_extension: Arc<str>,
 94}
 95
 96/// Returns the suggested extension for the given [`Path`].
 97fn suggested_extension(path: impl AsRef<Path>) -> Option<SuggestedExtension> {
 98    let path = path.as_ref();
 99
100    let file_extension: Option<Arc<str>> = path
101        .extension()
102        .and_then(|extension| Some(extension.to_str()?.into()));
103    let file_name: Option<Arc<str>> = path
104        .file_name()
105        .and_then(|file_name| Some(file_name.to_str()?.into()));
106
107    let (file_name_or_extension, extension_id) = None
108        // We suggest against file names first, as these suggestions will be more
109        // specific than ones based on the file extension.
110        .or_else(|| {
111            file_name.clone().zip(
112                file_name
113                    .as_deref()
114                    .and_then(|file_name| suggested_extensions().get(file_name)),
115            )
116        })
117        .or_else(|| {
118            file_extension.clone().zip(
119                file_extension
120                    .as_deref()
121                    .and_then(|file_extension| suggested_extensions().get(file_extension)),
122            )
123        })?;
124
125    Some(SuggestedExtension {
126        extension_id: extension_id.clone(),
127        file_name_or_extension,
128    })
129}
130
131fn language_extension_key(extension_id: &str) -> String {
132    format!("{}_extension_suggest", extension_id)
133}
134
135pub(crate) fn suggest(buffer: Model<Buffer>, cx: &mut ViewContext<Workspace>) {
136    let Some(file) = buffer.read(cx).file().cloned() else {
137        return;
138    };
139
140    let Some(SuggestedExtension {
141        extension_id,
142        file_name_or_extension,
143    }) = suggested_extension(file.path())
144    else {
145        return;
146    };
147
148    let key = language_extension_key(&extension_id);
149    let Ok(None) = KEY_VALUE_STORE.read_kvp(&key) else {
150        return;
151    };
152
153    cx.on_next_frame(move |workspace, cx| {
154        let Some(editor) = workspace.active_item_as::<Editor>(cx) else {
155            return;
156        };
157
158        if editor.read(cx).buffer().read(cx).as_singleton().as_ref() != Some(&buffer) {
159            return;
160        }
161
162        struct ExtensionSuggestionNotification;
163
164        let notification_id = NotificationId::identified::<ExtensionSuggestionNotification>(
165            SharedString::from(extension_id.clone()),
166        );
167
168        workspace.show_notification(notification_id, cx, |cx| {
169            cx.new_view(move |_cx| {
170                simple_message_notification::MessageNotification::new(format!(
171                    "Do you want to install the recommended '{}' extension for '{}' files?",
172                    extension_id, file_name_or_extension
173                ))
174                .with_click_message("Yes")
175                .on_click({
176                    let extension_id = extension_id.clone();
177                    move |cx| {
178                        let extension_id = extension_id.clone();
179                        let extension_store = ExtensionStore::global(cx);
180                        extension_store.update(cx, move |store, cx| {
181                            store.install_latest_extension(extension_id, cx);
182                        });
183                    }
184                })
185                .with_secondary_click_message("No")
186                .on_secondary_click(move |cx| {
187                    let key = language_extension_key(&extension_id);
188                    db::write_and_log(cx, move || {
189                        KEY_VALUE_STORE.write_kvp(key, "dismissed".to_string())
190                    });
191                })
192            })
193        });
194    })
195}
196
197#[cfg(test)]
198mod tests {
199    use super::*;
200
201    #[test]
202    pub fn test_suggested_extension() {
203        assert_eq!(
204            suggested_extension("Cargo.toml"),
205            Some(SuggestedExtension {
206                extension_id: "toml".into(),
207                file_name_or_extension: "toml".into()
208            })
209        );
210        assert_eq!(
211            suggested_extension("Cargo.lock"),
212            Some(SuggestedExtension {
213                extension_id: "toml".into(),
214                file_name_or_extension: "Cargo.lock".into()
215            })
216        );
217        assert_eq!(
218            suggested_extension("Dockerfile"),
219            Some(SuggestedExtension {
220                extension_id: "dockerfile".into(),
221                file_name_or_extension: "Dockerfile".into()
222            })
223        );
224        assert_eq!(
225            suggested_extension("a/b/c/d/.gitignore"),
226            Some(SuggestedExtension {
227                extension_id: "git-firefly".into(),
228                file_name_or_extension: ".gitignore".into()
229            })
230        );
231        assert_eq!(
232            suggested_extension("a/b/c/d/test.gleam"),
233            Some(SuggestedExtension {
234                extension_id: "gleam".into(),
235                file_name_or_extension: "gleam".into()
236            })
237        );
238    }
239}