dprint 0.60.1

Binary for dprint code formatter—a pluggable and configurable code formatting platform.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
use anyhow::Result;
use anyhow::bail;
use crossterm::event::Event;
use crossterm::event::KeyCode;
use crossterm::event::KeyModifiers;
use deno_terminal::colors;

use crate::utils::terminal::get_terminal_size;
use crate::utils::terminal::read_terminal_key_press;

use super::Logger;
use super::LoggerRefreshItemKind;
use super::LoggerTextItem;

/// An item in a multi-select prompt.
pub struct MultiSelectItem {
  pub text: String,
  /// Secondary text shown dimmed after the item's text (ex. the file
  /// extensions a plugin formats). Empty when there's nothing to show.
  pub detail: Vec<MultiSelectDetailPart>,
  /// Whether the item starts out selected.
  pub is_selected: bool,
  /// Whether the user can toggle the item. A non-selectable item is shown for
  /// context (ex. a plugin that's already in the config file) and is never
  /// part of the result.
  pub is_selectable: bool,
}

/// A piece of the detail shown after a multi-select item's text.
pub struct MultiSelectDetailPart {
  pub text: String,
  /// Whether the part stands out from the rest of the detail (ex. a file
  /// extension that was found in the current directory).
  pub is_highlighted: bool,
}

impl MultiSelectDetailPart {
  pub fn new(text: impl Into<String>) -> Self {
    MultiSelectDetailPart {
      text: text.into(),
      is_highlighted: false,
    }
  }
}

impl MultiSelectItem {
  pub fn new(text: String, is_selected: bool) -> Self {
    MultiSelectItem {
      text,
      detail: Vec::new(),
      is_selected,
      is_selectable: true,
    }
  }

  /// An item shown as selected that the user can't toggle.
  pub fn non_selectable(text: String) -> Self {
    MultiSelectItem {
      text,
      detail: Vec::new(),
      is_selected: true,
      is_selectable: false,
    }
  }

  pub fn with_detail(mut self, detail: Vec<MultiSelectDetailPart>) -> Self {
    self.detail = detail;
    self
  }

  /// The item's text followed by its detail.
  pub fn full_text(&self) -> String {
    let mut text = self.text.clone();
    if !self.detail.is_empty() {
      text.push(' ');
      for part in &self.detail {
        text.push_str(&part.text);
      }
    }
    text
  }

  /// The item as it's shown in the terminal: its detail is dimmed apart from
  /// the highlighted parts, and so is the text of an item that can't be
  /// toggled so it's clear it's only there for context.
  fn render(&self) -> String {
    let mut text = if self.is_selectable {
      self.text.clone()
    } else {
      colors::gray(&self.text).to_string()
    };
    if !self.detail.is_empty() {
      text.push(' ');
      for part in &self.detail {
        if part.is_highlighted {
          text.push_str(&colors::cyan(&part.text).to_string());
        } else {
          text.push_str(&colors::gray(&part.text).to_string());
        }
      }
    }
    text
  }
}

struct MultiSelectData<'a> {
  prompt: &'a str,
  item_hanging_indent: u16,
  items: Vec<MultiSelectItem>,
  /// Text typed by the user to narrow down the visible items.
  filter: String,
  /// Index into the currently visible (filtered) items.
  active_index: usize,
  /// First visible (filtered) item, used to scroll long lists.
  scroll_offset: usize,
}

