<!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.rs`."><title>cli.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>cli.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></pre></div><pre class="rust"><code><span class="doccomment">//! # cli
//!
//! The cargo-make cli
//!
</span><span class="attr">#[cfg(test)]
#[path = <span class="string">"cli_test.rs"</span>]
</span><span class="kw">mod </span>cli_test;
<span class="kw">use </span><span class="kw">crate</span>::cli_commands;
<span class="kw">use </span><span class="kw">crate</span>::cli_parser;
<span class="kw">use </span><span class="kw">crate</span>::config;
<span class="kw">use </span><span class="kw">crate</span>::descriptor;
<span class="kw">use </span><span class="kw">crate</span>::environment;
<span class="kw">use </span><span class="kw">crate</span>::error::CargoMakeError;
<span class="kw">use </span><span class="kw">crate</span>::logger;
<span class="kw">use </span><span class="kw">crate</span>::logger::LoggerOptions;
<span class="kw">use </span><span class="kw">crate</span>::profile;
<span class="kw">use </span><span class="kw">crate</span>::recursion_level;
<span class="kw">use </span><span class="kw">crate</span>::runner;
<span class="kw">use </span><span class="kw">crate</span>::time_summary;
<span class="kw">use </span><span class="kw">crate</span>::toolchain;
<span class="kw">use </span><span class="kw">crate</span>::types::{CliArgs, GlobalConfig};
<span class="kw">use </span><span class="kw">crate</span>::version;
<span class="kw">use </span>std::time::SystemTime;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>VERSION: <span class="kw-2">&</span>str = <span class="macro">env!</span>(<span class="string">"CARGO_PKG_VERSION"</span>);
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>AUTHOR: <span class="kw-2">&</span>str = <span class="macro">env!</span>(<span class="string">"CARGO_PKG_AUTHORS"</span>);
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>DESCRIPTION: <span class="kw-2">&</span>str = <span class="macro">env!</span>(<span class="string">"CARGO_PKG_DESCRIPTION"</span>);
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>DEFAULT_TOML: <span class="kw-2">&</span>str = <span class="string">"Makefile.toml"</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>DEFAULT_LOG_LEVEL: <span class="kw-2">&</span>str = <span class="string">"info"</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>DEFAULT_TASK_NAME: <span class="kw-2">&</span>str = <span class="string">"default"</span>;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">static </span>DEFAULT_OUTPUT_FORMAT: <span class="kw-2">&</span>str = <span class="string">"default"</span>;
<span class="kw">pub fn </span>run(
cli_args: <span class="kw-2">&</span>CliArgs,
global_config: <span class="kw-2">&</span>GlobalConfig,
logger_options: <span class="prelude-ty">Option</span><LoggerOptions>,
) -> <span class="prelude-ty">Result</span><(), CargoMakeError> {
<span class="kw">let </span>start_time = SystemTime::now();
recursion_level::increment();
logger::init(<span class="kw-2">&</span>logger_options.unwrap_or(LoggerOptions {
name: String::from(<span class="macro">env!</span>(<span class="string">"CARGO_PKG_NAME"</span>)),
level: cli_args.log_level.clone(),
color: !cli_args.disable_color,
}));
<span class="kw">if </span>recursion_level::is_top() {
<span class="macro">info!</span>(<span class="string">"{} {}"</span>, <span class="kw-2">&</span>cli_args.command, <span class="kw-2">&</span>VERSION);
<span class="macro">debug!</span>(<span class="string">"Written By {}"</span>, <span class="kw-2">&</span>AUTHOR);
}
<span class="macro">debug!</span>(<span class="string">"Cli Args {:#?}"</span>, <span class="kw-2">&</span>cli_args);
<span class="macro">debug!</span>(<span class="string">"Global Configuration {:#?}"</span>, <span class="kw-2">&</span>global_config);
<span class="kw">if </span>version::should_check(<span class="kw-2">&</span>cli_args, <span class="kw-2">&</span>global_config) {
version::check();
}
<span class="comment">// clear env vars (see https://github.com/rust-lang/rustup/issues/3029)
</span>toolchain::remove_rust_env_vars();
<span class="kw">let </span>cwd_string_option = <span class="kw">match </span>cli_args.cwd.clone() {
<span class="prelude-val">Some</span>(value) => <span class="prelude-val">Some</span>(value),
<span class="prelude-val">None </span>=> <span class="kw">match </span>global_config.search_project_root {
<span class="prelude-val">Some</span>(search) => {
<span class="kw">if </span>search {
<span class="kw">match </span>environment::get_project_root() {
<span class="prelude-val">Some</span>(value) => <span class="prelude-val">Some</span>(value.clone()),
<span class="prelude-val">None </span>=> <span class="prelude-val">None</span>,
}
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
<span class="prelude-val">None </span>=> <span class="prelude-val">None</span>,
},
};
<span class="kw">let </span>cwd = <span class="kw">match </span>cwd_string_option {
<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>value) => <span class="prelude-val">Some</span>(value.as_ref()),
<span class="prelude-val">None </span>=> <span class="prelude-val">None</span>,
};
<span class="kw">let </span>home = environment::setup_cwd(cwd);
<span class="kw">let </span>force_makefile = cli_args.build_file.is_some();
<span class="kw">let </span>build_file = <span class="kw-2">&</span>cli_args
.build_file
.clone()
.unwrap_or(DEFAULT_TOML.to_string());
<span class="kw">let </span>task = <span class="kw-2">&</span>cli_args.task;
<span class="kw">let </span>profile_name = <span class="kw-2">&</span>cli_args
.profile
.clone()
.unwrap_or_else(profile::default_profile);
<span class="kw">let </span>normalized_profile_name = profile::set(<span class="kw-2">&</span>profile_name);
environment::load_env_file(cli_args.env_file.clone());
<span class="kw">let </span>env = cli_args.env.clone();
<span class="kw">let </span>experimental = cli_args.experimental;
<span class="kw">let </span>config = descriptor::load(<span class="kw-2">&</span>build_file, force_makefile, env, experimental)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>time_summary_vec = <span class="macro">vec!</span>[];
time_summary::add(
<span class="kw-2">&mut </span>time_summary_vec,
<span class="string">"[Load Makefiles]"</span>,
start_time.clone(),
);
<span class="kw">let </span>step_time = SystemTime::now();
<span class="kw">match </span>config.config.additional_profiles {
<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>profiles) => profile::set_additional(profiles),
<span class="prelude-val">None </span>=> profile::set_additional(<span class="kw-2">&</span><span class="macro">vec!</span>[]),
};
<span class="kw">let </span>env_info = environment::setup_env(<span class="kw-2">&</span>cli_args, <span class="kw-2">&</span>config, <span class="kw-2">&</span>task, home, <span class="kw-2">&mut </span>time_summary_vec)<span class="question-mark">?</span>;
time_summary::add(<span class="kw-2">&mut </span>time_summary_vec, <span class="string">"[Setup Env]"</span>, step_time);
<span class="kw">let </span>crate_name = envmnt::get_or(<span class="string">"CARGO_MAKE_CRATE_NAME"</span>, <span class="string">""</span>);
<span class="macro">info!</span>(<span class="string">""</span>);
<span class="kw">if </span>crate_name.len() > <span class="number">0 </span>{
<span class="macro">info!</span>(<span class="string">"Project: {}"</span>, <span class="kw-2">&</span>crate_name);
}
<span class="macro">info!</span>(<span class="string">"Build File: {}"</span>, <span class="kw-2">&</span>build_file);
<span class="macro">info!</span>(<span class="string">"Task: {}"</span>, <span class="kw-2">&</span>task);
<span class="macro">info!</span>(<span class="string">"Profile: {}"</span>, <span class="kw-2">&</span>normalized_profile_name);
<span class="comment">// ensure profile env was not overridden
</span>profile::set(<span class="kw-2">&</span>normalized_profile_name);
<span class="kw">if </span>cli_args.list_all_steps || cli_args.list_category_steps.is_some() {
cli_commands::list_steps::run(
<span class="kw-2">&</span>config,
<span class="kw-2">&</span>cli_args.output_format,
<span class="kw-2">&</span>cli_args.output_file,
<span class="kw-2">&</span>cli_args.list_category_steps,
cli_args.hide_uninteresting,
)
} <span class="kw">else if </span>cli_args.diff_execution_plan {
<span class="kw">let </span>default_config = descriptor::load_internal_descriptors(<span class="bool-val">true</span>, experimental, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
cli_commands::diff_steps::run(
<span class="kw-2">&</span>default_config,
<span class="kw-2">&</span>config,
<span class="kw-2">&</span>task,
<span class="kw-2">&</span>cli_args,
<span class="kw-2">&</span>env_info.crate_info,
)
} <span class="kw">else if </span>cli_args.print_only {
cli_commands::print_steps::print(
<span class="kw-2">&mut </span>std::io::stdout(),
<span class="kw-2">&</span>config,
<span class="kw-2">&</span>task,
<span class="kw-2">&</span>cli_args.output_format,
cli_args.disable_workspace,
<span class="kw-2">&</span>cli_args.skip_tasks_pattern,
<span class="kw-2">&</span>env_info.crate_info,
cli_args.skip_init_end_tasks,
)
} <span class="kw">else </span>{
runner::run(
config,
<span class="kw-2">&</span>task,
env_info,
<span class="kw-2">&</span>cli_args,
start_time,
time_summary_vec,
)
}<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(())
}
<span class="doccomment">/// Handles the command line arguments and executes the runner.
</span><span class="kw">pub fn </span>run_cli(command_name: String, sub_command: bool) -> <span class="prelude-ty">Result</span><CliArgs, CargoMakeError> {
<span class="kw">let </span>global_config = config::load()<span class="question-mark">?</span>;
<span class="kw">let </span>cli_args = cli_parser::parse(<span class="kw-2">&</span>global_config, <span class="kw-2">&</span>command_name, sub_command)<span class="question-mark">?</span>;
run(<span class="kw-2">&</span>cli_args, <span class="kw-2">&</span>global_config, <span class="prelude-val">None</span>)<span class="question-mark">?</span>;
<span class="prelude-val">Ok</span>(cli_args)
}
</code></pre></div></section></main></body></html>