mnemo-rs 1.9.0

Local-first shell history manager with CLI/TUI, fuzzy search, project/session context, and DevSecOps-focused release hardening.
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
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
//! Commande `mnemo runbook` : génère un runbook Markdown réutilisable à partir
//! des commandes d'une session ou d'un projet Git.
//!
//! Le runbook liste chaque commande dans une section Markdown numérotée avec son
//! répertoire de travail, triées par ordre chronologique (le plus ancien en
//! premier). Les lignes vides sont exclues. Le résultat est stable et
//! déterministe : idéal pour une documentation ou un wiki.
//!
//! Les secrets sont redactés par défaut (`--no-redact` pour désactiver).

use anyhow::{bail, Context, Result};
use rusqlite::Connection;
use serde::Serialize;
use std::collections::BTreeMap;
use std::io::{self, Write};
use std::path::PathBuf;

use crate::config;
use crate::db;
use crate::mdfmt::{display_home, md_code_block};
use crate::secrets;

// ---------------------------------------------------------------------------
// Enums publics (réexportés pour cli.rs)
// ---------------------------------------------------------------------------

/// Format de sortie du runbook.
#[derive(Debug, Clone, Copy, PartialEq, Eq, clap::ValueEnum)]
pub enum RunbookFormat {
    /// Rendu Markdown (défaut).
    Markdown,
    /// JSON structuré, stable et déterministe.
    Json,
}

/// Mode de groupement des commandes dans le runbook.
#[derive(Debug, Clone, Copy, PartialEq, Eq, clap::ValueEnum)]
pub enum GroupBy {
    /// Liste plate, une section numérotée par commande (défaut).
    None,
    /// Sections par répertoire de travail.
    Cwd,
    /// Sections par racine Git (`git_root`).
    Project,
}

// ---------------------------------------------------------------------------
// Structures publiques
// ---------------------------------------------------------------------------

/// Une entrée du runbook : une commande avec son contexte minimal.
#[derive(Debug, Clone)]
pub struct RunbookEntry {
    /// Commande shell (toujours non vide après filtrage).
    pub command: String,
    /// Répertoire de travail au moment de l'exécution (raccourci `~/…`).
    pub cwd: String,
    /// Horodatage de la commande (`YYYY-MM-DD HH:MM:SS`).
    pub timestamp: String,
    /// Racine Git (`git_root`), utilisée pour le groupement par projet.
    pub git_root: Option<String>,
}

// ---------------------------------------------------------------------------
// Fonctions de récupération
// ---------------------------------------------------------------------------

/// Charge les commandes de la dernière session, en ordre chronologique croissant.
/// Exclut les commandes vides (après trim).
///
/// Renvoie une erreur si aucune session n'est enregistrée.
pub fn fetch_last_session_commands(
    conn: &Connection,
    limit: Option<u32>,
) -> Result<Vec<RunbookEntry>> {
    let session_id = db::latest_session_id(conn)?.ok_or_else(|| {
        anyhow::anyhow!(
            "Aucune session trouvée. Les commandes importées ou enregistrées \
             sans MNEMO_SESSION_ID ne sont pas rattachées à une session."
        )
    })?;
    fetch_session_commands(conn, &session_id, limit)
}

/// Charge les commandes d'une session explicite, en ordre chronologique croissant.
///
/// Renvoie une erreur si la session est introuvable.
pub fn fetch_session_commands(
    conn: &Connection,
    session_id: &str,
    limit: Option<u32>,
) -> Result<Vec<RunbookEntry>> {
    let lim = limit.map(|n| n as usize);
    let records = db::session_commands(conn, session_id, lim)?;
    if records.is_empty() {
        bail!("Session introuvable : {session_id}");
    }
    Ok(records_to_entries(records))
}

