fresh-editor 0.3.2

A lightweight, fast terminal-based text editor with LSP support and TypeScript plugins
Documentation 
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

//! Regression test for https://github.com/sinelaw/fresh/issues/1722
//!
//! When a user runs Fresh from a project directory that happens to contain
//! a folder called `plugins/` (unrelated to Fresh's plugin system), the
//! embedded bundled plugins (`pkg.ts`, `find_references.ts`, etc.) silently
//! fail to load. This makes commands like "Package: Packages" disappear
//! from the command palette and breaks features like "Find References".
//!
//! The reproducer from the issue is:
//! ```shell
//! mkdir -p lorem/plugins
//! cd lorem
//! fresh
//! ```
//! Expected: the Package Manager command shows up in the command palette.
//! Actual: it's missing.

#![cfg(all(feature = "plugins", feature = "embed-plugins"))]

use crate::common::harness::{EditorTestHarness, HarnessOptions};
use crossterm::event::{KeyCode, KeyModifiers};
use std::fs;
use tempfile::TempDir;

/// Reproduces issue #1722: an empty `plugins/` directory next to the user's
/// project must not stop the bundled embedded plugins from loading.
///
/// Drives the command palette via keyboard and asserts only on rendered
/// output: typing a short fragment of the Package Manager command name
/// must surface the *description* registered by `pkg.ts`
/// ("Browse and manage installed and available packages"). That string is
/// only ever rendered as part of the suggestion row and is unique to the
/// `pkg.ts` plugin's i18n, so its presence on screen proves the embedded
/// plugin loaded.
#[test]
fn test_empty_plugins_dir_in_working_dir_does_not_hide_embedded_plugins() {
    // Simulate `mkdir -p lorem/plugins; cd lorem; fresh` from the issue.
    let temp_dir = TempDir::new().unwrap();
    let working_dir = temp_dir.path().to_path_buf();
    let user_plugins_dir = working_dir.join("plugins");
    fs::create_dir_all(&user_plugins_dir).unwrap();

    // The harness's normal "directory presence == user controls plugins"
    // rule would suppress embedded loading here, masking the bug we want
    // to verify. `with_forced_embedded_plugins` opts into production
    // plugin-loading semantics so this test exercises what a real user
    // would see.
    let mut harness = EditorTestHarness::create(
        140,
        40,
        HarnessOptions::new()
            .with_working_dir(working_dir.clone())
            .with_forced_embedded_plugins(),
    )
    .unwrap();

    // Open the command palette.
    harness
        .send_key(KeyCode::Char('p'), KeyModifiers::CONTROL)
        .unwrap();
    harness.wait_for_prompt().unwrap();

    // Type a short fragment that should match the Package Manager command
    // ("Package: Packages") via the palette's fuzzy match. We deliberately
    // type *less* than the description we'll assert on, so the assertion
    // can only succeed by reading text rendered from the suggestion list.
    harness.type_text("Packages").unwrap();

    // The description string is unique to the `pkg.ts` plugin's i18n. If
    // embedded plugins didn't load (the bug), this text never appears.
    harness
        .wait_until(|h| {
            h.screen_to_string()
                .contains("Browse and manage installed and available packages")
        })
        .unwrap();
}