linthis 0.22.0

A fast, cross-platform multi-language linter and formatter
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
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

// Copyright 2024 zhlinh and linthis Project Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found at
//
// https://opensource.org/license/MIT

//! End-to-end test for `linthis shell` against a temp $HOME.

use std::path::PathBuf;
use std::process::Command;

fn linthis_bin() -> PathBuf {
    // CARGO_BIN_EXE_<name> is set by Cargo for integration tests.
    PathBuf::from(env!("CARGO_BIN_EXE_linthis"))
}

fn run(home: &std::path::Path, args: &[&str]) -> std::process::Output {
    Command::new(linthis_bin())
        .env("HOME", home)
        .env_remove("LINTHIS_HOOK_COLOR")
        .args(args)
        .output()
        .expect("spawn linthis")
}

#[test]
fn add_alias_then_remove_round_trip() {
    let dir = tempfile::tempdir().unwrap();
    let home = dir.path();

    // 1) add alias for bash → state, source, rc all written.
    let out = run(home, &["shell", "add", "alias", "--shell", "bash"]);
    assert!(
        out.status.success(),
        "stderr: {}",
        String::from_utf8_lossy(&out.stderr)
    );

    let bashrc = std::fs::read_to_string(home.join(".bashrc")).unwrap();
    assert!(bashrc.contains("# >>> linthis shell init >>>"));
    assert!(bashrc.contains(".linthis/shell.bash"));

    let source = std::fs::read_to_string(home.join(".linthis/shell.bash")).unwrap();
    assert!(source.contains("alias lt='linthis'"));
    assert!(source.contains("ltr() { linthis report show \"$@\"; }"));
    assert!(
        !source.contains("eval \"$(linthis shell completion bash"),
        "ac was not requested but appeared in source: {source}"
    );

    let state = std::fs::read_to_string(home.join(".linthis/shell-state.toml")).unwrap();
    assert!(state.contains("[bash]") && state.contains("alias = true"));

    // 2) Second add is idempotent — no error, content unchanged.
    let out2 = run(home, &["shell", "add", "alias", "--shell", "bash"]);
    assert!(out2.status.success());
    let source2 = std::fs::read_to_string(home.join(".linthis/shell.bash")).unwrap();
    assert_eq!(source, source2);

    // 3) Now add ac too — source should grow to include both sections.
    let out3 = run(home, &["shell", "add", "ac", "--shell", "bash"]);
    assert!(out3.status.success());
    let source3 = std::fs::read_to_string(home.join(".linthis/shell.bash")).unwrap();
    assert!(source3.contains("eval \"$(linthis shell completion bash"));
    assert!(source3.contains("alias lt='linthis'"));

    // 4) Remove ac — source keeps only alias.
    let out4 = run(home, &["shell", "remove", "ac", "--shell", "bash"]);
    assert!(out4.status.success());
    let source4 = std::fs::read_to_string(home.join(".linthis/shell.bash")).unwrap();
    assert!(!source4.contains("eval \"$(linthis shell completion bash"));
    assert!(source4.contains("alias lt='linthis'"));
    assert!(
        home.join(".bashrc").exists(),
        "rc still has alias section, marker should remain"
    );

    // 5) Remove alias — source file deleted, rc marker block gone.
    let out5 = run(home, &["shell", "remove", "alias", "--shell", "bash"]);
    assert!(out5.status.success());
    assert!(
        !home.join(".linthis/shell.bash").exists(),
        "source file should be deleted"
    );
    let bashrc_final = std::fs::read_to_string(home.join(".bashrc")).unwrap();
    assert!(
        !bashrc_final.contains("# >>> linthis shell init >>>"),
        "marker block should be gone: {bashrc_final}"
    );
}

#[test]
fn add_all_targets_all_four_shells() {
    let dir = tempfile::tempdir().unwrap();
    let home = dir.path();

    let out = run(home, &["shell", "add", "all", "--shell", "all"]);
    assert!(
        out.status.success(),
        "stderr: {}",
        String::from_utf8_lossy(&out.stderr)
    );

    for ext in ["bash", "zsh", "fish", "ps1"] {
        let p = home.join(".linthis").join(format!("shell.{ext}"));
        assert!(p.exists(), "missing {p:?}");
    }
    assert!(home.join(".bashrc").exists());
    assert!(home.join(".zshrc").exists());
    assert!(home.join(".config/fish/config.fish").exists());
    assert!(home
        .join("Documents/PowerShell/Microsoft.PowerShell_profile.ps1")
        .exists());
}

