ktrs-cli 0.3.1

Command-line front ends: `ktrs` and flag-compatible `ktfmt` and `ktlint` (binaries: the root `ktrs` package)
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

mod common;

use common::{TempDir, write_text};
use ktrs_cli::serve;

fn frame(payload: &str) -> Vec<u8> {
    let mut bytes = (payload.len() as u32).to_be_bytes().to_vec();
    bytes.extend_from_slice(payload.as_bytes());
    bytes
}

fn frames(mut bytes: &[u8]) -> Vec<String> {
    let mut out = Vec::new();
    while !bytes.is_empty() {
        let length = u32::from_be_bytes(bytes[..4].try_into().unwrap()) as usize;
        out.push(String::from_utf8(bytes[4..4 + length].to_vec()).unwrap());
        bytes = &bytes[4 + length..];
    }
    out
}

/// Runs a session over `requests`; the exit code and the response frames (hello first).
fn session(requests: &[&str]) -> (i32, Vec<String>) {
    let input: Vec<u8> = requests.iter().flat_map(|r| frame(r)).collect();
    let mut output = Vec::new();
    let code = serve::run(&input[..], &mut output);
    (code, frames(&output))
}

#[test]
fn hello_then_one_response_per_request_in_order() {
    let (code, responses) = session(&["\nfun  f( ) = 1\n", "style=google\n\nfun f() = 1\n"]);
    assert_eq!(code, 0);
    assert_eq!(responses[0], format!("ktrs-serve 1 {}", env!("CARGO_PKG_VERSION")));
    assert_eq!(responses[1], "status=ok\nchanged=true\n\nfun f() = 1\n");
    assert_eq!(responses[2], "status=ok\nchanged=false\n\nfun f() = 1\n");
}

#[test]
fn options_override_the_style() {
    let code = "fun f() {\n  val x = 1\n}\n";
    let (_, responses) = session(&[&format!("style=google\nblock-indent=4\n\n{code}")]);
    assert_eq!(responses[1], "status=ok\nchanged=true\n\nfun f() {\n    val x = 1\n}\n");
}

#[test]
fn unused_imports_are_kept_on_request() {
    let code = "import a.B\n\nfun f() = 1\n";
    let (_, responses) = session(&[&format!("\n{code}"), &format!("remove-unused-imports=false\n\n{code}")]);
    assert_eq!(responses[1], "status=ok\nchanged=true\n\nfun f() = 1\n");
    assert_eq!(responses[2], format!("status=ok\nchanged=false\n\n{code}"));
}

#[test]
fn errors_answer_the_request_and_the_server_carries_on() {
    let (code, responses) = session(&["path=src/A.kt\n\nfun f( {\n", "bogus=1\n\n", "no header end", "\nval x = 1\n"]);
    assert_eq!(code, 0);
    assert!(responses[1].starts_with("status=error\n\nsrc/A.kt:1:"), "{}", responses[1]);
    assert_eq!(responses[2], "status=error\n\nunknown request key 'bogus'");
    assert_eq!(responses[3], "status=error\n\nrequest has no empty line after its header");
    assert_eq!(responses[4], "status=ok\nchanged=false\n\nval x = 1\n");
}

#[test]
fn errors_without_a_path_are_ktfmts_message_alone() {
    let (_, responses) = session(&["\nfun f( {\n"]);
    assert!(responses[1].starts_with("status=error\n\n1:"), "{}", responses[1]);
}

#[test]
fn editorconfig_applies_at_the_path_when_asked() {
    let dir = TempDir::new("serve-editorconfig");
    write_text(&dir.path().join(".editorconfig"), "root = true\n[*.kt]\nindent_size = 8\n");
    let path = dir.path().join("A.kt");
    let code = "fun f() {\n  val x = 1\n}\n";
    let (_, responses) = session(&[
        &format!("path={}\neditorconfig=true\n\n{code}", path.display()),
        &format!("path={}\n\n{code}", path.display()),
    ]);
    assert_eq!(responses[1], "status=ok\nchanged=true\n\nfun f() {\n        val x = 1\n}\n");
    assert_eq!(responses[2], format!("status=ok\nchanged=false\n\n{code}"));
}

#[test]
fn a_truncated_frame_ends_the_server() {
    let mut input = frame("\nval x = 1\n");
    input.extend_from_slice(&100u32.to_be_bytes());
    input.extend_from_slice(b"short");
    let mut output = Vec::new();
    assert_eq!(serve::run(&input[..], &mut output), 2);
    assert_eq!(frames(&output).len(), 2);
}