/// Charge les commandes d'un projet (par nom court ou chemin `git_root`), en
/// ordre chronologique croissant. Toutes les racines correspondantes sont
/// agrégées avant tri.
///
/// Renvoie une erreur si aucune racine ne correspond à `name_or_path`.
pub fn fetch_project_commands(
    conn: &Connection,
    name_or_path: &str,
    limit: Option<u32>,
) -> Result<Vec<RunbookEntry>> {
    let roots = db::match_project_roots(conn, name_or_path)?;
    if roots.is_empty() {
        bail!("Projet introuvable : {name_or_path}");
    }
    let mut all: Vec<db::CommandRecord> = Vec::new();
    for root in &roots {
        // project_records retourne DESC ; on collecte tout et on trie ensuite.
        let records = db::project_records(conn, root, None, None, false, None)?;
        all.extend(records);
    }
    // Tri chronologique croissant (le plus ancien en premier).
    all.sort_by(|a, b| {
        a.created_at
            .cmp(&b.created_at)
            .then_with(|| a.id.cmp(&b.id))
    });
    // Appliquer la limite après le tri.
    if let Some(n) = limit {
        all.truncate(n as usize);
    }
    Ok(records_to_entries(all))
}

/// Convertit des [`db::CommandRecord`] en [`RunbookEntry`], en excluant les
/// commandes vides (après trim).
fn records_to_entries(records: Vec<db::CommandRecord>) -> Vec<RunbookEntry> {
    records
        .into_iter()
        .filter(|r| !r.command.trim().is_empty())
        .map(|r| RunbookEntry {
            command: r.command,
            cwd: r
                .cwd
                .as_deref()
                .filter(|s| !s.is_empty())
                .map(display_home)
                .unwrap_or_else(|| "-".to_string()),
            timestamp: r.created_at,
            git_root: r.git_root,
        })
        .collect()
}

// ---------------------------------------------------------------------------
// Rendu Markdown
// ---------------------------------------------------------------------------

/// Génère le document Markdown d'un runbook.
///
/// - `title` : titre du runbook (remplace la section `# Runbook - …`).
/// - `source_desc` : description lisible de la source (session, projet…).
/// - `entries` : commandes à inclure (les vides ont déjà été exclues en amont).
/// - `group_by` : mode de groupement des commandes.
///
/// Quand `entries` est vide, le document reste cohérent (section Commands avec
/// un message explicite, pas de panic).
pub fn render_markdown(
    title: &str,
    source_desc: &str,
    entries: &[RunbookEntry],
    group_by: GroupBy,
) -> String {
    let generated_at = db::now_timestamp();
    let mut out = String::new();

    out.push_str(&format!("# Runbook - {title}\n\n"));

    out.push_str("## Metadata\n\n");
    out.push_str(&format!("- Source: {source_desc}\n"));
    out.push_str(&format!("- Generated at: {generated_at}\n"));
    out.push_str(&format!("- Commands: {}\n\n", entries.len()));

    out.push_str("## Commands\n\n");

    if entries.is_empty() {
        out.push_str("_Aucune commande._\n");
        return out;
    }

    match group_by {
        GroupBy::None => {
            for (i, entry) in entries.iter().enumerate() {
                out.push_str(&format!("### {}. {}\n\n", i + 1, entry.cwd));
                out.push_str(&md_code_block(std::slice::from_ref(&entry.command)));
                out.push('\n');
            }
        }
        GroupBy::Cwd | GroupBy::Project => {
            let grouped = group_entries(entries, group_by);
            for (group_key, group_entries) in &grouped {
                out.push_str(&format!("## {group_key}\n\n"));
                for (i, entry) in group_entries.iter().enumerate() {
                    out.push_str(&format!("### {}.\n\n", i + 1));
                    out.push_str(&md_code_block(std::slice::from_ref(&entry.command)));
                    out.push('\n');
                }
            }
        }
    }

    out
}

// ---------------------------------------------------------------------------
// Rendu JSON
// ---------------------------------------------------------------------------

/// Ligne JSON pour une commande du runbook.
#[derive(Serialize)]
struct JsonCommand<'a> {
    n: usize,
    cwd: &'a str,
    timestamp: &'a str,
    command: &'a str,
    #[serde(skip_serializing_if = "Option::is_none")]
    group: Option<String>,
}

/// Document JSON racine du runbook.
#[derive(Serialize)]
struct JsonRunbook<'a> {
    title: &'a str,
    source: &'a str,
    generated_at: String,
    commands: Vec<JsonCommand<'a>>,
}

