<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/lib/completion.rs`."><title>completion.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-c579a84d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="cli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.86.0-nightly (6067b3631 2025-01-17)" data-channel="nightly" data-search-js="search-ccb196c1.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../../static.files/src-script-56102188.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">cli/</div>completion.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers">
<a href="#1" id="1">1</a>
<a href="#2" id="2">2</a>
<a href="#3" id="3">3</a>
<a href="#4" id="4">4</a>
<a href="#5" id="5">5</a>
<a href="#6" id="6">6</a>
<a href="#7" id="7">7</a>
<a href="#8" id="8">8</a>
<a href="#9" id="9">9</a>
<a href="#10" id="10">10</a>
<a href="#11" id="11">11</a>
<a href="#12" id="12">12</a>
<a href="#13" id="13">13</a>
<a href="#14" id="14">14</a>
<a href="#15" id="15">15</a>
<a href="#16" id="16">16</a>
<a href="#17" id="17">17</a>
<a href="#18" id="18">18</a>
<a href="#19" id="19">19</a>
<a href="#20" id="20">20</a>
<a href="#21" id="21">21</a>
<a href="#22" id="22">22</a>
<a href="#23" id="23">23</a>
<a href="#24" id="24">24</a>
<a href="#25" id="25">25</a>
<a href="#26" id="26">26</a>
<a href="#27" id="27">27</a>
<a href="#28" id="28">28</a>
<a href="#29" id="29">29</a>
<a href="#30" id="30">30</a>
<a href="#31" id="31">31</a>
<a href="#32" id="32">32</a>
<a href="#33" id="33">33</a>
<a href="#34" id="34">34</a>
<a href="#35" id="35">35</a>
<a href="#36" id="36">36</a>
<a href="#37" id="37">37</a>
<a href="#38" id="38">38</a>
<a href="#39" id="39">39</a>
<a href="#40" id="40">40</a>
<a href="#41" id="41">41</a>
<a href="#42" id="42">42</a>
<a href="#43" id="43">43</a>
<a href="#44" id="44">44</a>
<a href="#45" id="45">45</a>
<a href="#46" id="46">46</a>
<a href="#47" id="47">47</a>
<a href="#48" id="48">48</a>
<a href="#49" id="49">49</a>
<a href="#50" id="50">50</a>
<a href="#51" id="51">51</a>
<a href="#52" id="52">52</a>
<a href="#53" id="53">53</a>
<a href="#54" id="54">54</a>
<a href="#55" id="55">55</a>
<a href="#56" id="56">56</a>
<a href="#57" id="57">57</a>
<a href="#58" id="58">58</a>
<a href="#59" id="59">59</a>
<a href="#60" id="60">60</a>
<a href="#61" id="61">61</a>
<a href="#62" id="62">62</a>
<a href="#63" id="63">63</a>
<a href="#64" id="64">64</a>
<a href="#65" id="65">65</a>
<a href="#66" id="66">66</a>
<a href="#67" id="67">67</a>
<a href="#68" id="68">68</a>
<a href="#69" id="69">69</a>
<a href="#70" id="70">70</a>
<a href="#71" id="71">71</a>
<a href="#72" id="72">72</a>
<a href="#73" id="73">73</a>
<a href="#74" id="74">74</a>
<a href="#75" id="75">75</a>
<a href="#76" id="76">76</a>
<a href="#77" id="77">77</a>
<a href="#78" id="78">78</a>
<a href="#79" id="79">79</a>
<a href="#80" id="80">80</a>
<a href="#81" id="81">81</a>
<a href="#82" id="82">82</a>
<a href="#83" id="83">83</a>
<a href="#84" id="84">84</a>
<a href="#85" id="85">85</a>
<a href="#86" id="86">86</a>
<a href="#87" id="87">87</a>
<a href="#88" id="88">88</a>
<a href="#89" id="89">89</a>
<a href="#90" id="90">90</a>
<a href="#91" id="91">91</a>
<a href="#92" id="92">92</a>
<a href="#93" id="93">93</a>
<a href="#94" id="94">94</a>
<a href="#95" id="95">95</a>
<a href="#96" id="96">96</a>
<a href="#97" id="97">97</a>
<a href="#98" id="98">98</a>
<a href="#99" id="99">99</a>
<a href="#100" id="100">100</a>
<a href="#101" id="101">101</a>
<a href="#102" id="102">102</a>
<a href="#103" id="103">103</a>
<a href="#104" id="104">104</a>
<a href="#105" id="105">105</a>
<a href="#106" id="106">106</a>
<a href="#107" id="107">107</a>
<a href="#108" id="108">108</a>
<a href="#109" id="109">109</a>
<a href="#110" id="110">110</a>
<a href="#111" id="111">111</a>
<a href="#112" id="112">112</a></pre></div><pre class="rust"><code><span class="kw">use </span>log::{error, info};
<span class="kw">use </span>std::io::BufRead;
<span class="kw">use </span>std::path::Path;
<span class="kw">use </span>std::{fs, io};
<span class="doccomment">/// # Completions Module
///
/// This module handles the generation of shell completion scripts for the `cargo-make` tool.
///
/// ## Functionality
/// - `generate_completion_zsh`: Generates a Zsh completion script, creates the necessary directory,
/// and prompts for overwriting existing files.
///
/// ## Improvements to Consider
/// 1. **Modularity**: Separate the completion logic into different modules for different shells
/// (e.g., Zsh, Bash, Fish) to improve code organization.
/// 2. **Cross-Platform Support**: Abstract the completion generation into a trait or interface
/// to facilitate adding support for other shell types.
/// 3. **Enhanced Error Handling**: Provide more informative error messages for file operations.
/// 4. **User Input Handling**: Ensure user input is trimmed and handled correctly.
/// 5. **Testing**: Implement unit tests to verify the correct behavior of completion generation functions.
</span><span class="attr">#[cfg(test)]
#[path = <span class="string">"completion_test.rs"</span>]
</span><span class="kw">mod </span>completion_test;
<span class="kw">pub fn </span>generate_completions(shell: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><(), Box<<span class="kw">dyn </span>std::error::Error>> {
<span class="kw">match </span>shell {
<span class="string">"zsh" </span>=> {
generate_completion_zsh(<span class="prelude-val">None</span>)<span class="question-mark">?</span>; <span class="comment">// Use the `?` operator to propagate errors
</span><span class="prelude-val">Ok</span>(()) <span class="comment">// Return Ok if no error occurred
</span>}
<span class="kw">_ </span>=> {
<span class="comment">// Return an error for unsupported shell
</span><span class="prelude-val">Err</span>(Box::from(<span class="macro">format!</span>(
<span class="string">"Unsupported shell for completion: {}"</span>,
shell
)))
}
}
}
<span class="comment">// Modify the function to accept an optional input stream
</span><span class="kw">fn </span>generate_completion_zsh(
input: <span class="prelude-ty">Option</span><<span class="kw-2">&mut </span><span class="kw">dyn </span>io::Read>,
) -> <span class="prelude-ty">Result</span><(), Box<<span class="kw">dyn </span>std::error::Error>> {
<span class="kw">let </span>home_dir = std::env::var(<span class="string">"HOME"</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>zfunc_dir = <span class="macro">format!</span>(<span class="string">"{}/.zfunc"</span>, home_dir);
<span class="kw">let </span>completion_file = <span class="macro">format!</span>(<span class="string">"{}/_cargo-make"</span>, zfunc_dir);
<span class="kw">if </span>!Path::new(<span class="kw-2">&</span>zfunc_dir).exists() {
<span class="kw">if let </span><span class="prelude-val">Err</span>(e) = fs::create_dir_all(<span class="kw-2">&</span>zfunc_dir) {
<span class="macro">error!</span>(<span class="string">"Failed to create directory {}: {}"</span>, zfunc_dir, e);
<span class="kw">return </span><span class="prelude-val">Err</span>(Box::new(e));
}
<span class="macro">info!</span>(<span class="string">"Created directory: {}"</span>, zfunc_dir);
}
<span class="kw">if </span>Path::new(<span class="kw-2">&</span>completion_file).exists() {
<span class="kw">let </span><span class="kw-2">mut </span>input_str = String::new();
<span class="kw">let </span>reader: Box<<span class="kw">dyn </span>io::Read> = <span class="kw">match </span>input {
<span class="prelude-val">Some</span>(input) => Box::new(input),
<span class="prelude-val">None </span>=> Box::new(io::stdin()),
};
<span class="comment">// Create a BufReader to read from the provided input or stdin
</span><span class="kw">let </span><span class="kw-2">mut </span>buf_reader = io::BufReader::new(reader);
<span class="macro">println!</span>(
<span class="string">"File {} already exists. Overwrite? (y/n): "</span>,
completion_file
);
buf_reader.read_line(<span class="kw-2">&mut </span>input_str)<span class="question-mark">?</span>;
<span class="kw">if </span>input_str.trim().to_lowercase() != <span class="string">"y" </span>{
<span class="macro">println!</span>(<span class="string">"Aborted overwriting the file."</span>);
<span class="kw">return </span><span class="prelude-val">Ok</span>(());
}
}
<span class="kw">let </span>completion_script = <span class="string">r#"
#compdef cargo make cargo-make
_cargo_make() {
local tasks
local makefile="Makefile.toml"
if [[ ! -f $makefile ]]; then
return 1
fi
tasks=($(awk -F'[\\[\\.\\]]' '/^\[tasks/ {print $3}' "$makefile"))
if [[ ${#tasks[@]} -eq 0 ]]; then
return 1
fi
_describe -t tasks 'cargo-make tasks' tasks
}
_cargo_make "$@"
"#</span>;
fs::write(<span class="kw-2">&</span>completion_file, completion_script)<span class="question-mark">?</span>;
<span class="macro">println!</span>(<span class="string">"\nWrote tasks completion script to: {}"</span>, completion_file);
<span class="macro">println!</span>(<span class="string">"To enable Zsh completion, add the following lines to your ~/.zshrc:\n"</span>);
<span class="macro">println!</span>(<span class="string">" fpath=(~/.zfunc $fpath)"</span>);
<span class="macro">println!</span>(<span class="string">" autoload -Uz compinit && compinit"</span>);
<span class="macro">println!</span>(<span class="string">"\nThen, restart your terminal or run 'source ~/.zshrc'."</span>);
<span class="prelude-val">Ok</span>(())
}
</code></pre></div></section></main></body></html>