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