/// Génère la représentation JSON d'un runbook.
///
/// Structure stable et déterministe : même entrées → même JSON.
/// Avec `group_by` ≠ `None`, chaque commande porte un champ `"group"`.
pub fn render_json(
    title: &str,
    source_desc: &str,
    entries: &[RunbookEntry],
    group_by: GroupBy,
) -> Result<String> {
    let generated_at = db::now_timestamp();

    let commands: Vec<JsonCommand<'_>> = match group_by {
        GroupBy::None => entries
            .iter()
            .enumerate()
            .map(|(i, e)| JsonCommand {
                n: i + 1,
                cwd: &e.cwd,
                timestamp: &e.timestamp,
                command: &e.command,
                group: None,
            })
            .collect(),
        GroupBy::Cwd | GroupBy::Project => {
            let grouped = group_entries(entries, group_by);
            let mut cmds = Vec::with_capacity(entries.len());
            let mut n = 1usize;
            for (group_key, group_entries) in &grouped {
                for entry in group_entries {
                    cmds.push(JsonCommand {
                        n,
                        cwd: &entry.cwd,
                        timestamp: &entry.timestamp,
                        command: &entry.command,
                        group: Some(group_key.clone()),
                    });
                    n += 1;
                }
            }
            cmds
        }
    };

    let doc = JsonRunbook {
        title,
        source: source_desc,
        generated_at,
        commands,
    };

    serde_json::to_string_pretty(&doc).context("sérialisation JSON du runbook")
}

// ---------------------------------------------------------------------------
// Helpers de groupement
// ---------------------------------------------------------------------------

/// Retourne les entrées groupées par clé (alphabétique), les commandes dans
/// chaque groupe étant dans l'ordre de `entries` (chronologique).
fn group_entries<'a>(
    entries: &'a [RunbookEntry],
    group_by: GroupBy,
) -> BTreeMap<String, Vec<&'a RunbookEntry>> {
    let mut map: BTreeMap<String, Vec<&'a RunbookEntry>> = BTreeMap::new();
    for entry in entries {
        let key = match group_by {
            GroupBy::None => unreachable!(),
            GroupBy::Cwd => entry.cwd.clone(),
            GroupBy::Project => entry
                .git_root
                .as_deref()
                .filter(|s| !s.is_empty())
                .map(display_home)
                .unwrap_or_else(|| "(sans projet)".to_string()),
        };
        map.entry(key).or_default().push(entry);
    }
    map
}

// ---------------------------------------------------------------------------
// Point d'entrée de la commande
// ---------------------------------------------------------------------------

/// Point d'entrée de `mnemo runbook`.
///
/// Exactement un des drapeaux `last`, `session`, `project` doit être fourni
/// (mutuellement exclusifs côté clap). Si aucun n'est fourni, une erreur claire
/// est retournée.
///
/// Les secrets sont redactés par défaut ; `no_redact = true` désactive ce
/// comportement.
#[allow(clippy::too_many_arguments)]
pub fn run(
    last: bool,
    session: Option<String>,
    project: Option<String>,
    output: Option<PathBuf>,
    force: bool,
    limit: Option<u32>,
    title: Option<String>,
    format: RunbookFormat,
    no_redact: bool,
    group_by: GroupBy,
) -> Result<()> {
    let conn = db::open(&config::db_path()?)?;

    let (entries, source_desc, default_title): (Vec<RunbookEntry>, String, String) = if last {
        let sid = db::latest_session_id(&conn)?.ok_or_else(|| {
            anyhow::anyhow!(
                "Aucune session trouvée. Les commandes importées ou enregistrées \
                     sans MNEMO_SESSION_ID ne sont pas rattachées à une session."
            )
        })?;
        let e = fetch_session_commands(&conn, &sid, limit)?;
        let desc = format!("dernière session ({sid})");
        let dtitle = sid.clone();
        (e, desc, dtitle)
    } else if let Some(ref sid) = session {
        let e = fetch_session_commands(&conn, sid, limit)?;
        (e, format!("session {sid}"), sid.clone())
    } else if let Some(ref proj) = project {
        let e = fetch_project_commands(&conn, proj, limit)?;
        (e, format!("projet {proj}"), proj.clone())
    } else {
        bail!(
            "Préciser une source : --last, --session <ID> ou --project <NOM>.\n\
                 Utilisez `mnemo runbook --help` pour voir les options disponibles."
        );
    };

    // Redaction des secrets (activée par défaut).
    let entries = if no_redact {
        entries
    } else {
        let cfg = config::Config::load()?;
        entries
            .into_iter()
            .map(|mut e| {
                if let Some(finding) = secrets::analyze(&e.command, &cfg.sensitive_keywords) {
                    e.command = finding.redacted;
                }
                e
            })
            .collect()
    };

    let resolved_title = title.unwrap_or(default_title);
    let content = match format {
        RunbookFormat::Markdown => {
            render_markdown(&resolved_title, &source_desc, &entries, group_by)
        }
        RunbookFormat::Json => render_json(&resolved_title, &source_desc, &entries, group_by)?,
    };

    match output {
        Some(ref path) => {
            if path.exists() && !force {
                bail!(
                    "Le fichier {} existe déjà. Utilisez --force pour l'écraser.",
                    path.display()
                );
            }
            std::fs::write(path, content.as_bytes())
                .with_context(|| format!("écriture du runbook {}", path.display()))?;
            eprintln!(
                "Runbook écrit dans {} ({} commandes).",
                path.display(),
                entries.len()
            );
        }
        None => {
            let stdout = io::stdout();
            let mut out = stdout.lock();
            out.write_all(content.as_bytes())?;
        }
    }
    Ok(())
}