/// Shows a multi-select prompt, returning the indexes of the selected items.
/// Non-selectable items are shown but never returned.
pub fn show_multi_select(logger: &Logger, context_name: &str, prompt: &str, item_hanging_indent: u16, items: Vec<MultiSelectItem>) -> Result<Vec<usize>> {
  let mut data = MultiSelectData {
    prompt,
    items,
    item_hanging_indent,
    filter: String::new(),
    active_index: 0,
    scroll_offset: 0,
  };

  loop {
    let visible = visible_indexes(&data);
    // keep the active index and scrolling within the visible items
    if data.active_index >= visible.len() {
      data.active_index = visible.len().saturating_sub(1);
    }
    let max_visible_rows = max_visible_rows(&data);
    update_scroll_offset(&mut data, visible.len(), max_visible_rows);

    let text_items = render_multi_select(&data, &visible, max_visible_rows);
    logger.set_refresh_item(LoggerRefreshItemKind::Selection, text_items);

    if let Event::Key(key_event) = read_terminal_key_press()? {
      // ctrl+c cancels
      if key_event.modifiers.contains(KeyModifiers::CONTROL) && matches!(key_event.code, KeyCode::Char('c')) {
        logger.remove_refresh_item(LoggerRefreshItemKind::Selection);
        bail!("Selection cancelled.");
      }
      match &key_event.code {
        KeyCode::Up => {
          if !visible.is_empty() {
            data.active_index = (data.active_index + visible.len() - 1) % visible.len();
          }
        }
        KeyCode::Down => {
          if !visible.is_empty() {
            data.active_index = (data.active_index + 1) % visible.len();
          }
        }
        KeyCode::Char(' ') => {
          // toggle the active item's selection
          if let Some(&item_index) = visible.get(data.active_index) {
            let item = &mut data.items[item_index];
            if item.is_selectable {
              item.is_selected = !item.is_selected;
            }
          }
        }
        KeyCode::Backspace => {
          if data.filter.pop().is_some() {
            data.active_index = 0;
            data.scroll_offset = 0;
          }
        }
        KeyCode::Char(c) => {
          // any other printable character narrows down the list
          if !key_event.modifiers.intersects(KeyModifiers::CONTROL | KeyModifiers::ALT) {
            data.filter.push(*c);
            data.active_index = 0;
            data.scroll_offset = 0;
          }
        }
        KeyCode::Enter => {
          break;
        }
        KeyCode::Esc => {
          logger.remove_refresh_item(LoggerRefreshItemKind::Selection);
          bail!("Selection cancelled.");
        }
        _ => {}
      }
    } else {
      // cause a refresh anyway
    }
  }
  logger.remove_refresh_item(LoggerRefreshItemKind::Selection);

  logger.log_text_items(&render_complete(&data), context_name);

  // return the selected indexes
  let mut result = Vec::new();
  for (i, item) in data.items.iter().enumerate() {
    if item.is_selected && item.is_selectable {
      result.push(i);
    }
  }
  Ok(result)
}

/// The indexes into `data.items` that match the current filter, in order.
fn visible_indexes(data: &MultiSelectData) -> Vec<usize> {
  if data.filter.is_empty() {
    return (0..data.items.len()).collect();
  }
  let filter = data.filter.to_lowercase();
  data
    .items
    .iter()
    .enumerate()
    .filter(|(_, item)| item.full_text().to_lowercase().contains(&filter))
    .map(|(i, _)| i)
    .collect()
}

/// The maximum number of items to show at once, based on the terminal height.
/// When the terminal size is unknown (ex. not a tty) everything is shown.
fn max_visible_rows(data: &MultiSelectData) -> usize {
  match get_terminal_size() {
    Some(size) => {
      // reserve rows for: the prompt, the filter line, both scroll indicators,
      // and a little breathing room so the list doesn't fill the entire screen
      let reserved = 1 + usize::from(!data.filter.is_empty()) + 2 + 1;
      (size.rows as usize).saturating_sub(reserved).max(1)
    }
    None => data.items.len().max(1),
  }
}

/// Adjusts the scroll offset so the active item stays within the visible window.
fn update_scroll_offset(data: &mut MultiSelectData, visible_len: usize, max_visible_rows: usize) {
  if data.active_index < data.scroll_offset {
    data.scroll_offset = data.active_index;
  } else if data.active_index >= data.scroll_offset + max_visible_rows {
    data.scroll_offset = data.active_index + 1 - max_visible_rows;
  }
  let max_scroll = visible_len.saturating_sub(max_visible_rows);
  if data.scroll_offset > max_scroll {
    data.scroll_offset = max_scroll;
  }
}

