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