flk 0.6.2

A CLI tool for managing flake.nix devShell environments
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

//! # Completions Command Handler
//!
//! Generate and install shell completions for bash, zsh, fish, and more.

use anyhow::{anyhow, Result};
use clap::CommandFactory;
use clap_complete::{generate, generate_to, shells::Shell};
use std::{env, fs, io, path::PathBuf};

use crate::Cli;

/// Generate or install shell completions.
///
/// # Arguments
///
/// * `install` - If true, install completions to the appropriate location
/// * `shell` - Target shell (auto-detected if not provided)
pub fn handle_completions(install: bool, shell: Option<Shell>) -> Result<()> {
    let mut cmd = Cli::command();
    let bin_name = cmd.get_name().to_string();

    // Detect shell automatically if not provided
    let shell = shell.or_else(detect_shell).unwrap_or(Shell::Bash);

    if install {
        let path = get_completion_install_path(shell)?;
        fs::create_dir_all(path.parent().unwrap())?;
        generate_to(shell, &mut cmd, bin_name.clone(), path.parent().unwrap())?;
        println!(
            "✅ Installed completions for {shell:?} at {}",
            path.display()
        );
        print_post_install_message(shell);
    } else {
        generate(shell, &mut cmd, bin_name, &mut io::stdout());
    }

    Ok(())
}

/// Try to detect the current shell from the environment
fn detect_shell() -> Option<Shell> {
    env::var("SHELL").ok().and_then(|path| {
        if path.contains("bash") {
            Some(Shell::Bash)
        } else if path.contains("zsh") {
            Some(Shell::Zsh)
        } else if path.contains("fish") {
            Some(Shell::Fish)
        } else if path.contains("elvish") {
            Some(Shell::Elvish)
        } else if path.contains("powershell") {
            Some(Shell::PowerShell)
        } else {
            None
        }
    })
}

/// Figure out where to install the completion script depending on shell
fn get_completion_install_path(shell: Shell) -> Result<PathBuf> {
    let home = dirs::home_dir().ok_or_else(|| anyhow!("Could not detect home directory"))?;

    let path = match shell {
        Shell::Bash => home.join(".local/share/bash-completion/completions/flk"),
        Shell::Zsh => home.join(".zsh/completions/_flk"),
        Shell::Fish => home.join(".config/fish/completions/flk.fish"),
        Shell::PowerShell => home.join("Documents/PowerShell/Microsoft.PowerShell_profile.ps1"),
        Shell::Elvish => home.join(".config/elvish/lib/completions/flk.elv"),
        _ => return Err(anyhow!("Unsupported shell for auto-install")),
    };

    Ok(path)
}

/// Print helpful info after installing completions
fn print_post_install_message(shell: Shell) {
    match shell {
        Shell::Zsh => println!(
            "\nℹ️  Make sure your ~/.zshrc contains:\n  fpath+=~/.zsh/completions\n  autoload -Uz compinit && compinit"
        ),
        Shell::Bash => println!(
            "\nℹ️  You may need to reload your shell or run:\n  source ~/.bashrc"
        ),
        Shell::Fish => println!(
            "\nℹ️  Restart your terminal or run:\n  exec fish"
        ),
        _ => (),
    }
}