dev_bestia_cargo_completion_lib/

lib.rs

// dev_bestia_cargo_completion/src/lib.rs

// logo for docs.rs in png
#![doc(html_logo_url = "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg")]
// region: auto_md_to_doc_comments include README.md A //!
//! # dev_bestia_cargo_completion  
//!
//! **Auto-completion for cargo-auto and automation_tasks_rs and partial auto-completion for cargo in bash**  
//! ***version: 2026.306.1702 date: 2026-03-06 author: [bestia.dev](https://bestia.dev) repository: [codeberg.org](https://codeberg.org/automation-tasks-rs/dev_bestia_cargo_completion)***
//!
//!  ![maintained](https://img.shields.io/badge/maintained-green)
//!  ![ready-for-use](https://img.shields.io/badge/ready_for_use-green)
//!  ![rustlang](https://img.shields.io/badge/rustlang-orange)
//!  ![automation](https://img.shields.io/badge/automation-orange)
//!  ![workflow](https://img.shields.io/badge/workflow-orange)
//!
//!  ![logo](https://codeberg.org/automation-tasks-rs/cargo-auto/raw/branch/main/images/logo/logo_cargo_auto.svg)
//!  dev_bestia_cargo_completion is part of the [automation_tasks_rs](https://codeberg.org/automation-tasks-rs) project
//!
//!  [![crates.io](https://img.shields.io/crates/v/dev_bestia_cargo_completion.svg)](https://crates.io/crates/dev_bestia_cargo_completion)
//!  [![Documentation](https://img.shields.io/badge/docs-stable-green.svg)](https://docs.rs/dev_bestia_cargo_completion/)
//!  ![License](https://img.shields.io/badge/license-MIT-blue.svg)
//!
//!  [![Newest docs](https://img.shields.io/badge/docs-development-yellow.svg)](https://bestia.dev/docs/dev_bestia_cargo_completion)
//!  ![dev_bestia_cargo_completion](https://bestia.dev/webpage_hit_counter/get_svg_image/710310517.svg)
//!
//!   ![Lines in Rust code](https://img.shields.io/badge/Lines_in_Rust-71-green.svg)
//!   ![Lines in Doc comments](https://img.shields.io/badge/Lines_in_Doc_comments-222-blue.svg)
//!   ![Lines in Comments](https://img.shields.io/badge/Lines_in_comments-20-purple.svg)
//!   ![Lines in examples](https://img.shields.io/badge/Lines_in_examples-0-yellow.svg)
//!   ![Lines in tests](https://img.shields.io/badge/Lines_in_tests-0-orange.svg)
//!
//! Hashtags: #maintained #ready-for-use #rustlang #automation #workflow  
//! My projects on codeberg.org are more like a tutorial than a finished product: [bestia-dev tutorials](https://codeberg.org/bestia-dev-ready-for-use/tutorials_rust_wasm).  
//! I recommend using the [CRUSTDE - Containerized Rust Development Environment](https://codeberg.org/CRUSTDE-ContainerizedRustDevEnv/crustde_cnt_img_pod) to write Rust projects on Linux, isolated from your system.  
//!
//! ## Try it
//!
//! Install the binary:
//!
//! ```bash
//! cargo install dev_bestia_cargo_completion
//! ```
//!
//! Save definition for auto_completion in bash:
//!
//! ```bash
//! complete -C "dev_bestia_cargo_completion" cargo
//! ```
//!
//! Start typing `cargo b` and press `tab`.  
//! It should auto-complete to `cargo build`.  
//! Congratulation! You just used auto-completion :-)  
//!
//! ## bash auto completion
//!
//! Auto-completion in Debian bash is a great tool. You type the first letters, press tab and the word is auto-completed.  
//! Bash can call an executable binary to return the available words. So it can be written in Rust. This can produce even better results as known as `dynamic auto-completion`.  
//! For my knowledge `cargo` does not have auto-completion yet. There are many plans. It can take some time.  
//! I will build what I need now. Something simple. It doesn't need to be perfect.  
//! This is a great blog:  
//! <https://www.joshmcguigan.com/blog/shell-completions-pure-rust/>
//!
//! ## complete, the Linux command
//!
//! The Linux command `complete` adds auto_completion definitions to bash.  
//! But it is only for the current session. If you want to make it persistent add it to the `~/.bashrc` file.  
//!
//! ```bash
//! # list the definitions
//! complete
//! # delete a definition
//! complete -r cargo
//! # define a binary to auto-complete the command
//! complete -C "binary" command
//! # for example
//! complete -C "dev_bestia_cargo_completion" cargo
//! ```
//!
//! ## Development details
//!
//! Read the development details in a separate md file:  
//! [DEVELOPMENT.md](https://codeberg.org/automation-tasks-rs/dev_bestia_cargo_completion/src/main/DEVELOPMENT.md)
//!
//! ## Releases changelog
//!
//! Read the changelog in a separate md file:  
//! [RELEASES.md](https://codeberg.org/automation-tasks-rs/dev_bestia_cargo_completion/src/main/RELEASES.md)
//!
//! ## TODO
//!
//! Nothing big in the near future.
//!
//! ## Open-source and free as a beer
//!
//! My open-source projects are free as a beer (MIT license).  
//! I just love programming.  
//! But I need also to drink. If you find my projects and tutorials helpful, please buy me a beer by donating to my [PayPal](https://paypal.me/LucianoBestia).  
//! You know the price of a beer in your local bar ;-)  
//! So I can drink a free beer for your health :-)  
//! [Na zdravje!](https://translate.google.com/?hl=en&sl=sl&tl=en&text=Na%20zdravje&op=translate) [Alla salute!](https://dictionary.cambridge.org/dictionary/italian-english/alla-salute) [Prost!](https://dictionary.cambridge.org/dictionary/german-english/prost) [Nazdravlje!](https://matadornetwork.com/nights/how-to-say-cheers-in-50-languages/) 🍻
//!
//! [//bestia.dev](https://bestia.dev)  
//! [//codeberg.org/bestia-dev](https://codeberg.org/bestia-dev)  
//! [//github.com/bestia-dev](https://github.com/bestia-dev)  
//! [//bestiadev.substack.com](https://bestiadev.substack.com)  
//! [//youtube.com/@bestia-dev-tutorials](https://youtube.com/@bestia-dev-tutorials)  
//!
// endregion: auto_md_to_doc_comments include README.md A //!