#[test]
fn unknown_feature_exits_nonzero() {
    let dir = tempfile::tempdir().unwrap();
    let out = run(
        dir.path(),
        &["shell", "add", "everything", "--shell", "bash"],
    );
    assert!(!out.status.success(), "expected nonzero exit");
    let err = String::from_utf8_lossy(&out.stderr);
    assert!(err.contains("unknown feature"), "stderr: {err}");
}

#[test]
fn unknown_shell_exits_nonzero() {
    let dir = tempfile::tempdir().unwrap();
    let out = run(dir.path(), &["shell", "add", "ac", "--shell", "elvish"]);
    assert!(!out.status.success());
    let err = String::from_utf8_lossy(&out.stderr);
    assert!(err.contains("unrecognized") || err.contains("elvish"));
}

#[test]
fn status_surfaces_unmanaged_source_line() {
    let dir = tempfile::tempdir().unwrap();
    let home = dir.path();

    // Pre-seed a manually-edited .bashrc with a source line outside markers.
    std::fs::write(
        home.join(".bashrc"),
        "# user content\nsource $HOME/.linthis/shell.bash\nexport FOO=1\n",
    )
    .unwrap();

    let out = run(home, &["shell", "status"]);
    assert!(
        out.status.success(),
        "stderr: {}",
        String::from_utf8_lossy(&out.stderr)
    );
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("unmanaged"),
        "status should surface unmanaged condition. Got:\n{stdout}"
    );

    // Sanity: zsh row should NOT have the tag (no unmanaged line for zsh).
    let zsh_line = stdout
        .lines()
        .find(|l| l.contains("zsh"))
        .expect("zsh row missing");
    assert!(
        !zsh_line.contains("unmanaged"),
        "zsh should not be tagged unmanaged: {zsh_line}"
    );
}

#[test]
fn bash_add_writes_bash_profile_shim_when_bash_profile_exists() {
    let dir = tempfile::tempdir().unwrap();
    let home = dir.path();

    // Pre-seed an existing .bash_profile that doesn't source .bashrc.
    std::fs::write(
        home.join(".bash_profile"),
        "# existing user content\nexport USER_VAR=1\n",
    )
    .unwrap();

    let out = run(home, &["shell", "add", "ac", "--shell", "bash"]);
    assert!(
        out.status.success(),
        "stderr: {}",
        String::from_utf8_lossy(&out.stderr)
    );

    let bp = std::fs::read_to_string(home.join(".bash_profile")).unwrap();
    assert!(
        bp.contains("# >>> linthis bash_profile shim >>>"),
        "expected shim marker in .bash_profile: {bp}"
    );
    assert!(
        bp.contains("[ -f \"$HOME/.bashrc\" ] && . \"$HOME/.bashrc\""),
        "expected source-bashrc shim line: {bp}"
    );
    // User content preserved.
    assert!(bp.contains("export USER_VAR=1"));

    // Remove all → shim should also be removed.
    let out2 = run(home, &["shell", "remove", "all", "--shell", "bash"]);
    assert!(out2.status.success());
    let bp_after = std::fs::read_to_string(home.join(".bash_profile")).unwrap();
    assert!(
        !bp_after.contains("# >>> linthis bash_profile shim >>>"),
        "shim should be gone after remove all: {bp_after}"
    );
    assert!(bp_after.contains("export USER_VAR=1"));
}

#[test]
fn bash_add_skips_shim_when_bash_profile_missing() {
    let dir = tempfile::tempdir().unwrap();
    let home = dir.path();

    let out = run(home, &["shell", "add", "ac", "--shell", "bash"]);
    assert!(out.status.success());

    // .bash_profile must NOT have been created.
    assert!(
        !home.join(".bash_profile").exists(),
        ".bash_profile should not be auto-created when missing"
    );
}

#[test]
fn bash_add_skips_shim_when_bash_profile_already_sources_bashrc() {
    let dir = tempfile::tempdir().unwrap();
    let home = dir.path();
    std::fs::write(
        home.join(".bash_profile"),
        "[ -f ~/.bashrc ] && . ~/.bashrc\n",
    )
    .unwrap();

    let out = run(home, &["shell", "add", "ac", "--shell", "bash"]);
    assert!(out.status.success());

    let bp = std::fs::read_to_string(home.join(".bash_profile")).unwrap();
    assert!(
        !bp.contains("# >>> linthis bash_profile shim >>>"),
        "shim should NOT be added when user already sources bashrc: {bp}"
    );
    // Original content preserved.
    assert!(bp.contains("[ -f ~/.bashrc ] && . ~/.bashrc"));
}