// ---------------------------------------------------------------------------
// Tests unitaires
// ---------------------------------------------------------------------------

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

    fn make_entries(cmds: &[(&str, &str)]) -> Vec<RunbookEntry> {
        cmds.iter()
            .enumerate()
            .map(|(i, (cmd, cwd))| RunbookEntry {
                command: cmd.to_string(),
                cwd: cwd.to_string(),
                timestamp: format!("2026-01-01 10:{i:02}:00"),
                git_root: None,
            })
            .collect()
    }

    #[test]
    fn render_contient_titre_et_sections() {
        let entries = make_entries(&[("cargo build", "~/proj")]);
        let md = render_markdown("mon runbook", "session s1", &entries, GroupBy::None);
        assert!(md.contains("# Runbook - mon runbook"));
        assert!(md.contains("## Metadata"));
        assert!(md.contains("## Commands"));
        assert!(md.contains("Source: session s1"));
        assert!(md.contains("Commands: 1"));
    }

    #[test]
    fn render_numerote_les_sections() {
        let entries = make_entries(&[("git pull", "~/a"), ("cargo test", "~/b")]);
        let md = render_markdown("test", "session s1", &entries, GroupBy::None);
        assert!(md.contains("### 1. ~/a"));
        assert!(md.contains("### 2. ~/b"));
        assert!(md.contains("git pull"));
        assert!(md.contains("cargo test"));
    }

    #[test]
    fn render_zero_commandes_reste_coherent() {
        let md = render_markdown("vide", "session s1", &[], GroupBy::None);
        assert!(md.contains("# Runbook - vide"));
        assert!(md.contains("## Commands"));
        assert!(md.contains("Commands: 0"));
        assert!(md.contains("_Aucune commande._"));
    }

    #[test]
    fn render_echappe_les_backticks_dans_les_blocs() {
        let entries = make_entries(&[("echo `date`", "~/proj")]);
        let md = render_markdown("bt", "session s1", &entries, GroupBy::None);
        // La clôture du bloc doit être plus longue que 1 backtick.
        let fences: Vec<&str> = md.lines().filter(|l| l.starts_with("```")).collect();
        assert_eq!(fences.len() % 2, 0, "blocs non équilibrés");
    }

    #[test]
    fn records_to_entries_exclut_les_commandes_vides() {
        let records = vec![
            db::CommandRecord {
                id: 1,
                command: "  ".to_string(),
                cwd: Some("/tmp".to_string()),
                shell: None,
                hostname: None,
                exit_code: Some(0),
                created_at: "2026-01-01 10:00:00".to_string(),
                git_root: None,
                git_branch: None,
                git_remote: None,
                session_id: Some("s1".to_string()),
            },
            db::CommandRecord {
                id: 2,
                command: "ls".to_string(),
                cwd: Some("/tmp".to_string()),
                shell: None,
                hostname: None,
                exit_code: Some(0),
                created_at: "2026-01-01 10:01:00".to_string(),
                git_root: None,
                git_branch: None,
                git_remote: None,
                session_id: Some("s1".to_string()),
            },
        ];
        let entries = records_to_entries(records);
        assert_eq!(entries.len(), 1);
        assert_eq!(entries[0].command, "ls");
    }

    #[test]
    fn format_json_produit_un_json_valide() {
        let entries = make_entries(&[("cargo build", "~/proj"), ("cargo test", "~/proj")]);
        let json = render_json("mon runbook", "session s1", &entries, GroupBy::None).unwrap();
        let v: serde_json::Value = serde_json::from_str(&json).expect("JSON invalide");
        assert!(v["title"].is_string());
        assert!(v["source"].is_string());
        assert!(v["generated_at"].is_string());
        assert!(v["commands"].is_array());
        assert_eq!(v["commands"].as_array().unwrap().len(), 2);
    }

    #[test]
    fn format_json_champ_command_present() {
        let entries = make_entries(&[("git status", "~/repo")]);
        let json = render_json("t", "s", &entries, GroupBy::None).unwrap();
        let v: serde_json::Value = serde_json::from_str(&json).unwrap();
        let cmd = &v["commands"][0];
        assert!(cmd["command"].is_string());
        assert!(cmd["cwd"].is_string());
        assert!(cmd["timestamp"].is_string());
        assert_eq!(cmd["n"], 1);
    }

    #[test]
    fn group_by_none_liste_plate() {
        let entries = make_entries(&[("cmd1", "~/a"), ("cmd2", "~/b"), ("cmd3", "~/a")]);
        let md = render_markdown("t", "s", &entries, GroupBy::None);
        assert!(md.contains("### 1. ~/a"));
        assert!(md.contains("### 2. ~/b"));
        assert!(md.contains("### 3. ~/a"));
    }

    #[test]
    fn group_by_cwd_groupe_les_sections() {
        let entries = make_entries(&[
            ("cmd1", "~/proj/foo"),
            ("cmd2", "~/proj/bar"),
            ("cmd3", "~/proj/foo"),
        ]);
        let md = render_markdown("t", "s", &entries, GroupBy::Cwd);
        // Deux sections de niveau 2 : une pour chaque cwd distinct
        assert!(md.contains("## ~/proj/bar"));
        assert!(md.contains("## ~/proj/foo"));
        // Dans le groupe foo, les commandes sont numérotées depuis 1
        assert!(md.contains("### 1."));
        assert!(md.contains("### 2."));
        // Le contenu est présent
        assert!(md.contains("cmd1"));
        assert!(md.contains("cmd2"));
        assert!(md.contains("cmd3"));
    }

    #[test]
    fn group_by_project_groupe_par_git_root() {
        let entries = vec![
            RunbookEntry {
                command: "cargo build".to_string(),
                cwd: "~/proj/a".to_string(),
                timestamp: "2026-01-01 10:00:00".to_string(),
                git_root: Some("/home/user/proj/a".to_string()),
            },
            RunbookEntry {
                command: "npm test".to_string(),
                cwd: "~/proj/b".to_string(),
                timestamp: "2026-01-01 10:01:00".to_string(),
                git_root: Some("/home/user/proj/b".to_string()),
            },
            RunbookEntry {
                command: "make".to_string(),
                cwd: "~/proj/a".to_string(),
                timestamp: "2026-01-01 10:02:00".to_string(),
                git_root: None,
            },
        ];
        let md = render_markdown("t", "s", &entries, GroupBy::Project);
        assert!(md.contains("(sans projet)"), "groupe sans projet attendu");
        assert!(md.contains("cargo build"));
        assert!(md.contains("npm test"));
        assert!(md.contains("make"));
    }

    #[test]
    fn group_by_json_ajoute_champ_group() {
        let entries = make_entries(&[("cmd1", "~/a"), ("cmd2", "~/b")]);
        let json = render_json("t", "s", &entries, GroupBy::Cwd).unwrap();
        let v: serde_json::Value = serde_json::from_str(&json).unwrap();
        let cmds = v["commands"].as_array().unwrap();
        for cmd in cmds {
            assert!(cmd["group"].is_string(), "champ group manquant");
        }
    }

    #[test]
    fn group_by_json_none_pas_de_champ_group() {
        let entries = make_entries(&[("cmd1", "~/a")]);
        let json = render_json("t", "s", &entries, GroupBy::None).unwrap();
        let v: serde_json::Value = serde_json::from_str(&json).unwrap();
        let cmd = &v["commands"][0];
        assert!(
            cmd.get("group").is_none() || cmd["group"].is_null(),
            "group ne doit pas être présent en mode None"
        );
    }
}