<!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/cli_commands/list_steps.rs`."><title>list_steps.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/cli_commands/</div>list_steps.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>
<a href="#113" id="113">113</a>
<a href="#114" id="114">114</a>
<a href="#115" id="115">115</a>
<a href="#116" id="116">116</a>
<a href="#117" id="117">117</a>
<a href="#118" id="118">118</a>
<a href="#119" id="119">119</a>
<a href="#120" id="120">120</a>
<a href="#121" id="121">121</a>
<a href="#122" id="122">122</a>
<a href="#123" id="123">123</a>
<a href="#124" id="124">124</a>
<a href="#125" id="125">125</a>
<a href="#126" id="126">126</a>
<a href="#127" id="127">127</a>
<a href="#128" id="128">128</a>
<a href="#129" id="129">129</a>
<a href="#130" id="130">130</a>
<a href="#131" id="131">131</a>
<a href="#132" id="132">132</a>
<a href="#133" id="133">133</a>
<a href="#134" id="134">134</a>
<a href="#135" id="135">135</a>
<a href="#136" id="136">136</a>
<a href="#137" id="137">137</a>
<a href="#138" id="138">138</a>
<a href="#139" id="139">139</a>
<a href="#140" id="140">140</a>
<a href="#141" id="141">141</a>
<a href="#142" id="142">142</a>
<a href="#143" id="143">143</a>
<a href="#144" id="144">144</a>
<a href="#145" id="145">145</a>
<a href="#146" id="146">146</a>
<a href="#147" id="147">147</a>
<a href="#148" id="148">148</a>
<a href="#149" id="149">149</a>
<a href="#150" id="150">150</a>
<a href="#151" id="151">151</a>
<a href="#152" id="152">152</a>
<a href="#153" id="153">153</a>
<a href="#154" id="154">154</a>
<a href="#155" id="155">155</a>
<a href="#156" id="156">156</a>
<a href="#157" id="157">157</a>
<a href="#158" id="158">158</a>
<a href="#159" id="159">159</a>
<a href="#160" id="160">160</a>
<a href="#161" id="161">161</a>
<a href="#162" id="162">162</a>
<a href="#163" id="163">163</a>
<a href="#164" id="164">164</a>
<a href="#165" id="165">165</a>
<a href="#166" id="166">166</a>
<a href="#167" id="167">167</a>
<a href="#168" id="168">168</a>
<a href="#169" id="169">169</a>
<a href="#170" id="170">170</a>
<a href="#171" id="171">171</a>
<a href="#172" id="172">172</a>
<a href="#173" id="173">173</a>
<a href="#174" id="174">174</a>
<a href="#175" id="175">175</a>
<a href="#176" id="176">176</a>
<a href="#177" id="177">177</a>
<a href="#178" id="178">178</a>
<a href="#179" id="179">179</a>
<a href="#180" id="180">180</a>
<a href="#181" id="181">181</a>
<a href="#182" id="182">182</a>
<a href="#183" id="183">183</a>
<a href="#184" id="184">184</a>
<a href="#185" id="185">185</a>
<a href="#186" id="186">186</a>
<a href="#187" id="187">187</a>
<a href="#188" id="188">188</a>
<a href="#189" id="189">189</a>
<a href="#190" id="190">190</a>
<a href="#191" id="191">191</a></pre></div><pre class="rust"><code><span class="doccomment">//! # list_steps
//!
//! Lists all known tasks in multiple formats.
//! Or can list tasks based on a category
//!
</span><span class="attr">#[cfg(test)]
#[path = <span class="string">"list_steps_test.rs"</span>]
</span><span class="kw">mod </span>list_steps_test;
<span class="kw">use </span><span class="kw">crate</span>::error::CargoMakeError;
<span class="kw">use </span><span class="kw">crate</span>::execution_plan;
<span class="kw">use </span><span class="kw">crate</span>::io;
<span class="kw">use </span><span class="kw">crate</span>::types::{Config, DeprecationInfo};
<span class="kw">use </span>std::collections::{BTreeMap, BTreeSet};
<span class="kw">pub fn </span>run(
config: <span class="kw-2">&</span>Config,
output_format: <span class="kw-2">&</span>str,
output_file: <span class="kw-2">&</span><span class="prelude-ty">Option</span><String>,
category: <span class="kw-2">&</span><span class="prelude-ty">Option</span><String>,
hide_uninteresting: bool,
) -> <span class="prelude-ty">Result</span><(), CargoMakeError> {
<span class="kw">let </span>output = create_list(<span class="kw-2">&</span>config, output_format, category, hide_uninteresting)<span class="question-mark">?</span>;
<span class="kw">match </span>output_file {
<span class="prelude-val">Some</span>(file) => {
io::write_text_file(<span class="kw-2">&</span>file, <span class="kw-2">&</span>output);
()
}
<span class="prelude-val">None </span>=> <span class="macro">print!</span>(<span class="string">"{}"</span>, output),
};
<span class="prelude-val">Ok</span>(())
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>create_list(
config: <span class="kw-2">&</span>Config,
output_format: <span class="kw-2">&</span>str,
category_filter: <span class="kw-2">&</span><span class="prelude-ty">Option</span><String>,
hide_uninteresting: bool,
) -> <span class="prelude-ty">Result</span><String, CargoMakeError> {
<span class="comment">// category -> actual_task -> description
</span><span class="kw">let </span><span class="kw-2">mut </span>categories: BTreeMap<String, BTreeMap<String, String>> = BTreeMap::new();
<span class="comment">// actual_task -> aliases
</span><span class="kw">let </span><span class="kw-2">mut </span>aliases: BTreeMap<String, BTreeSet<String>> = BTreeMap::new();
<span class="comment">// iterate over all tasks to build categories and aliases
</span><span class="kw">for </span>key <span class="kw">in </span>config.tasks.keys() {
<span class="kw">let </span>actual_task_name = execution_plan::get_actual_task_name(<span class="kw-2">&</span>config, <span class="kw-2">&</span>key)<span class="question-mark">?</span>;
<span class="kw">let </span>task = execution_plan::get_normalized_task(<span class="kw-2">&</span>config, <span class="kw-2">&</span>actual_task_name, <span class="bool-val">true</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>is_private = <span class="kw">match </span>task.private {
<span class="prelude-val">Some</span>(private) => private,
<span class="prelude-val">None </span>=> <span class="bool-val">false</span>,
};
<span class="kw">let </span>skip_task = <span class="kw">if </span>is_private {
<span class="bool-val">true
</span>} <span class="kw">else if </span>hide_uninteresting {
key.contains(<span class="string">"pre-"</span>)
|| key.contains(<span class="string">"post-"</span>)
|| key == <span class="string">"init"
</span>|| key == <span class="string">"end"
</span>|| key == <span class="string">"empty"
</span>} <span class="kw">else </span>{
<span class="bool-val">false
</span>};
<span class="kw">if </span>!skip_task {
<span class="kw">let </span>category = <span class="kw">match </span>task.category {
<span class="prelude-val">Some</span>(value) => value,
<span class="prelude-val">None </span>=> <span class="string">"No Category"</span>.to_string(),
};
<span class="kw">if </span>category_filter
.as_ref()
.map_or(<span class="bool-val">false</span>, |value| value != <span class="kw-2">&</span>category)
{
<span class="kw">continue</span>;
}
<span class="kw">if </span><span class="kw-2">&</span>actual_task_name != key {
aliases
.entry(actual_task_name)
.or_default()
.insert(key.clone());
<span class="kw">continue</span>;
}
<span class="kw">let </span>description = <span class="kw">match </span>task.description {
<span class="prelude-val">Some</span>(value) => value,
<span class="prelude-val">None </span>=> <span class="string">"No Description."</span>.to_string(),
};
<span class="kw">let </span>deprecated_message = <span class="kw">match </span>task.deprecated {
<span class="prelude-val">Some</span>(deprecated) => <span class="kw">match </span>deprecated {
DeprecationInfo::Boolean(value) => {
<span class="kw">if </span>value {
<span class="string">" (deprecated)"</span>.to_string()
} <span class="kw">else </span>{
<span class="string">""</span>.to_string()
}
}
DeprecationInfo::Message(<span class="kw-2">ref </span>message) => {
<span class="kw">let </span><span class="kw-2">mut </span>buffer = <span class="string">" (deprecated - "</span>.to_string();
buffer.push_str(message);
buffer.push_str(<span class="string">")"</span>);
buffer
}
},
<span class="prelude-val">None </span>=> <span class="string">""</span>.to_string(),
};
<span class="kw">let </span><span class="kw-2">mut </span>text = String::from(description);
text.push_str(<span class="kw-2">&</span>deprecated_message);
categories
.entry(category)
.or_default()
.insert(key.clone(), text);
}
}
<span class="comment">// build the task list output string
</span><span class="kw">let </span>single_page_markdown = output_format == <span class="string">"markdown-single-page"</span>;
<span class="kw">let </span>markdown = single_page_markdown
|| output_format == <span class="string">"markdown"
</span>|| output_format == <span class="string">"markdown-sub-section"</span>;
<span class="kw">let </span>just_task_name = output_format == <span class="string">"autocomplete"</span>;
<span class="kw">let </span><span class="kw-2">mut </span>buffer = String::new();
<span class="kw">if </span>single_page_markdown {
buffer.push_str(<span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"# Task List\n\n"</span>));
}
<span class="kw">let </span>post_key = <span class="kw">if </span>markdown { <span class="string">"**" </span>} <span class="kw">else </span>{ <span class="string">"" </span>};
<span class="kw">for </span>(category, tasks) <span class="kw">in </span><span class="kw-2">&</span>categories {
<span class="kw">if </span>category_filter
.as_ref()
.map_or(<span class="bool-val">false</span>, |value| value != category)
{
<span class="kw">continue</span>;
}
<span class="kw">if </span>!just_task_name {
<span class="kw">if </span>single_page_markdown {
buffer.push_str(<span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"## {}\n\n"</span>, category));
} <span class="kw">else if </span>markdown {
buffer.push_str(<span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"#### {}\n\n"</span>, category));
} <span class="kw">else </span>{
buffer.push_str(<span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{}\n----------\n"</span>, category));
}
}
<span class="kw">for </span>(key, description) <span class="kw">in </span>tasks {
<span class="kw">if </span>markdown {
buffer.push_str(<span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"* **"</span>));
}
<span class="kw">let </span>aliases = <span class="kw">if let </span><span class="prelude-val">Some</span>(aliases) = aliases.remove(key) {
<span class="kw">if </span>just_task_name {
aliases.into_iter().collect::<Vec<String>>().join(<span class="string">" "</span>)
} <span class="kw">else </span>{
<span class="macro">format!</span>(
<span class="string">" [aliases: {}]"</span>,
aliases.into_iter().collect::<Vec<String>>().join(<span class="string">", "</span>)
)
}
} <span class="kw">else </span>{
<span class="string">""</span>.to_string()
};
<span class="kw">if </span>just_task_name {
buffer.push_str(<span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">"{} {} "</span>, <span class="kw-2">&</span>key, aliases));
} <span class="kw">else </span>{
buffer.push_str(<span class="kw-2">&</span><span class="macro">format!</span>(
<span class="string">"{}{} - {}{}\n"</span>,
<span class="kw-2">&</span>key, <span class="kw-2">&</span>post_key, <span class="kw-2">&</span>description, aliases
));
}
}
<span class="kw">if </span>!just_task_name {
buffer.push(<span class="string">'\n'</span>);
}
}
<span class="prelude-val">Ok</span>(buffer)
}
</code></pre></div></section></main></body></html>