1use std::collections::VecDeque;
2use std::path::{Path, PathBuf};
3use std::sync::Arc;
4
5use anyhow::Context;
6use collections::{HashMap, HashSet};
7use fs::Fs;
8use gpui::{AsyncAppContext, ModelHandle};
9use language::language_settings::language_settings;
10use language::{Buffer, BundledFormatter, Diff};
11use lsp::{LanguageServer, LanguageServerId};
12use node_runtime::NodeRuntime;
13use serde::{Deserialize, Serialize};
14use util::paths::DEFAULT_PRETTIER_DIR;
15
16pub enum Prettier {
17 Real(RealPrettier),
18 #[cfg(any(test, feature = "test-support"))]
19 Test(TestPrettier),
20}
21
22pub struct RealPrettier {
23 worktree_id: Option<usize>,
24 default: bool,
25 prettier_dir: PathBuf,
26 server: Arc<LanguageServer>,
27}
28
29#[cfg(any(test, feature = "test-support"))]
30pub struct TestPrettier {
31 worktree_id: Option<usize>,
32 prettier_dir: PathBuf,
33 default: bool,
34}
35
36#[derive(Debug)]
37pub struct LocateStart {
38 pub worktree_root_path: Arc<Path>,
39 pub starting_path: Arc<Path>,
40}
41
42pub const PRETTIER_SERVER_FILE: &str = "prettier_server.js";
43pub const PRETTIER_SERVER_JS: &str = include_str!("./prettier_server.js");
44const PRETTIER_PACKAGE_NAME: &str = "prettier";
45const TAILWIND_PRETTIER_PLUGIN_PACKAGE_NAME: &str = "prettier-plugin-tailwindcss";
46
47impl Prettier {
48 pub const CONFIG_FILE_NAMES: &'static [&'static str] = &[
49 ".prettierrc",
50 ".prettierrc.json",
51 ".prettierrc.json5",
52 ".prettierrc.yaml",
53 ".prettierrc.yml",
54 ".prettierrc.toml",
55 ".prettierrc.js",
56 ".prettierrc.cjs",
57 "package.json",
58 "prettier.config.js",
59 "prettier.config.cjs",
60 ".editorconfig",
61 ];
62
63 #[cfg(any(test, feature = "test-support"))]
64 pub const FORMAT_SUFFIX: &str = "\nformatted by test prettier";
65
66 pub async fn locate(
67 starting_path: Option<LocateStart>,
68 fs: Arc<dyn Fs>,
69 ) -> anyhow::Result<PathBuf> {
70 let paths_to_check = match starting_path.as_ref() {
71 Some(starting_path) => {
72 let worktree_root = starting_path
73 .worktree_root_path
74 .components()
75 .into_iter()
76 .take_while(|path_component| {
77 path_component.as_os_str().to_string_lossy() != "node_modules"
78 })
79 .collect::<PathBuf>();
80
81 if worktree_root != starting_path.worktree_root_path.as_ref() {
82 vec![worktree_root]
83 } else {
84 let (worktree_root_metadata, start_path_metadata) = if starting_path
85 .starting_path
86 .as_ref()
87 == Path::new("")
88 {
89 let worktree_root_data =
90 fs.metadata(&worktree_root).await.with_context(|| {
91 format!(
92 "FS metadata fetch for worktree root path {worktree_root:?}",
93 )
94 })?;
95 (worktree_root_data.unwrap_or_else(|| {
96 panic!("cannot query prettier for non existing worktree root at {worktree_root_data:?}")
97 }), None)
98 } else {
99 let full_starting_path = worktree_root.join(&starting_path.starting_path);
100 let (worktree_root_data, start_path_data) = futures::try_join!(
101 fs.metadata(&worktree_root),
102 fs.metadata(&full_starting_path),
103 )
104 .with_context(|| {
105 format!("FS metadata fetch for starting path {full_starting_path:?}",)
106 })?;
107 (
108 worktree_root_data.unwrap_or_else(|| {
109 panic!("cannot query prettier for non existing worktree root at {worktree_root_data:?}")
110 }),
111 start_path_data,
112 )
113 };
114
115 match start_path_metadata {
116 Some(start_path_metadata) => {
117 anyhow::ensure!(worktree_root_metadata.is_dir,
118 "For non-empty start path, worktree root {starting_path:?} should be a directory");
119 anyhow::ensure!(
120 !start_path_metadata.is_dir,
121 "For non-empty start path, it should not be a directory {starting_path:?}"
122 );
123 anyhow::ensure!(
124 !start_path_metadata.is_symlink,
125 "For non-empty start path, it should not be a symlink {starting_path:?}"
126 );
127
128 let file_to_format = starting_path.starting_path.as_ref();
129 let mut paths_to_check = VecDeque::from(vec![worktree_root.clone()]);
130 let mut current_path = worktree_root;
131 for path_component in file_to_format.components().into_iter() {
132 current_path = current_path.join(path_component);
133 paths_to_check.push_front(current_path.clone());
134 if path_component.as_os_str().to_string_lossy() == "node_modules" {
135 break;
136 }
137 }
138 paths_to_check.pop_front(); // last one is the file itself or node_modules, skip it
139 Vec::from(paths_to_check)
140 }
141 None => {
142 anyhow::ensure!(
143 !worktree_root_metadata.is_dir,
144 "For empty start path, worktree root should not be a directory {starting_path:?}"
145 );
146 anyhow::ensure!(
147 !worktree_root_metadata.is_symlink,
148 "For empty start path, worktree root should not be a symlink {starting_path:?}"
149 );
150 worktree_root
151 .parent()
152 .map(|path| vec![path.to_path_buf()])
153 .unwrap_or_default()
154 }
155 }
156 }
157 }
158 None => Vec::new(),
159 };
160
161 match find_closest_prettier_dir(paths_to_check, fs.as_ref())
162 .await
163 .with_context(|| format!("finding prettier starting with {starting_path:?}"))?
164 {
165 Some(prettier_dir) => Ok(prettier_dir),
166 None => Ok(DEFAULT_PRETTIER_DIR.to_path_buf()),
167 }
168 }
169
170 #[cfg(any(test, feature = "test-support"))]
171 pub async fn start(
172 worktree_id: Option<usize>,
173 _: LanguageServerId,
174 prettier_dir: PathBuf,
175 _: Arc<dyn NodeRuntime>,
176 _: AsyncAppContext,
177 ) -> anyhow::Result<Self> {
178 Ok(
179 #[cfg(any(test, feature = "test-support"))]
180 Self::Test(TestPrettier {
181 worktree_id,
182 default: prettier_dir == DEFAULT_PRETTIER_DIR.as_path(),
183 prettier_dir,
184 }),
185 )
186 }
187
188 #[cfg(not(any(test, feature = "test-support")))]
189 pub async fn start(
190 worktree_id: Option<usize>,
191 server_id: LanguageServerId,
192 prettier_dir: PathBuf,
193 node: Arc<dyn NodeRuntime>,
194 cx: AsyncAppContext,
195 ) -> anyhow::Result<Self> {
196 use lsp::LanguageServerBinary;
197
198 let backgroud = cx.background();
199 anyhow::ensure!(
200 prettier_dir.is_dir(),
201 "Prettier dir {prettier_dir:?} is not a directory"
202 );
203 let prettier_server = DEFAULT_PRETTIER_DIR.join(PRETTIER_SERVER_FILE);
204 anyhow::ensure!(
205 prettier_server.is_file(),
206 "no prettier server package found at {prettier_server:?}"
207 );
208
209 let node_path = backgroud
210 .spawn(async move { node.binary_path().await })
211 .await?;
212 let server = LanguageServer::new(
213 server_id,
214 LanguageServerBinary {
215 path: node_path,
216 arguments: vec![prettier_server.into(), prettier_dir.as_path().into()],
217 },
218 Path::new("/"),
219 None,
220 cx,
221 )
222 .context("prettier server creation")?;
223 let server = backgroud
224 .spawn(server.initialize(None))
225 .await
226 .context("prettier server initialization")?;
227 Ok(Self::Real(RealPrettier {
228 worktree_id,
229 server,
230 default: prettier_dir == DEFAULT_PRETTIER_DIR.as_path(),
231 prettier_dir,
232 }))
233 }
234
235 pub async fn format(
236 &self,
237 buffer: &ModelHandle<Buffer>,
238 buffer_path: Option<PathBuf>,
239 cx: &AsyncAppContext,
240 ) -> anyhow::Result<Diff> {
241 match self {
242 Self::Real(local) => {
243 let params = buffer.read_with(cx, |buffer, cx| {
244 let buffer_language = buffer.language();
245 let parsers_with_plugins = buffer_language
246 .into_iter()
247 .flat_map(|language| {
248 language
249 .lsp_adapters()
250 .iter()
251 .flat_map(|adapter| adapter.enabled_formatters())
252 .filter_map(|formatter| match formatter {
253 BundledFormatter::Prettier {
254 parser_name,
255 plugin_names,
256 } => Some((parser_name, plugin_names)),
257 })
258 })
259 .fold(
260 HashMap::default(),
261 |mut parsers_with_plugins, (parser_name, plugins)| {
262 match parser_name {
263 Some(parser_name) => parsers_with_plugins
264 .entry(parser_name)
265 .or_insert_with(HashSet::default)
266 .extend(plugins),
267 None => parsers_with_plugins.values_mut().for_each(|existing_plugins| {
268 existing_plugins.extend(plugins.iter());
269 }),
270 }
271 parsers_with_plugins
272 },
273 );
274
275 let selected_parser_with_plugins = parsers_with_plugins.iter().max_by_key(|(_, plugins)| plugins.len());
276 if parsers_with_plugins.len() > 1 {
277 log::warn!("Found multiple parsers with plugins {parsers_with_plugins:?}, will select only one: {selected_parser_with_plugins:?}");
278 }
279
280 let prettier_node_modules = self.prettier_dir().join("node_modules");
281 anyhow::ensure!(prettier_node_modules.is_dir(), "Prettier node_modules dir does not exist: {prettier_node_modules:?}");
282 let plugin_name_into_path = |plugin_name: &str| {
283 let prettier_plugin_dir = prettier_node_modules.join(plugin_name);
284 for possible_plugin_path in [
285 prettier_plugin_dir.join("dist").join("index.mjs"),
286 prettier_plugin_dir.join("index.mjs"),
287 prettier_plugin_dir.join("plugin.js"),
288 prettier_plugin_dir.join("index.js"),
289 prettier_plugin_dir,
290 ] {
291 if possible_plugin_path.is_file() {
292 return Some(possible_plugin_path);
293 }
294 }
295 None
296 };
297 let (parser, located_plugins) = match selected_parser_with_plugins {
298 Some((parser, plugins)) => {
299 // Tailwind plugin requires being added last
300 // https://github.com/tailwindlabs/prettier-plugin-tailwindcss#compatibility-with-other-prettier-plugins
301 let mut add_tailwind_back = false;
302
303 let mut plugins = plugins.into_iter().filter(|&&plugin_name| {
304 if plugin_name == TAILWIND_PRETTIER_PLUGIN_PACKAGE_NAME {
305 add_tailwind_back = true;
306 false
307 } else {
308 true
309 }
310 }).map(|plugin_name| (plugin_name, plugin_name_into_path(plugin_name))).collect::<Vec<_>>();
311 if add_tailwind_back {
312 plugins.push((&TAILWIND_PRETTIER_PLUGIN_PACKAGE_NAME, plugin_name_into_path(TAILWIND_PRETTIER_PLUGIN_PACKAGE_NAME)));
313 }
314 (Some(parser.to_string()), plugins)
315 },
316 None => (None, Vec::new()),
317 };
318
319 let prettier_options = if self.is_default() {
320 let language_settings = language_settings(buffer_language, buffer.file(), cx);
321 let mut options = language_settings.prettier.clone();
322 if !options.contains_key("tabWidth") {
323 options.insert(
324 "tabWidth".to_string(),
325 serde_json::Value::Number(serde_json::Number::from(
326 language_settings.tab_size.get(),
327 )),
328 );
329 }
330 if !options.contains_key("printWidth") {
331 options.insert(
332 "printWidth".to_string(),
333 serde_json::Value::Number(serde_json::Number::from(
334 language_settings.preferred_line_length,
335 )),
336 );
337 }
338 Some(options)
339 } else {
340 None
341 };
342
343 let plugins = located_plugins.into_iter().filter_map(|(plugin_name, located_plugin_path)| {
344 match located_plugin_path {
345 Some(path) => Some(path),
346 None => {
347 log::error!("Have not found plugin path for {plugin_name:?} inside {prettier_node_modules:?}");
348 None},
349 }
350 }).collect();
351 log::debug!("Formatting file {:?} with prettier, plugins :{plugins:?}, options: {prettier_options:?}", buffer.file().map(|f| f.full_path(cx)));
352
353 anyhow::Ok(FormatParams {
354 text: buffer.text(),
355 options: FormatOptions {
356 parser,
357 plugins,
358 path: buffer_path,
359 prettier_options,
360 },
361 })
362 }).context("prettier params calculation")?;
363 let response = local
364 .server
365 .request::<Format>(params)
366 .await
367 .context("prettier format request")?;
368 let diff_task = buffer.read_with(cx, |buffer, cx| buffer.diff(response.text, cx));
369 Ok(diff_task.await)
370 }
371 #[cfg(any(test, feature = "test-support"))]
372 Self::Test(_) => Ok(buffer
373 .read_with(cx, |buffer, cx| {
374 let formatted_text = buffer.text() + Self::FORMAT_SUFFIX;
375 buffer.diff(formatted_text, cx)
376 })
377 .await),
378 }
379 }
380
381 pub async fn clear_cache(&self) -> anyhow::Result<()> {
382 match self {
383 Self::Real(local) => local
384 .server
385 .request::<ClearCache>(())
386 .await
387 .context("prettier clear cache"),
388 #[cfg(any(test, feature = "test-support"))]
389 Self::Test(_) => Ok(()),
390 }
391 }
392
393 pub fn server(&self) -> Option<&Arc<LanguageServer>> {
394 match self {
395 Self::Real(local) => Some(&local.server),
396 #[cfg(any(test, feature = "test-support"))]
397 Self::Test(_) => None,
398 }
399 }
400
401 pub fn is_default(&self) -> bool {
402 match self {
403 Self::Real(local) => local.default,
404 #[cfg(any(test, feature = "test-support"))]
405 Self::Test(test_prettier) => test_prettier.default,
406 }
407 }
408
409 pub fn prettier_dir(&self) -> &Path {
410 match self {
411 Self::Real(local) => &local.prettier_dir,
412 #[cfg(any(test, feature = "test-support"))]
413 Self::Test(test_prettier) => &test_prettier.prettier_dir,
414 }
415 }
416
417 pub fn worktree_id(&self) -> Option<usize> {
418 match self {
419 Self::Real(local) => local.worktree_id,
420 #[cfg(any(test, feature = "test-support"))]
421 Self::Test(test_prettier) => test_prettier.worktree_id,
422 }
423 }
424}
425
426async fn find_closest_prettier_dir(
427 paths_to_check: Vec<PathBuf>,
428 fs: &dyn Fs,
429) -> anyhow::Result<Option<PathBuf>> {
430 for path in paths_to_check {
431 let possible_package_json = path.join("package.json");
432 if let Some(package_json_metadata) = fs
433 .metadata(&possible_package_json)
434 .await
435 .with_context(|| format!("Fetching metadata for {possible_package_json:?}"))?
436 {
437 if !package_json_metadata.is_dir && !package_json_metadata.is_symlink {
438 let package_json_contents = fs
439 .load(&possible_package_json)
440 .await
441 .with_context(|| format!("reading {possible_package_json:?} file contents"))?;
442 if let Ok(json_contents) = serde_json::from_str::<HashMap<String, serde_json::Value>>(
443 &package_json_contents,
444 ) {
445 if let Some(serde_json::Value::Object(o)) = json_contents.get("dependencies") {
446 if o.contains_key(PRETTIER_PACKAGE_NAME) {
447 return Ok(Some(path));
448 }
449 }
450 if let Some(serde_json::Value::Object(o)) = json_contents.get("devDependencies")
451 {
452 if o.contains_key(PRETTIER_PACKAGE_NAME) {
453 return Ok(Some(path));
454 }
455 }
456 }
457 }
458 }
459
460 let possible_node_modules_location = path.join("node_modules").join(PRETTIER_PACKAGE_NAME);
461 if let Some(node_modules_location_metadata) = fs
462 .metadata(&possible_node_modules_location)
463 .await
464 .with_context(|| format!("fetching metadata for {possible_node_modules_location:?}"))?
465 {
466 if node_modules_location_metadata.is_dir {
467 return Ok(Some(path));
468 }
469 }
470 }
471 Ok(None)
472}
473
474enum Format {}
475
476#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
477#[serde(rename_all = "camelCase")]
478struct FormatParams {
479 text: String,
480 options: FormatOptions,
481}
482
483#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize)]
484#[serde(rename_all = "camelCase")]
485struct FormatOptions {
486 plugins: Vec<PathBuf>,
487 parser: Option<String>,
488 #[serde(rename = "filepath")]
489 path: Option<PathBuf>,
490 prettier_options: Option<HashMap<String, serde_json::Value>>,
491}
492
493#[derive(Clone, Debug, Eq, PartialEq, Serialize, Deserialize)]
494#[serde(rename_all = "camelCase")]
495struct FormatResult {
496 text: String,
497}
498
499impl lsp::request::Request for Format {
500 type Params = FormatParams;
501 type Result = FormatResult;
502 const METHOD: &'static str = "prettier/format";
503}
504
505enum ClearCache {}
506
507impl lsp::request::Request for ClearCache {
508 type Params = ();
509 type Result = ();
510 const METHOD: &'static str = "prettier/clear_cache";
511}