fn render_multi_select(data: &MultiSelectData, visible: &[usize], max_visible_rows: usize) -> Vec<LoggerTextItem> {
  let mut result = vec![LoggerTextItem::Text(data.prompt.to_string())];

  if !data.filter.is_empty() {
    result.push(LoggerTextItem::Text(format!("  filter: {}", data.filter)));
  }

  if visible.is_empty() {
    result.push(LoggerTextItem::Text("  (no matching plugins)".to_string()));
    return result;
  }

  let end = (data.scroll_offset + max_visible_rows).min(visible.len());
  if data.scroll_offset > 0 {
    result.push(LoggerTextItem::Text(format!("  ...{} more above", data.scroll_offset)));
  }

  for (visible_pos, &item_index) in visible.iter().enumerate().take(end).skip(data.scroll_offset) {
    let item = &data.items[item_index];
    let mut text = String::new();
    text.push_str(if visible_pos == data.active_index { ">" } else { " " });
    text.push_str(" [");
    text.push_str(if item.is_selected { "x" } else { " " });
    text.push_str("] ");
    text.push_str(&item.render());

    result.push(LoggerTextItem::HangingText {
      text,
      indent: 7 + data.item_hanging_indent,
    });
  }

  if end < visible.len() {
    result.push(LoggerTextItem::Text(format!("  ...{} more below", visible.len() - end)));
  }

  result
}

/// The prompt's final state, logged once it's done: only what the user chose,
/// since the non-selectable items were shown for context.
fn render_complete(data: &MultiSelectData) -> Vec<LoggerTextItem> {
  let mut result = Vec::new();
  let is_chosen = |item: &MultiSelectItem| item.is_selected && item.is_selectable;
  if data.items.iter().any(is_chosen) {
    result.push(LoggerTextItem::Text(data.prompt.to_string()));
    for item in data.items.iter().filter(|item| is_chosen(item)) {
      result.push(LoggerTextItem::HangingText {
        text: format!(" * {}", item.render()),
        indent: 3 + data.item_hanging_indent,
      });
    }
  }
  result
}

#[cfg(test)]
mod test {
  use super::*;
  use pretty_assertions::assert_eq;

