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