/// partial completion of the cargo command
/// first word after `cargo`
pub fn complete_cargo_partial(vec_comp_line_len: usize, word_being_completed: &str) {
    let sub_commands_after_cargo = vec!["auto", "build", "check", "new", "doc", "test", "fmt", "install"];
    for sub_command in sub_commands_after_cargo {
        // list all for `tab tab` or list only one starting with the word
        if vec_comp_line_len == 1 || sub_command.starts_with(word_being_completed) {
            println!("{}", sub_command);
        }
    }
}

/// partial completion of the cargo build command
/// first word after `cargo build`
pub fn complete_cargo_build_partial(vec_comp_line_len: usize, word_being_completed: &str) {
    let sub_commands = vec!["--release"];

    for sub_command in sub_commands {
        // list all for `tab tab` or list only one starting with the word
        if vec_comp_line_len == 2 || sub_command.starts_with(word_being_completed) {
            println!("{}", sub_command);
        }
    }
}

/// words after `cargo auto` execute the appropriate binary, that responds with println
/// 1st argument in "completion"
/// 2rd argument is the `word_being_completed`
/// 3nd argument is the `last_word`
pub fn complete_automation(word_being_completed: &str, last_word: &str) {
    let path_to_automation = "automation_tasks_rs/target/debug/automation_tasks_rs";
    if std::path::Path::new(path_to_automation).exists() {
        std::process::Command::new(path_to_automation)
            .arg("completion")
            .arg(word_being_completed)
            .arg(last_word)
            .spawn()
            .unwrap()
            .wait()
            .unwrap();
    }
}

/// words after `cargo auto` execute the appropriate binary, that responds with println
/// 1st argument in "completion"
/// 2rd argument is the `word_being_completed`
/// 3nd argument is the `last_word`
pub fn complete_cargo_auto(word_being_completed: &str, last_word: &str) {
    std::process::Command::new("cargo-auto")
        .arg("completion")
        .arg(word_being_completed)
        .arg(last_word)
        .spawn()
        .unwrap()
        .wait()
        .unwrap();
}