  fn build_data(items: &[(bool, String)]) -> MultiSelectData<'static> {
    build_data_with_items(items.iter().map(|(selected, text)| MultiSelectItem::new(text.clone(), *selected)).collect())
  }

  fn build_data_with_items(items: Vec<MultiSelectItem>) -> MultiSelectData<'static> {
    MultiSelectData {
      prompt: "Select:",
      item_hanging_indent: 0,
      items,
      filter: String::new(),
      active_index: 0,
      scroll_offset: 0,
    }
  }

  fn rendered_lines(items: &[LoggerTextItem]) -> Vec<String> {
    items
      .iter()
      .map(|item| match item {
        LoggerTextItem::Text(text) => text.clone(),
        LoggerTextItem::HangingText { text, .. } => text.clone(),
      })
      .collect()
  }

  #[test]
  fn visible_indexes_returns_all_when_no_filter() {
    let items = vec![(false, "alpha".to_string()), (false, "beta".to_string())];
    let data = build_data(&items);
    assert_eq!(visible_indexes(&data), vec![0, 1]);
  }

  #[test]
  fn visible_indexes_filters_case_insensitively() {
    let items = vec![(false, "TypeScript".to_string()), (false, "JSON".to_string()), (false, "Markdown".to_string())];
    let mut data = build_data(&items);
    data.filter = "json".to_string();
    assert_eq!(visible_indexes(&data), vec![1]);
    data.filter = "s".to_string(); // matches "TypeScript" and "JSON"
    assert_eq!(visible_indexes(&data), vec![0, 1]);
    data.filter = "nope".to_string();
    assert_eq!(visible_indexes(&data), Vec::<usize>::new());
  }

  #[test]
  fn update_scroll_offset_scrolls_to_keep_active_visible() {
    let items = (0..10).map(|i| (false, format!("item{i}"))).collect::<Vec<_>>();
    let mut data = build_data(&items);

    // active below the window scrolls down so it's the last visible row
    data.active_index = 7;
    update_scroll_offset(&mut data, 10, 3);
    assert_eq!(data.scroll_offset, 5);

    // active above the window scrolls up to the active row
    data.active_index = 2;
    update_scroll_offset(&mut data, 10, 3);
    assert_eq!(data.scroll_offset, 2);

    // active already visible doesn't move the window
    data.active_index = 3;
    update_scroll_offset(&mut data, 10, 3);
    assert_eq!(data.scroll_offset, 2);
  }

  #[test]
  fn update_scroll_offset_clamps_to_end() {
    let items = (0..5).map(|i| (false, format!("item{i}"))).collect::<Vec<_>>();
    let mut data = build_data(&items);
    data.scroll_offset = 4;
    data.active_index = 4;
    update_scroll_offset(&mut data, 5, 3);
    // max scroll is 5 - 3 = 2
    assert_eq!(data.scroll_offset, 2);
  }

  #[test]
  fn render_marks_active_and_selected() {
    let items = vec![(true, "alpha".to_string()), (false, "beta".to_string())];
    let mut data = build_data(&items);
    data.active_index = 1;
    let visible = visible_indexes(&data);
    assert_eq!(
      rendered_lines(&render_multi_select(&data, &visible, 10)),
      vec!["Select:", "  [x] alpha", "> [ ] beta"]
    );
  }

  #[test]
  fn render_dims_non_selectable_items() {
    let data = build_data_with_items(vec![
      MultiSelectItem::new("alpha".to_string(), false),
      MultiSelectItem::non_selectable("beta".to_string()),
    ]);
    let visible = visible_indexes(&data);
    assert_eq!(
      rendered_lines(&render_multi_select(&data, &visible, 10)),
      vec!["Select:".to_string(), "> [ ] alpha".to_string(), format!("  [x] {}", colors::gray("beta")),]
    );
  }

  #[test]
  fn render_dims_item_details_apart_from_highlighted_parts() {
    let data = build_data_with_items(vec![
      MultiSelectItem::new("alpha".to_string(), false).with_detail(vec![
        MultiSelectDetailPart::new("("),
        MultiSelectDetailPart {
          text: ".a".to_string(),
          is_highlighted: true,
        },
        MultiSelectDetailPart::new(", .b)"),
      ]),
      MultiSelectItem::non_selectable("beta".to_string()).with_detail(vec![MultiSelectDetailPart::new("(.c)")]),
    ]);
    assert_eq!(data.items[0].full_text(), "alpha (.a, .b)");
    let visible = visible_indexes(&data);
    assert_eq!(
      rendered_lines(&render_multi_select(&data, &visible, 10)),
      vec![
        "Select:".to_string(),
        format!("> [ ] alpha {}{}{}", colors::gray("("), colors::cyan(".a"), colors::gray(", .b)")),
        format!("  [x] {} {}", colors::gray("beta"), colors::gray("(.c)")),
      ]
    );
  }

  #[test]
  fn visible_indexes_filters_on_item_details() {
    let mut data = build_data_with_items(vec![
      MultiSelectItem::new("alpha".to_string(), false).with_detail(vec![MultiSelectDetailPart::new("(.ts)")]),
      MultiSelectItem::new("beta".to_string(), false).with_detail(vec![MultiSelectDetailPart::new("(.json)")]),
    ]);
    data.filter = ".json".to_string();
    assert_eq!(visible_indexes(&data), vec![1]);
    data.filter = "alpha (".to_string();
    assert_eq!(visible_indexes(&data), vec![0]);
  }

  #[test]
  fn render_complete_only_shows_what_was_chosen() {
    let data = build_data_with_items(vec![
      MultiSelectItem::new("alpha".to_string(), true),
      MultiSelectItem::new("beta".to_string(), false),
      // shown while selecting, but not something the user chose
      MultiSelectItem::non_selectable("gamma".to_string()),
    ]);
    assert_eq!(rendered_lines(&render_complete(&data)), vec!["Select:", " * alpha"]);
  }

  #[test]
  fn render_shows_filter_and_scroll_indicators() {
    let items = (0..10).map(|i| (false, format!("item{i}"))).collect::<Vec<_>>();
    let mut data = build_data(&items);
    data.filter = "item".to_string();
    data.active_index = 5;
    data.scroll_offset = 4;
    let visible = visible_indexes(&data);
    assert_eq!(
      rendered_lines(&render_multi_select(&data, &visible, 3)),
      vec![
        "Select:",
        "  filter: item",
        "  ...4 more above",
        "  [ ] item4",
        "> [ ] item5",
        "  [ ] item6",
        "  ...3 more below",
      ]
    );
  }

  #[test]
  fn render_shows_message_when_no_matches() {
    let items = vec![(false, "alpha".to_string())];
    let mut data = build_data(&items);
    data.filter = "nope".to_string();
    let visible = visible_indexes(&data);
    assert_eq!(
      rendered_lines(&render_multi_select(&data, &visible, 10)),
      vec!["Select:", "  filter: nope", "  (no matching plugins)"]
    );
  }
}