| <!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 `crates/rust-analyzer/src/flycheck.rs`."><title>flycheck.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.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"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-77263533.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rust_analyzer" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.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" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rust_analyzer/</div>flycheck.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-4"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Flycheck provides the functionality needed to run `cargo check` to provide |
| <a href=#2 id=2 data-nosnippet>2</a>//! LSP diagnostics based on the output of the command. |
| <a href=#3 id=3 data-nosnippet>3</a> |
| <a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">use </span>std::{ |
| <a href=#5 id=5 data-nosnippet>5</a> fmt, io, |
| <a href=#6 id=6 data-nosnippet>6</a> process::Command, |
| <a href=#7 id=7 data-nosnippet>7</a> sync::atomic::{AtomicUsize, Ordering}, |
| <a href=#8 id=8 data-nosnippet>8</a> time::Duration, |
| <a href=#9 id=9 data-nosnippet>9</a>}; |
| <a href=#10 id=10 data-nosnippet>10</a> |
| <a href=#11 id=11 data-nosnippet>11</a><span class="kw">use </span>cargo_metadata::PackageId; |
| <a href=#12 id=12 data-nosnippet>12</a><span class="kw">use </span>crossbeam_channel::{Receiver, Sender, select_biased, unbounded}; |
| <a href=#13 id=13 data-nosnippet>13</a><span class="kw">use </span>ide_db::FxHashSet; |
| <a href=#14 id=14 data-nosnippet>14</a><span class="kw">use </span>itertools::Itertools; |
| <a href=#15 id=15 data-nosnippet>15</a><span class="kw">use </span>paths::{AbsPath, AbsPathBuf, Utf8Path, Utf8PathBuf}; |
| <a href=#16 id=16 data-nosnippet>16</a><span class="kw">use </span>project_model::TargetDirectoryConfig; |
| <a href=#17 id=17 data-nosnippet>17</a><span class="kw">use </span>project_model::project_json; |
| <a href=#18 id=18 data-nosnippet>18</a><span class="kw">use </span>rustc_hash::FxHashMap; |
| <a href=#19 id=19 data-nosnippet>19</a><span class="kw">use </span>serde::Deserialize <span class="kw">as _</span>; |
| <a href=#20 id=20 data-nosnippet>20</a><span class="kw">use </span>serde_derive::Deserialize; |
| <a href=#21 id=21 data-nosnippet>21</a> |
| <a href=#22 id=22 data-nosnippet>22</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>cargo_metadata::diagnostic::{ |
| <a href=#23 id=23 data-nosnippet>23</a> Applicability, Diagnostic, DiagnosticCode, DiagnosticLevel, DiagnosticSpan, |
| <a href=#24 id=24 data-nosnippet>24</a>}; |
| <a href=#25 id=25 data-nosnippet>25</a><span class="kw">use </span>toolchain::Tool; |
| <a href=#26 id=26 data-nosnippet>26</a><span class="kw">use </span>triomphe::Arc; |
| <a href=#27 id=27 data-nosnippet>27</a> |
| <a href=#28 id=28 data-nosnippet>28</a><span class="kw">use </span>crate::{ |
| <a href=#29 id=29 data-nosnippet>29</a> command::{CommandHandle, JsonLinesParser}, |
| <a href=#30 id=30 data-nosnippet>30</a> diagnostics::DiagnosticsGeneration, |
| <a href=#31 id=31 data-nosnippet>31</a>}; |
| <a href=#32 id=32 data-nosnippet>32</a> |
| <a href=#33 id=33 data-nosnippet>33</a><span class="attr">#[derive(Clone, Debug, Default, PartialEq, Eq)] |
| <a href=#34 id=34 data-nosnippet>34</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>InvocationStrategy { |
| <a href=#35 id=35 data-nosnippet>35</a> Once, |
| <a href=#36 id=36 data-nosnippet>36</a> <span class="attr">#[default] |
| <a href=#37 id=37 data-nosnippet>37</a> </span>PerWorkspace, |
| <a href=#38 id=38 data-nosnippet>38</a>} |
| <a href=#39 id=39 data-nosnippet>39</a> |
| <a href=#40 id=40 data-nosnippet>40</a><span class="doccomment">/// Data needed to construct a `cargo` command invocation, e.g. for flycheck or running a test. |
| <a href=#41 id=41 data-nosnippet>41</a></span><span class="attr">#[derive(Clone, Debug, PartialEq, Eq)] |
| <a href=#42 id=42 data-nosnippet>42</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>CargoOptions { |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="doccomment">/// The cargo subcommand to run, e.g. "check" or "clippy" |
| <a href=#44 id=44 data-nosnippet>44</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) subcommand: String, |
| <a href=#45 id=45 data-nosnippet>45</a> <span class="kw">pub</span>(<span class="kw">crate</span>) target_tuples: Vec<String>, |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">pub</span>(<span class="kw">crate</span>) all_targets: bool, |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="kw">pub</span>(<span class="kw">crate</span>) set_test: bool, |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="kw">pub</span>(<span class="kw">crate</span>) no_default_features: bool, |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="kw">pub</span>(<span class="kw">crate</span>) all_features: bool, |
| <a href=#50 id=50 data-nosnippet>50</a> <span class="kw">pub</span>(<span class="kw">crate</span>) features: Vec<String>, |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="kw">pub</span>(<span class="kw">crate</span>) extra_args: Vec<String>, |
| <a href=#52 id=52 data-nosnippet>52</a> <span class="kw">pub</span>(<span class="kw">crate</span>) extra_test_bin_args: Vec<String>, |
| <a href=#53 id=53 data-nosnippet>53</a> <span class="kw">pub</span>(<span class="kw">crate</span>) extra_env: FxHashMap<String, <span class="prelude-ty">Option</span><String>>, |
| <a href=#54 id=54 data-nosnippet>54</a> <span class="kw">pub</span>(<span class="kw">crate</span>) target_dir_config: TargetDirectoryConfig, |
| <a href=#55 id=55 data-nosnippet>55</a>} |
| <a href=#56 id=56 data-nosnippet>56</a> |
| <a href=#57 id=57 data-nosnippet>57</a><span class="attr">#[derive(Clone, Debug)] |
| <a href=#58 id=58 data-nosnippet>58</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>Target { |
| <a href=#59 id=59 data-nosnippet>59</a> Bin(String), |
| <a href=#60 id=60 data-nosnippet>60</a> Example(String), |
| <a href=#61 id=61 data-nosnippet>61</a> Benchmark(String), |
| <a href=#62 id=62 data-nosnippet>62</a> Test(String), |
| <a href=#63 id=63 data-nosnippet>63</a>} |
| <a href=#64 id=64 data-nosnippet>64</a> |
| <a href=#65 id=65 data-nosnippet>65</a><span class="kw">impl </span>CargoOptions { |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>apply_on_command(<span class="kw-2">&</span><span class="self">self</span>, cmd: <span class="kw-2">&mut </span>Command, ws_target_dir: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>Utf8Path>) { |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="kw">for </span>target <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.target_tuples { |
| <a href=#68 id=68 data-nosnippet>68</a> cmd.args([<span class="string">"--target"</span>, target.as_str()]); |
| <a href=#69 id=69 data-nosnippet>69</a> } |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="kw">if </span><span class="self">self</span>.all_targets { |
| <a href=#71 id=71 data-nosnippet>71</a> <span class="kw">if </span><span class="self">self</span>.set_test { |
| <a href=#72 id=72 data-nosnippet>72</a> cmd.arg(<span class="string">"--all-targets"</span>); |
| <a href=#73 id=73 data-nosnippet>73</a> } <span class="kw">else </span>{ |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="comment">// No --benches unfortunately, as this implies --tests (see https://github.com/rust-lang/cargo/issues/6454), |
| <a href=#75 id=75 data-nosnippet>75</a> // and users setting `cfg.seTest = false` probably prefer disabling benches than enabling tests. |
| <a href=#76 id=76 data-nosnippet>76</a> </span>cmd.args([<span class="string">"--lib"</span>, <span class="string">"--bins"</span>, <span class="string">"--examples"</span>]); |
| <a href=#77 id=77 data-nosnippet>77</a> } |
| <a href=#78 id=78 data-nosnippet>78</a> } |
| <a href=#79 id=79 data-nosnippet>79</a> <span class="kw">if </span><span class="self">self</span>.all_features { |
| <a href=#80 id=80 data-nosnippet>80</a> cmd.arg(<span class="string">"--all-features"</span>); |
| <a href=#81 id=81 data-nosnippet>81</a> } <span class="kw">else </span>{ |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="kw">if </span><span class="self">self</span>.no_default_features { |
| <a href=#83 id=83 data-nosnippet>83</a> cmd.arg(<span class="string">"--no-default-features"</span>); |
| <a href=#84 id=84 data-nosnippet>84</a> } |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="kw">if </span>!<span class="self">self</span>.features.is_empty() { |
| <a href=#86 id=86 data-nosnippet>86</a> cmd.arg(<span class="string">"--features"</span>); |
| <a href=#87 id=87 data-nosnippet>87</a> cmd.arg(<span class="self">self</span>.features.join(<span class="string">" "</span>)); |
| <a href=#88 id=88 data-nosnippet>88</a> } |
| <a href=#89 id=89 data-nosnippet>89</a> } |
| <a href=#90 id=90 data-nosnippet>90</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(target_dir) = <span class="self">self</span>.target_dir_config.target_dir(ws_target_dir) { |
| <a href=#91 id=91 data-nosnippet>91</a> cmd.arg(<span class="string">"--target-dir"</span>).arg(target_dir.as_ref()); |
| <a href=#92 id=92 data-nosnippet>92</a> } |
| <a href=#93 id=93 data-nosnippet>93</a> } |
| <a href=#94 id=94 data-nosnippet>94</a>} |
| <a href=#95 id=95 data-nosnippet>95</a> |
| <a href=#96 id=96 data-nosnippet>96</a><span class="doccomment">/// The flycheck config from a rust-project.json file or discoverConfig JSON output. |
| <a href=#97 id=97 data-nosnippet>97</a></span><span class="attr">#[derive(Debug, Default)] |
| <a href=#98 id=98 data-nosnippet>98</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>FlycheckConfigJson { |
| <a href=#99 id=99 data-nosnippet>99</a> <span class="doccomment">/// The template with [project_json::RunnableKind::Flycheck] |
| <a href=#100 id=100 data-nosnippet>100</a> </span><span class="kw">pub </span>single_template: <span class="prelude-ty">Option</span><project_json::Runnable>, |
| <a href=#101 id=101 data-nosnippet>101</a>} |
| <a href=#102 id=102 data-nosnippet>102</a> |
| <a href=#103 id=103 data-nosnippet>103</a><span class="kw">impl </span>FlycheckConfigJson { |
| <a href=#104 id=104 data-nosnippet>104</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>any_configured(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="comment">// self.workspace_template.is_some() || |
| <a href=#106 id=106 data-nosnippet>106</a> </span><span class="self">self</span>.single_template.is_some() |
| <a href=#107 id=107 data-nosnippet>107</a> } |
| <a href=#108 id=108 data-nosnippet>108</a>} |
| <a href=#109 id=109 data-nosnippet>109</a> |
| <a href=#110 id=110 data-nosnippet>110</a><span class="doccomment">/// The flycheck config from rust-analyzer's own configuration. |
| <a href=#111 id=111 data-nosnippet>111</a>/// |
| <a href=#112 id=112 data-nosnippet>112</a>/// We rely on this when rust-project.json does not specify a flycheck runnable |
| <a href=#113 id=113 data-nosnippet>113</a>/// |
| <a href=#114 id=114 data-nosnippet>114</a></span><span class="attr">#[derive(Clone, Debug, PartialEq, Eq)] |
| <a href=#115 id=115 data-nosnippet>115</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>FlycheckConfig { |
| <a href=#116 id=116 data-nosnippet>116</a> <span class="doccomment">/// Automatically use rust-project.json's flycheck runnable or just use cargo (the common case) |
| <a href=#117 id=117 data-nosnippet>117</a> /// |
| <a href=#118 id=118 data-nosnippet>118</a> /// We can't have a variant for ProjectJson because that is configured on the fly during |
| <a href=#119 id=119 data-nosnippet>119</a> /// discoverConfig. We only know what we can read at config time. |
| <a href=#120 id=120 data-nosnippet>120</a> </span>Automatic { |
| <a href=#121 id=121 data-nosnippet>121</a> <span class="doccomment">/// If we do use cargo, how to build the check command |
| <a href=#122 id=122 data-nosnippet>122</a> </span>cargo_options: CargoOptions, |
| <a href=#123 id=123 data-nosnippet>123</a> ansi_color_output: bool, |
| <a href=#124 id=124 data-nosnippet>124</a> }, |
| <a href=#125 id=125 data-nosnippet>125</a> <span class="doccomment">/// check_overrideCommand. This overrides both cargo and rust-project.json's flycheck runnable. |
| <a href=#126 id=126 data-nosnippet>126</a> </span>CustomCommand { |
| <a href=#127 id=127 data-nosnippet>127</a> command: String, |
| <a href=#128 id=128 data-nosnippet>128</a> args: Vec<String>, |
| <a href=#129 id=129 data-nosnippet>129</a> extra_env: FxHashMap<String, <span class="prelude-ty">Option</span><String>>, |
| <a href=#130 id=130 data-nosnippet>130</a> invocation_strategy: InvocationStrategy, |
| <a href=#131 id=131 data-nosnippet>131</a> }, |
| <a href=#132 id=132 data-nosnippet>132</a>} |
| <a href=#133 id=133 data-nosnippet>133</a> |
| <a href=#134 id=134 data-nosnippet>134</a><span class="kw">impl </span>FlycheckConfig { |
| <a href=#135 id=135 data-nosnippet>135</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>invocation_strategy(<span class="kw-2">&</span><span class="self">self</span>) -> InvocationStrategy { |
| <a href=#136 id=136 data-nosnippet>136</a> <span class="kw">match </span><span class="self">self </span>{ |
| <a href=#137 id=137 data-nosnippet>137</a> FlycheckConfig::Automatic { .. } => InvocationStrategy::PerWorkspace, |
| <a href=#138 id=138 data-nosnippet>138</a> FlycheckConfig::CustomCommand { invocation_strategy, .. } => { |
| <a href=#139 id=139 data-nosnippet>139</a> invocation_strategy.clone() |
| <a href=#140 id=140 data-nosnippet>140</a> } |
| <a href=#141 id=141 data-nosnippet>141</a> } |
| <a href=#142 id=142 data-nosnippet>142</a> } |
| <a href=#143 id=143 data-nosnippet>143</a>} |
| <a href=#144 id=144 data-nosnippet>144</a> |
| <a href=#145 id=145 data-nosnippet>145</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>FlycheckConfig { |
| <a href=#146 id=146 data-nosnippet>146</a> <span class="doccomment">/// Show a shortened version of the check command. |
| <a href=#147 id=147 data-nosnippet>147</a> </span><span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <a href=#148 id=148 data-nosnippet>148</a> <span class="kw">match </span><span class="self">self </span>{ |
| <a href=#149 id=149 data-nosnippet>149</a> FlycheckConfig::Automatic { cargo_options, .. } => { |
| <a href=#150 id=150 data-nosnippet>150</a> <span class="macro">write!</span>(f, <span class="string">"cargo {}"</span>, cargo_options.subcommand) |
| <a href=#151 id=151 data-nosnippet>151</a> } |
| <a href=#152 id=152 data-nosnippet>152</a> FlycheckConfig::CustomCommand { command, args, .. } => { |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="comment">// Don't show `my_custom_check --foo $saved_file` literally to the user, as it |
| <a href=#154 id=154 data-nosnippet>154</a> // looks like we've forgotten to substitute $saved_file. |
| <a href=#155 id=155 data-nosnippet>155</a> // |
| <a href=#156 id=156 data-nosnippet>156</a> // `my_custom_check --foo /home/user/project/src/dir/foo.rs` is too verbose. |
| <a href=#157 id=157 data-nosnippet>157</a> // |
| <a href=#158 id=158 data-nosnippet>158</a> // Instead, show `my_custom_check --foo ...`. The |
| <a href=#159 id=159 data-nosnippet>159</a> // actual path is often too long to be worth showing |
| <a href=#160 id=160 data-nosnippet>160</a> // in the IDE (e.g. in the VS Code status bar). |
| <a href=#161 id=161 data-nosnippet>161</a> </span><span class="kw">let </span>display_args = args |
| <a href=#162 id=162 data-nosnippet>162</a> .iter() |
| <a href=#163 id=163 data-nosnippet>163</a> .map(|arg| { |
| <a href=#164 id=164 data-nosnippet>164</a> <span class="kw">if </span>(arg == SAVED_FILE_PLACEHOLDER_DOLLAR) |
| <a href=#165 id=165 data-nosnippet>165</a> || (arg == SAVED_FILE_INLINE) |
| <a href=#166 id=166 data-nosnippet>166</a> || arg.ends_with(<span class="string">".rs"</span>) |
| <a href=#167 id=167 data-nosnippet>167</a> { |
| <a href=#168 id=168 data-nosnippet>168</a> <span class="string">"..." |
| <a href=#169 id=169 data-nosnippet>169</a> </span>} <span class="kw">else </span>{ |
| <a href=#170 id=170 data-nosnippet>170</a> arg |
| <a href=#171 id=171 data-nosnippet>171</a> } |
| <a href=#172 id=172 data-nosnippet>172</a> }) |
| <a href=#173 id=173 data-nosnippet>173</a> .collect::<Vec<<span class="kw">_</span>>>(); |
| <a href=#174 id=174 data-nosnippet>174</a> |
| <a href=#175 id=175 data-nosnippet>175</a> <span class="macro">write!</span>(f, <span class="string">"{command} {}"</span>, display_args.join(<span class="string">" "</span>)) |
| <a href=#176 id=176 data-nosnippet>176</a> } |
| <a href=#177 id=177 data-nosnippet>177</a> } |
| <a href=#178 id=178 data-nosnippet>178</a> } |
| <a href=#179 id=179 data-nosnippet>179</a>} |
| <a href=#180 id=180 data-nosnippet>180</a> |
| <a href=#181 id=181 data-nosnippet>181</a><span class="doccomment">/// Flycheck wraps the shared state and communication machinery used for |
| <a href=#182 id=182 data-nosnippet>182</a>/// running `cargo check` (or other compatible command) and providing |
| <a href=#183 id=183 data-nosnippet>183</a>/// diagnostics based on the output. |
| <a href=#184 id=184 data-nosnippet>184</a>/// The spawned thread is shut down when this struct is dropped. |
| <a href=#185 id=185 data-nosnippet>185</a></span><span class="attr">#[derive(Debug)] |
| <a href=#186 id=186 data-nosnippet>186</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>FlycheckHandle { |
| <a href=#187 id=187 data-nosnippet>187</a> <span class="comment">// XXX: drop order is significant |
| <a href=#188 id=188 data-nosnippet>188</a> </span>sender: Sender<StateChange>, |
| <a href=#189 id=189 data-nosnippet>189</a> _thread: stdx::thread::JoinHandle, |
| <a href=#190 id=190 data-nosnippet>190</a> id: usize, |
| <a href=#191 id=191 data-nosnippet>191</a> generation: Arc<AtomicUsize>, |
| <a href=#192 id=192 data-nosnippet>192</a>} |
| <a href=#193 id=193 data-nosnippet>193</a> |
| <a href=#194 id=194 data-nosnippet>194</a><span class="kw">impl </span>FlycheckHandle { |
| <a href=#195 id=195 data-nosnippet>195</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>spawn( |
| <a href=#196 id=196 data-nosnippet>196</a> id: usize, |
| <a href=#197 id=197 data-nosnippet>197</a> generation: Arc<AtomicUsize>, |
| <a href=#198 id=198 data-nosnippet>198</a> sender: Sender<FlycheckMessage>, |
| <a href=#199 id=199 data-nosnippet>199</a> config: FlycheckConfig, |
| <a href=#200 id=200 data-nosnippet>200</a> config_json: FlycheckConfigJson, |
| <a href=#201 id=201 data-nosnippet>201</a> sysroot_root: <span class="prelude-ty">Option</span><AbsPathBuf>, |
| <a href=#202 id=202 data-nosnippet>202</a> workspace_root: AbsPathBuf, |
| <a href=#203 id=203 data-nosnippet>203</a> manifest_path: <span class="prelude-ty">Option</span><AbsPathBuf>, |
| <a href=#204 id=204 data-nosnippet>204</a> ws_target_dir: <span class="prelude-ty">Option</span><Utf8PathBuf>, |
| <a href=#205 id=205 data-nosnippet>205</a> ) -> FlycheckHandle { |
| <a href=#206 id=206 data-nosnippet>206</a> <span class="kw">let </span>actor = FlycheckActor::new( |
| <a href=#207 id=207 data-nosnippet>207</a> id, |
| <a href=#208 id=208 data-nosnippet>208</a> generation.load(Ordering::Relaxed), |
| <a href=#209 id=209 data-nosnippet>209</a> sender, |
| <a href=#210 id=210 data-nosnippet>210</a> config, |
| <a href=#211 id=211 data-nosnippet>211</a> config_json, |
| <a href=#212 id=212 data-nosnippet>212</a> sysroot_root, |
| <a href=#213 id=213 data-nosnippet>213</a> workspace_root, |
| <a href=#214 id=214 data-nosnippet>214</a> manifest_path, |
| <a href=#215 id=215 data-nosnippet>215</a> ws_target_dir, |
| <a href=#216 id=216 data-nosnippet>216</a> ); |
| <a href=#217 id=217 data-nosnippet>217</a> <span class="kw">let </span>(sender, receiver) = unbounded::<StateChange>(); |
| <a href=#218 id=218 data-nosnippet>218</a> <span class="kw">let </span>thread = |
| <a href=#219 id=219 data-nosnippet>219</a> stdx::thread::Builder::new(stdx::thread::ThreadIntent::Worker, <span class="macro">format!</span>(<span class="string">"Flycheck{id}"</span>)) |
| <a href=#220 id=220 data-nosnippet>220</a> .spawn(<span class="kw">move </span>|| actor.run(receiver)) |
| <a href=#221 id=221 data-nosnippet>221</a> .expect(<span class="string">"failed to spawn thread"</span>); |
| <a href=#222 id=222 data-nosnippet>222</a> FlycheckHandle { id, generation, sender, _thread: thread } |
| <a href=#223 id=223 data-nosnippet>223</a> } |
| <a href=#224 id=224 data-nosnippet>224</a> |
| <a href=#225 id=225 data-nosnippet>225</a> <span class="doccomment">/// Schedule a re-start of the cargo check worker to do a workspace wide check. |
| <a href=#226 id=226 data-nosnippet>226</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>restart_workspace(<span class="kw-2">&</span><span class="self">self</span>, saved_file: <span class="prelude-ty">Option</span><AbsPathBuf>) { |
| <a href=#227 id=227 data-nosnippet>227</a> <span class="kw">let </span>generation = <span class="self">self</span>.generation.fetch_add(<span class="number">1</span>, Ordering::Relaxed) + <span class="number">1</span>; |
| <a href=#228 id=228 data-nosnippet>228</a> <span class="self">self</span>.sender |
| <a href=#229 id=229 data-nosnippet>229</a> .send(StateChange::Restart { |
| <a href=#230 id=230 data-nosnippet>230</a> generation, |
| <a href=#231 id=231 data-nosnippet>231</a> scope: FlycheckScope::Workspace, |
| <a href=#232 id=232 data-nosnippet>232</a> saved_file, |
| <a href=#233 id=233 data-nosnippet>233</a> target: <span class="prelude-val">None</span>, |
| <a href=#234 id=234 data-nosnippet>234</a> }) |
| <a href=#235 id=235 data-nosnippet>235</a> .unwrap(); |
| <a href=#236 id=236 data-nosnippet>236</a> } |
| <a href=#237 id=237 data-nosnippet>237</a> |
| <a href=#238 id=238 data-nosnippet>238</a> <span class="doccomment">/// Schedule a re-start of the cargo check worker to do a package wide check. |
| <a href=#239 id=239 data-nosnippet>239</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>restart_for_package( |
| <a href=#240 id=240 data-nosnippet>240</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#241 id=241 data-nosnippet>241</a> package: PackageSpecifier, |
| <a href=#242 id=242 data-nosnippet>242</a> target: <span class="prelude-ty">Option</span><Target>, |
| <a href=#243 id=243 data-nosnippet>243</a> workspace_deps: <span class="prelude-ty">Option</span><FxHashSet<PackageSpecifier>>, |
| <a href=#244 id=244 data-nosnippet>244</a> saved_file: <span class="prelude-ty">Option</span><AbsPathBuf>, |
| <a href=#245 id=245 data-nosnippet>245</a> ) { |
| <a href=#246 id=246 data-nosnippet>246</a> <span class="kw">let </span>generation = <span class="self">self</span>.generation.fetch_add(<span class="number">1</span>, Ordering::Relaxed) + <span class="number">1</span>; |
| <a href=#247 id=247 data-nosnippet>247</a> <span class="self">self</span>.sender |
| <a href=#248 id=248 data-nosnippet>248</a> .send(StateChange::Restart { |
| <a href=#249 id=249 data-nosnippet>249</a> generation, |
| <a href=#250 id=250 data-nosnippet>250</a> scope: FlycheckScope::Package { package, workspace_deps }, |
| <a href=#251 id=251 data-nosnippet>251</a> saved_file, |
| <a href=#252 id=252 data-nosnippet>252</a> target, |
| <a href=#253 id=253 data-nosnippet>253</a> }) |
| <a href=#254 id=254 data-nosnippet>254</a> .unwrap(); |
| <a href=#255 id=255 data-nosnippet>255</a> } |
| <a href=#256 id=256 data-nosnippet>256</a> |
| <a href=#257 id=257 data-nosnippet>257</a> <span class="doccomment">/// Stop this cargo check worker. |
| <a href=#258 id=258 data-nosnippet>258</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>cancel(<span class="kw-2">&</span><span class="self">self</span>) { |
| <a href=#259 id=259 data-nosnippet>259</a> <span class="self">self</span>.sender.send(StateChange::Cancel).unwrap(); |
| <a href=#260 id=260 data-nosnippet>260</a> } |
| <a href=#261 id=261 data-nosnippet>261</a> |
| <a href=#262 id=262 data-nosnippet>262</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>id(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <a href=#263 id=263 data-nosnippet>263</a> <span class="self">self</span>.id |
| <a href=#264 id=264 data-nosnippet>264</a> } |
| <a href=#265 id=265 data-nosnippet>265</a> |
| <a href=#266 id=266 data-nosnippet>266</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>generation(<span class="kw-2">&</span><span class="self">self</span>) -> DiagnosticsGeneration { |
| <a href=#267 id=267 data-nosnippet>267</a> <span class="self">self</span>.generation.load(Ordering::Relaxed) |
| <a href=#268 id=268 data-nosnippet>268</a> } |
| <a href=#269 id=269 data-nosnippet>269</a>} |
| <a href=#270 id=270 data-nosnippet>270</a> |
| <a href=#271 id=271 data-nosnippet>271</a><span class="attr">#[derive(Debug)] |
| <a href=#272 id=272 data-nosnippet>272</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>ClearDiagnosticsKind { |
| <a href=#273 id=273 data-nosnippet>273</a> All(ClearScope), |
| <a href=#274 id=274 data-nosnippet>274</a> OlderThan(DiagnosticsGeneration, ClearScope), |
| <a href=#275 id=275 data-nosnippet>275</a>} |
| <a href=#276 id=276 data-nosnippet>276</a> |
| <a href=#277 id=277 data-nosnippet>277</a><span class="attr">#[derive(Debug)] |
| <a href=#278 id=278 data-nosnippet>278</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>ClearScope { |
| <a href=#279 id=279 data-nosnippet>279</a> Workspace, |
| <a href=#280 id=280 data-nosnippet>280</a> Package(PackageSpecifier), |
| <a href=#281 id=281 data-nosnippet>281</a>} |
| <a href=#282 id=282 data-nosnippet>282</a> |
| <a href=#283 id=283 data-nosnippet>283</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>FlycheckMessage { |
| <a href=#284 id=284 data-nosnippet>284</a> <span class="doccomment">/// Request adding a diagnostic with fixes included to a file |
| <a href=#285 id=285 data-nosnippet>285</a> </span>AddDiagnostic { |
| <a href=#286 id=286 data-nosnippet>286</a> id: usize, |
| <a href=#287 id=287 data-nosnippet>287</a> generation: DiagnosticsGeneration, |
| <a href=#288 id=288 data-nosnippet>288</a> workspace_root: Arc<AbsPathBuf>, |
| <a href=#289 id=289 data-nosnippet>289</a> diagnostic: Diagnostic, |
| <a href=#290 id=290 data-nosnippet>290</a> package_id: <span class="prelude-ty">Option</span><PackageSpecifier>, |
| <a href=#291 id=291 data-nosnippet>291</a> }, |
| <a href=#292 id=292 data-nosnippet>292</a> |
| <a href=#293 id=293 data-nosnippet>293</a> <span class="doccomment">/// Request clearing all outdated diagnostics. |
| <a href=#294 id=294 data-nosnippet>294</a> </span>ClearDiagnostics { id: usize, kind: ClearDiagnosticsKind }, |
| <a href=#295 id=295 data-nosnippet>295</a> |
| <a href=#296 id=296 data-nosnippet>296</a> <span class="doccomment">/// Request check progress notification to client |
| <a href=#297 id=297 data-nosnippet>297</a> </span>Progress { |
| <a href=#298 id=298 data-nosnippet>298</a> <span class="doccomment">/// Flycheck instance ID |
| <a href=#299 id=299 data-nosnippet>299</a> </span>id: usize, |
| <a href=#300 id=300 data-nosnippet>300</a> progress: Progress, |
| <a href=#301 id=301 data-nosnippet>301</a> }, |
| <a href=#302 id=302 data-nosnippet>302</a>} |
| <a href=#303 id=303 data-nosnippet>303</a> |
| <a href=#304 id=304 data-nosnippet>304</a><span class="kw">impl </span>fmt::Debug <span class="kw">for </span>FlycheckMessage { |
| <a href=#305 id=305 data-nosnippet>305</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <a href=#306 id=306 data-nosnippet>306</a> <span class="kw">match </span><span class="self">self </span>{ |
| <a href=#307 id=307 data-nosnippet>307</a> FlycheckMessage::AddDiagnostic { |
| <a href=#308 id=308 data-nosnippet>308</a> id, |
| <a href=#309 id=309 data-nosnippet>309</a> generation, |
| <a href=#310 id=310 data-nosnippet>310</a> workspace_root, |
| <a href=#311 id=311 data-nosnippet>311</a> diagnostic, |
| <a href=#312 id=312 data-nosnippet>312</a> package_id, |
| <a href=#313 id=313 data-nosnippet>313</a> } => f |
| <a href=#314 id=314 data-nosnippet>314</a> .debug_struct(<span class="string">"AddDiagnostic"</span>) |
| <a href=#315 id=315 data-nosnippet>315</a> .field(<span class="string">"id"</span>, id) |
| <a href=#316 id=316 data-nosnippet>316</a> .field(<span class="string">"generation"</span>, generation) |
| <a href=#317 id=317 data-nosnippet>317</a> .field(<span class="string">"workspace_root"</span>, workspace_root) |
| <a href=#318 id=318 data-nosnippet>318</a> .field(<span class="string">"package_id"</span>, package_id) |
| <a href=#319 id=319 data-nosnippet>319</a> .field(<span class="string">"diagnostic_code"</span>, <span class="kw-2">&</span>diagnostic.code.as_ref().map(|it| <span class="kw-2">&</span>it.code)) |
| <a href=#320 id=320 data-nosnippet>320</a> .finish(), |
| <a href=#321 id=321 data-nosnippet>321</a> FlycheckMessage::ClearDiagnostics { id, kind } => { |
| <a href=#322 id=322 data-nosnippet>322</a> f.debug_struct(<span class="string">"ClearDiagnostics"</span>).field(<span class="string">"id"</span>, id).field(<span class="string">"kind"</span>, kind).finish() |
| <a href=#323 id=323 data-nosnippet>323</a> } |
| <a href=#324 id=324 data-nosnippet>324</a> FlycheckMessage::Progress { id, progress } => { |
| <a href=#325 id=325 data-nosnippet>325</a> f.debug_struct(<span class="string">"Progress"</span>).field(<span class="string">"id"</span>, id).field(<span class="string">"progress"</span>, progress).finish() |
| <a href=#326 id=326 data-nosnippet>326</a> } |
| <a href=#327 id=327 data-nosnippet>327</a> } |
| <a href=#328 id=328 data-nosnippet>328</a> } |
| <a href=#329 id=329 data-nosnippet>329</a>} |
| <a href=#330 id=330 data-nosnippet>330</a> |
| <a href=#331 id=331 data-nosnippet>331</a><span class="attr">#[derive(Debug)] |
| <a href=#332 id=332 data-nosnippet>332</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>Progress { |
| <a href=#333 id=333 data-nosnippet>333</a> DidStart { |
| <a href=#334 id=334 data-nosnippet>334</a> <span class="doccomment">/// The user sees this in VSCode, etc. May be a shortened version of the command we actually |
| <a href=#335 id=335 data-nosnippet>335</a> /// executed, otherwise it is way too long. |
| <a href=#336 id=336 data-nosnippet>336</a> </span>user_facing_command: String, |
| <a href=#337 id=337 data-nosnippet>337</a> }, |
| <a href=#338 id=338 data-nosnippet>338</a> DidCheckCrate(String), |
| <a href=#339 id=339 data-nosnippet>339</a> DidFinish(io::Result<()>), |
| <a href=#340 id=340 data-nosnippet>340</a> DidCancel, |
| <a href=#341 id=341 data-nosnippet>341</a> DidFailToRestart(String), |
| <a href=#342 id=342 data-nosnippet>342</a>} |
| <a href=#343 id=343 data-nosnippet>343</a> |
| <a href=#344 id=344 data-nosnippet>344</a><span class="attr">#[derive(Debug, Clone)] |
| <a href=#345 id=345 data-nosnippet>345</a></span><span class="kw">enum </span>FlycheckScope { |
| <a href=#346 id=346 data-nosnippet>346</a> Workspace, |
| <a href=#347 id=347 data-nosnippet>347</a> Package { |
| <a href=#348 id=348 data-nosnippet>348</a> <span class="comment">// Either a cargo package or a $label in rust-project.check.overrideCommand |
| <a href=#349 id=349 data-nosnippet>349</a> </span>package: PackageSpecifier, |
| <a href=#350 id=350 data-nosnippet>350</a> workspace_deps: <span class="prelude-ty">Option</span><FxHashSet<PackageSpecifier>>, |
| <a href=#351 id=351 data-nosnippet>351</a> }, |
| <a href=#352 id=352 data-nosnippet>352</a>} |
| <a href=#353 id=353 data-nosnippet>353</a> |
| <a href=#354 id=354 data-nosnippet>354</a><span class="attr">#[derive(Debug, Hash, PartialEq, Eq, Clone)] |
| <a href=#355 id=355 data-nosnippet>355</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>PackageSpecifier { |
| <a href=#356 id=356 data-nosnippet>356</a> Cargo { |
| <a href=#357 id=357 data-nosnippet>357</a> <span class="doccomment">/// The one in Cargo.toml, assumed to work with `cargo check -p {}` etc |
| <a href=#358 id=358 data-nosnippet>358</a> </span>package_id: Arc<PackageId>, |
| <a href=#359 id=359 data-nosnippet>359</a> }, |
| <a href=#360 id=360 data-nosnippet>360</a> BuildInfo { |
| <a href=#361 id=361 data-nosnippet>361</a> <span class="doccomment">/// If a `build` field is present in rust-project.json, its label field |
| <a href=#362 id=362 data-nosnippet>362</a> </span>label: String, |
| <a href=#363 id=363 data-nosnippet>363</a> }, |
| <a href=#364 id=364 data-nosnippet>364</a>} |
| <a href=#365 id=365 data-nosnippet>365</a> |
| <a href=#366 id=366 data-nosnippet>366</a><span class="kw">impl </span>PackageSpecifier { |
| <a href=#367 id=367 data-nosnippet>367</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <a href=#368 id=368 data-nosnippet>368</a> <span class="kw">match </span><span class="self">self </span>{ |
| <a href=#369 id=369 data-nosnippet>369</a> <span class="self">Self</span>::Cargo { package_id } => <span class="kw-2">&</span>package_id.repr, |
| <a href=#370 id=370 data-nosnippet>370</a> <span class="self">Self</span>::BuildInfo { label } => label, |
| <a href=#371 id=371 data-nosnippet>371</a> } |
| <a href=#372 id=372 data-nosnippet>372</a> } |
| <a href=#373 id=373 data-nosnippet>373</a>} |
| <a href=#374 id=374 data-nosnippet>374</a> |
| <a href=#375 id=375 data-nosnippet>375</a><span class="attr">#[derive(Debug)] |
| <a href=#376 id=376 data-nosnippet>376</a></span><span class="kw">enum </span>FlycheckCommandOrigin { |
| <a href=#377 id=377 data-nosnippet>377</a> <span class="doccomment">/// Regular cargo invocation |
| <a href=#378 id=378 data-nosnippet>378</a> </span>Cargo, |
| <a href=#379 id=379 data-nosnippet>379</a> <span class="doccomment">/// Configured via check_overrideCommand |
| <a href=#380 id=380 data-nosnippet>380</a> </span>CheckOverrideCommand, |
| <a href=#381 id=381 data-nosnippet>381</a> <span class="doccomment">/// From a runnable with [project_json::RunnableKind::Flycheck] |
| <a href=#382 id=382 data-nosnippet>382</a> </span>ProjectJsonRunnable, |
| <a href=#383 id=383 data-nosnippet>383</a>} |
| <a href=#384 id=384 data-nosnippet>384</a> |
| <a href=#385 id=385 data-nosnippet>385</a><span class="attr">#[derive(Debug)] |
| <a href=#386 id=386 data-nosnippet>386</a></span><span class="kw">enum </span>StateChange { |
| <a href=#387 id=387 data-nosnippet>387</a> Restart { |
| <a href=#388 id=388 data-nosnippet>388</a> generation: DiagnosticsGeneration, |
| <a href=#389 id=389 data-nosnippet>389</a> scope: FlycheckScope, |
| <a href=#390 id=390 data-nosnippet>390</a> saved_file: <span class="prelude-ty">Option</span><AbsPathBuf>, |
| <a href=#391 id=391 data-nosnippet>391</a> target: <span class="prelude-ty">Option</span><Target>, |
| <a href=#392 id=392 data-nosnippet>392</a> }, |
| <a href=#393 id=393 data-nosnippet>393</a> Cancel, |
| <a href=#394 id=394 data-nosnippet>394</a>} |
| <a href=#395 id=395 data-nosnippet>395</a> |
| <a href=#396 id=396 data-nosnippet>396</a><span class="doccomment">/// A [`FlycheckActor`] is a single check instance of a workspace. |
| <a href=#397 id=397 data-nosnippet>397</a></span><span class="kw">struct </span>FlycheckActor { |
| <a href=#398 id=398 data-nosnippet>398</a> <span class="doccomment">/// The workspace id of this flycheck instance. |
| <a href=#399 id=399 data-nosnippet>399</a> </span>id: usize, |
| <a href=#400 id=400 data-nosnippet>400</a> |
| <a href=#401 id=401 data-nosnippet>401</a> generation: DiagnosticsGeneration, |
| <a href=#402 id=402 data-nosnippet>402</a> sender: Sender<FlycheckMessage>, |
| <a href=#403 id=403 data-nosnippet>403</a> config: FlycheckConfig, |
| <a href=#404 id=404 data-nosnippet>404</a> config_json: FlycheckConfigJson, |
| <a href=#405 id=405 data-nosnippet>405</a> |
| <a href=#406 id=406 data-nosnippet>406</a> manifest_path: <span class="prelude-ty">Option</span><AbsPathBuf>, |
| <a href=#407 id=407 data-nosnippet>407</a> ws_target_dir: <span class="prelude-ty">Option</span><Utf8PathBuf>, |
| <a href=#408 id=408 data-nosnippet>408</a> <span class="doccomment">/// Either the workspace root of the workspace we are flychecking, |
| <a href=#409 id=409 data-nosnippet>409</a> /// or the project root of the project. |
| <a href=#410 id=410 data-nosnippet>410</a> </span>root: Arc<AbsPathBuf>, |
| <a href=#411 id=411 data-nosnippet>411</a> sysroot_root: <span class="prelude-ty">Option</span><AbsPathBuf>, |
| <a href=#412 id=412 data-nosnippet>412</a> scope: FlycheckScope, |
| <a href=#413 id=413 data-nosnippet>413</a> <span class="doccomment">/// CargoHandle exists to wrap around the communication needed to be able to |
| <a href=#414 id=414 data-nosnippet>414</a> /// run `cargo check` without blocking. Currently the Rust standard library |
| <a href=#415 id=415 data-nosnippet>415</a> /// doesn't provide a way to read sub-process output without blocking, so we |
| <a href=#416 id=416 data-nosnippet>416</a> /// have to wrap sub-processes output handling in a thread and pass messages |
| <a href=#417 id=417 data-nosnippet>417</a> /// back over a channel. |
| <a href=#418 id=418 data-nosnippet>418</a> </span>command_handle: <span class="prelude-ty">Option</span><CommandHandle<CheckMessage>>, |
| <a href=#419 id=419 data-nosnippet>419</a> <span class="doccomment">/// The receiver side of the channel mentioned above. |
| <a href=#420 id=420 data-nosnippet>420</a> </span>command_receiver: <span class="prelude-ty">Option</span><Receiver<CheckMessage>>, |
| <a href=#421 id=421 data-nosnippet>421</a> diagnostics_cleared_for: FxHashSet<PackageSpecifier>, |
| <a href=#422 id=422 data-nosnippet>422</a> diagnostics_received: DiagnosticsReceived, |
| <a href=#423 id=423 data-nosnippet>423</a>} |
| <a href=#424 id=424 data-nosnippet>424</a> |
| <a href=#425 id=425 data-nosnippet>425</a><span class="attr">#[derive(PartialEq, Debug)] |
| <a href=#426 id=426 data-nosnippet>426</a></span><span class="kw">enum </span>DiagnosticsReceived { |
| <a href=#427 id=427 data-nosnippet>427</a> <span class="doccomment">/// We started a flycheck, but we haven't seen any diagnostics yet. |
| <a href=#428 id=428 data-nosnippet>428</a> </span>NotYet, |
| <a href=#429 id=429 data-nosnippet>429</a> <span class="doccomment">/// We received a non-zero number of diagnostics from rustc or clippy (via |
| <a href=#430 id=430 data-nosnippet>430</a> /// cargo or custom check command). This means there were errors or |
| <a href=#431 id=431 data-nosnippet>431</a> /// warnings. |
| <a href=#432 id=432 data-nosnippet>432</a> </span>AtLeastOne, |
| <a href=#433 id=433 data-nosnippet>433</a> <span class="doccomment">/// We received a non-zero number of diagnostics, and the scope is |
| <a href=#434 id=434 data-nosnippet>434</a> /// workspace, so we've discarded the previous workspace diagnostics. |
| <a href=#435 id=435 data-nosnippet>435</a> </span>AtLeastOneAndClearedWorkspace, |
| <a href=#436 id=436 data-nosnippet>436</a>} |
| <a href=#437 id=437 data-nosnippet>437</a> |
| <a href=#438 id=438 data-nosnippet>438</a><span class="attr">#[allow(clippy::large_enum_variant)] |
| <a href=#439 id=439 data-nosnippet>439</a>#[derive(Debug)] |
| <a href=#440 id=440 data-nosnippet>440</a></span><span class="kw">enum </span>Event { |
| <a href=#441 id=441 data-nosnippet>441</a> RequestStateChange(StateChange), |
| <a href=#442 id=442 data-nosnippet>442</a> CheckEvent(<span class="prelude-ty">Option</span><CheckMessage>), |
| <a href=#443 id=443 data-nosnippet>443</a>} |
| <a href=#444 id=444 data-nosnippet>444</a> |
| <a href=#445 id=445 data-nosnippet>445</a><span class="doccomment">/// This is stable behaviour. Don't change. |
| <a href=#446 id=446 data-nosnippet>446</a></span><span class="kw">const </span>SAVED_FILE_PLACEHOLDER_DOLLAR: <span class="kw-2">&</span>str = <span class="string">"$saved_file"</span>; |
| <a href=#447 id=447 data-nosnippet>447</a><span class="kw">const </span>LABEL_INLINE: <span class="kw-2">&</span>str = <span class="string">"{label}"</span>; |
| <a href=#448 id=448 data-nosnippet>448</a><span class="kw">const </span>SAVED_FILE_INLINE: <span class="kw-2">&</span>str = <span class="string">"{saved_file}"</span>; |
| <a href=#449 id=449 data-nosnippet>449</a> |
| <a href=#450 id=450 data-nosnippet>450</a><span class="attr">#[derive(Debug)] |
| <a href=#451 id=451 data-nosnippet>451</a></span><span class="kw">struct </span>Substitutions<<span class="lifetime">'a</span>> { |
| <a href=#452 id=452 data-nosnippet>452</a> label: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str>, |
| <a href=#453 id=453 data-nosnippet>453</a> saved_file: <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'a </span>str>, |
| <a href=#454 id=454 data-nosnippet>454</a>} |
| <a href=#455 id=455 data-nosnippet>455</a> |
| <a href=#456 id=456 data-nosnippet>456</a><span class="kw">impl</span><<span class="lifetime">'a</span>> Substitutions<<span class="lifetime">'a</span>> { |
| <a href=#457 id=457 data-nosnippet>457</a> <span class="doccomment">/// If you have a runnable, and it has {label} in it somewhere, treat it as a template that |
| <a href=#458 id=458 data-nosnippet>458</a> /// may be unsatisfied if you do not provide a label to substitute into it. Returns None in |
| <a href=#459 id=459 data-nosnippet>459</a> /// that situation. Otherwise performs the requested substitutions. |
| <a href=#460 id=460 data-nosnippet>460</a> /// |
| <a href=#461 id=461 data-nosnippet>461</a> /// Same for {saved_file}. |
| <a href=#462 id=462 data-nosnippet>462</a> /// |
| <a href=#463 id=463 data-nosnippet>463</a> </span><span class="attr">#[allow(clippy::disallowed_types)] </span><span class="comment">/* generic parameter allows for FxHashMap */ |
| <a href=#464 id=464 data-nosnippet>464</a> </span><span class="kw">fn </span>substitute<H>( |
| <a href=#465 id=465 data-nosnippet>465</a> <span class="self">self</span>, |
| <a href=#466 id=466 data-nosnippet>466</a> template: <span class="kw-2">&</span>project_json::Runnable, |
| <a href=#467 id=467 data-nosnippet>467</a> extra_env: <span class="kw-2">&</span>std::collections::HashMap<String, <span class="prelude-ty">Option</span><String>, H>, |
| <a href=#468 id=468 data-nosnippet>468</a> ) -> <span class="prelude-ty">Option</span><Command> { |
| <a href=#469 id=469 data-nosnippet>469</a> <span class="kw">let </span><span class="kw-2">mut </span>cmd = toolchain::command(<span class="kw-2">&</span>template.program, <span class="kw-2">&</span>template.cwd, extra_env); |
| <a href=#470 id=470 data-nosnippet>470</a> <span class="kw">for </span>arg <span class="kw">in </span><span class="kw-2">&</span>template.args { |
| <a href=#471 id=471 data-nosnippet>471</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(ix) = arg.find(LABEL_INLINE) { |
| <a href=#472 id=472 data-nosnippet>472</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(label) = <span class="self">self</span>.label { |
| <a href=#473 id=473 data-nosnippet>473</a> <span class="kw">let </span><span class="kw-2">mut </span>arg = arg.to_string(); |
| <a href=#474 id=474 data-nosnippet>474</a> arg.replace_range(ix..ix + LABEL_INLINE.len(), label); |
| <a href=#475 id=475 data-nosnippet>475</a> cmd.arg(arg); |
| <a href=#476 id=476 data-nosnippet>476</a> <span class="kw">continue</span>; |
| <a href=#477 id=477 data-nosnippet>477</a> } <span class="kw">else </span>{ |
| <a href=#478 id=478 data-nosnippet>478</a> <span class="kw">return </span><span class="prelude-val">None</span>; |
| <a href=#479 id=479 data-nosnippet>479</a> } |
| <a href=#480 id=480 data-nosnippet>480</a> } |
| <a href=#481 id=481 data-nosnippet>481</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(ix) = arg.find(SAVED_FILE_INLINE) { |
| <a href=#482 id=482 data-nosnippet>482</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(saved_file) = <span class="self">self</span>.saved_file { |
| <a href=#483 id=483 data-nosnippet>483</a> <span class="kw">let </span><span class="kw-2">mut </span>arg = arg.to_string(); |
| <a href=#484 id=484 data-nosnippet>484</a> arg.replace_range(ix..ix + SAVED_FILE_INLINE.len(), saved_file); |
| <a href=#485 id=485 data-nosnippet>485</a> cmd.arg(arg); |
| <a href=#486 id=486 data-nosnippet>486</a> <span class="kw">continue</span>; |
| <a href=#487 id=487 data-nosnippet>487</a> } <span class="kw">else </span>{ |
| <a href=#488 id=488 data-nosnippet>488</a> <span class="kw">return </span><span class="prelude-val">None</span>; |
| <a href=#489 id=489 data-nosnippet>489</a> } |
| <a href=#490 id=490 data-nosnippet>490</a> } |
| <a href=#491 id=491 data-nosnippet>491</a> <span class="comment">// Legacy syntax: full argument match |
| <a href=#492 id=492 data-nosnippet>492</a> </span><span class="kw">if </span>arg == SAVED_FILE_PLACEHOLDER_DOLLAR { |
| <a href=#493 id=493 data-nosnippet>493</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(saved_file) = <span class="self">self</span>.saved_file { |
| <a href=#494 id=494 data-nosnippet>494</a> cmd.arg(saved_file); |
| <a href=#495 id=495 data-nosnippet>495</a> <span class="kw">continue</span>; |
| <a href=#496 id=496 data-nosnippet>496</a> } <span class="kw">else </span>{ |
| <a href=#497 id=497 data-nosnippet>497</a> <span class="kw">return </span><span class="prelude-val">None</span>; |
| <a href=#498 id=498 data-nosnippet>498</a> } |
| <a href=#499 id=499 data-nosnippet>499</a> } |
| <a href=#500 id=500 data-nosnippet>500</a> cmd.arg(arg); |
| <a href=#501 id=501 data-nosnippet>501</a> } |
| <a href=#502 id=502 data-nosnippet>502</a> cmd.current_dir(<span class="kw-2">&</span>template.cwd); |
| <a href=#503 id=503 data-nosnippet>503</a> <span class="prelude-val">Some</span>(cmd) |
| <a href=#504 id=504 data-nosnippet>504</a> } |
| <a href=#505 id=505 data-nosnippet>505</a>} |
| <a href=#506 id=506 data-nosnippet>506</a> |
| <a href=#507 id=507 data-nosnippet>507</a><span class="kw">impl </span>FlycheckActor { |
| <a href=#508 id=508 data-nosnippet>508</a> <span class="kw">fn </span>new( |
| <a href=#509 id=509 data-nosnippet>509</a> id: usize, |
| <a href=#510 id=510 data-nosnippet>510</a> generation: DiagnosticsGeneration, |
| <a href=#511 id=511 data-nosnippet>511</a> sender: Sender<FlycheckMessage>, |
| <a href=#512 id=512 data-nosnippet>512</a> config: FlycheckConfig, |
| <a href=#513 id=513 data-nosnippet>513</a> config_json: FlycheckConfigJson, |
| <a href=#514 id=514 data-nosnippet>514</a> sysroot_root: <span class="prelude-ty">Option</span><AbsPathBuf>, |
| <a href=#515 id=515 data-nosnippet>515</a> workspace_root: AbsPathBuf, |
| <a href=#516 id=516 data-nosnippet>516</a> manifest_path: <span class="prelude-ty">Option</span><AbsPathBuf>, |
| <a href=#517 id=517 data-nosnippet>517</a> ws_target_dir: <span class="prelude-ty">Option</span><Utf8PathBuf>, |
| <a href=#518 id=518 data-nosnippet>518</a> ) -> FlycheckActor { |
| <a href=#519 id=519 data-nosnippet>519</a> <span class="macro">tracing::info!</span>(%id, <span class="question-mark">?</span>workspace_root, <span class="string">"Spawning flycheck"</span>); |
| <a href=#520 id=520 data-nosnippet>520</a> FlycheckActor { |
| <a href=#521 id=521 data-nosnippet>521</a> id, |
| <a href=#522 id=522 data-nosnippet>522</a> generation, |
| <a href=#523 id=523 data-nosnippet>523</a> sender, |
| <a href=#524 id=524 data-nosnippet>524</a> config, |
| <a href=#525 id=525 data-nosnippet>525</a> config_json, |
| <a href=#526 id=526 data-nosnippet>526</a> sysroot_root, |
| <a href=#527 id=527 data-nosnippet>527</a> root: Arc::new(workspace_root), |
| <a href=#528 id=528 data-nosnippet>528</a> scope: FlycheckScope::Workspace, |
| <a href=#529 id=529 data-nosnippet>529</a> manifest_path, |
| <a href=#530 id=530 data-nosnippet>530</a> ws_target_dir, |
| <a href=#531 id=531 data-nosnippet>531</a> command_handle: <span class="prelude-val">None</span>, |
| <a href=#532 id=532 data-nosnippet>532</a> command_receiver: <span class="prelude-val">None</span>, |
| <a href=#533 id=533 data-nosnippet>533</a> diagnostics_cleared_for: Default::default(), |
| <a href=#534 id=534 data-nosnippet>534</a> diagnostics_received: DiagnosticsReceived::NotYet, |
| <a href=#535 id=535 data-nosnippet>535</a> } |
| <a href=#536 id=536 data-nosnippet>536</a> } |
| <a href=#537 id=537 data-nosnippet>537</a> |
| <a href=#538 id=538 data-nosnippet>538</a> <span class="kw">fn </span>report_progress(<span class="kw-2">&</span><span class="self">self</span>, progress: Progress) { |
| <a href=#539 id=539 data-nosnippet>539</a> <span class="self">self</span>.send(FlycheckMessage::Progress { id: <span class="self">self</span>.id, progress }); |
| <a href=#540 id=540 data-nosnippet>540</a> } |
| <a href=#541 id=541 data-nosnippet>541</a> |
| <a href=#542 id=542 data-nosnippet>542</a> <span class="kw">fn </span>next_event(<span class="kw-2">&</span><span class="self">self</span>, inbox: <span class="kw-2">&</span>Receiver<StateChange>) -> <span class="prelude-ty">Option</span><Event> { |
| <a href=#543 id=543 data-nosnippet>543</a> <span class="kw">let </span><span class="prelude-val">Some</span>(command_receiver) = <span class="kw-2">&</span><span class="self">self</span>.command_receiver <span class="kw">else </span>{ |
| <a href=#544 id=544 data-nosnippet>544</a> <span class="kw">return </span>inbox.recv().ok().map(Event::RequestStateChange); |
| <a href=#545 id=545 data-nosnippet>545</a> }; |
| <a href=#546 id=546 data-nosnippet>546</a> |
| <a href=#547 id=547 data-nosnippet>547</a> <span class="comment">// Biased to give restarts a preference so check outputs don't block a restart or stop |
| <a href=#548 id=548 data-nosnippet>548</a> </span><span class="macro">select_biased!</span> { |
| <a href=#549 id=549 data-nosnippet>549</a> recv(inbox) -> msg => msg.ok().map(Event::RequestStateChange), |
| <a href=#550 id=550 data-nosnippet>550</a> recv(command_receiver) -> msg => <span class="prelude-val">Some</span>(Event::CheckEvent(msg.ok())), |
| <a href=#551 id=551 data-nosnippet>551</a> } |
| <a href=#552 id=552 data-nosnippet>552</a> } |
| <a href=#553 id=553 data-nosnippet>553</a> |
| <a href=#554 id=554 data-nosnippet>554</a> <span class="kw">fn </span>run(<span class="kw-2">mut </span><span class="self">self</span>, inbox: Receiver<StateChange>) { |
| <a href=#555 id=555 data-nosnippet>555</a> <span class="lifetime">'event</span>: <span class="kw">while let </span><span class="prelude-val">Some</span>(event) = <span class="self">self</span>.next_event(<span class="kw-2">&</span>inbox) { |
| <a href=#556 id=556 data-nosnippet>556</a> <span class="kw">match </span>event { |
| <a href=#557 id=557 data-nosnippet>557</a> Event::RequestStateChange(StateChange::Cancel) => { |
| <a href=#558 id=558 data-nosnippet>558</a> <span class="macro">tracing::debug!</span>(flycheck_id = <span class="self">self</span>.id, <span class="string">"flycheck cancelled"</span>); |
| <a href=#559 id=559 data-nosnippet>559</a> <span class="self">self</span>.cancel_check_process(); |
| <a href=#560 id=560 data-nosnippet>560</a> } |
| <a href=#561 id=561 data-nosnippet>561</a> Event::RequestStateChange(StateChange::Restart { |
| <a href=#562 id=562 data-nosnippet>562</a> <span class="kw-2">mut </span>generation, |
| <a href=#563 id=563 data-nosnippet>563</a> <span class="kw-2">mut </span>scope, |
| <a href=#564 id=564 data-nosnippet>564</a> <span class="kw-2">mut </span>saved_file, |
| <a href=#565 id=565 data-nosnippet>565</a> <span class="kw-2">mut </span>target, |
| <a href=#566 id=566 data-nosnippet>566</a> }) => { |
| <a href=#567 id=567 data-nosnippet>567</a> <span class="comment">// Cancel the previously spawned process |
| <a href=#568 id=568 data-nosnippet>568</a> </span><span class="self">self</span>.cancel_check_process(); |
| <a href=#569 id=569 data-nosnippet>569</a> |
| <a href=#570 id=570 data-nosnippet>570</a> <span class="comment">// Debounce by briefly waiting for other state changes. |
| <a href=#571 id=571 data-nosnippet>571</a> </span><span class="kw">while let </span><span class="prelude-val">Ok</span>(restart) = inbox.recv_timeout(Duration::from_millis(<span class="number">50</span>)) { |
| <a href=#572 id=572 data-nosnippet>572</a> <span class="kw">match </span>restart { |
| <a href=#573 id=573 data-nosnippet>573</a> StateChange::Cancel => { |
| <a href=#574 id=574 data-nosnippet>574</a> <span class="comment">// We got a cancel straight after this restart request, so |
| <a href=#575 id=575 data-nosnippet>575</a> // don't do anything. |
| <a href=#576 id=576 data-nosnippet>576</a> </span><span class="kw">continue </span><span class="lifetime">'event</span>; |
| <a href=#577 id=577 data-nosnippet>577</a> } |
| <a href=#578 id=578 data-nosnippet>578</a> StateChange::Restart { |
| <a href=#579 id=579 data-nosnippet>579</a> generation: g, |
| <a href=#580 id=580 data-nosnippet>580</a> scope: s, |
| <a href=#581 id=581 data-nosnippet>581</a> saved_file: sf, |
| <a href=#582 id=582 data-nosnippet>582</a> target: t, |
| <a href=#583 id=583 data-nosnippet>583</a> } => { |
| <a href=#584 id=584 data-nosnippet>584</a> <span class="comment">// We got another restart request. Take the parameters |
| <a href=#585 id=585 data-nosnippet>585</a> // from the last restart request in this time window, |
| <a href=#586 id=586 data-nosnippet>586</a> // because the most recent request is probably the most |
| <a href=#587 id=587 data-nosnippet>587</a> // relevant to the user. |
| <a href=#588 id=588 data-nosnippet>588</a> </span>generation = g; |
| <a href=#589 id=589 data-nosnippet>589</a> scope = s; |
| <a href=#590 id=590 data-nosnippet>590</a> saved_file = sf; |
| <a href=#591 id=591 data-nosnippet>591</a> target = t; |
| <a href=#592 id=592 data-nosnippet>592</a> } |
| <a href=#593 id=593 data-nosnippet>593</a> } |
| <a href=#594 id=594 data-nosnippet>594</a> } |
| <a href=#595 id=595 data-nosnippet>595</a> |
| <a href=#596 id=596 data-nosnippet>596</a> <span class="kw">let </span>command = <span class="self">self</span>.check_command(<span class="kw-2">&</span>scope, saved_file.as_deref(), target); |
| <a href=#597 id=597 data-nosnippet>597</a> <span class="self">self</span>.scope = scope.clone(); |
| <a href=#598 id=598 data-nosnippet>598</a> <span class="self">self</span>.generation = generation; |
| <a href=#599 id=599 data-nosnippet>599</a> |
| <a href=#600 id=600 data-nosnippet>600</a> <span class="kw">let </span><span class="prelude-val">Some</span>((command, origin)) = command <span class="kw">else </span>{ |
| <a href=#601 id=601 data-nosnippet>601</a> <span class="macro">tracing::debug!</span>(<span class="question-mark">?</span>scope, <span class="string">"failed to build flycheck command"</span>); |
| <a href=#602 id=602 data-nosnippet>602</a> <span class="kw">continue</span>; |
| <a href=#603 id=603 data-nosnippet>603</a> }; |
| <a href=#604 id=604 data-nosnippet>604</a> |
| <a href=#605 id=605 data-nosnippet>605</a> <span class="kw">let </span>debug_command = <span class="macro">format!</span>(<span class="string">"{command:?}"</span>); |
| <a href=#606 id=606 data-nosnippet>606</a> <span class="kw">let </span>user_facing_command = <span class="self">self</span>.config.to_string(); |
| <a href=#607 id=607 data-nosnippet>607</a> |
| <a href=#608 id=608 data-nosnippet>608</a> <span class="macro">tracing::debug!</span>(<span class="question-mark">?</span>origin, <span class="question-mark">?</span>command, <span class="string">"will restart flycheck"</span>); |
| <a href=#609 id=609 data-nosnippet>609</a> <span class="kw">let </span>(sender, receiver) = unbounded(); |
| <a href=#610 id=610 data-nosnippet>610</a> <span class="kw">match </span>CommandHandle::spawn( |
| <a href=#611 id=611 data-nosnippet>611</a> command, |
| <a href=#612 id=612 data-nosnippet>612</a> CheckParser, |
| <a href=#613 id=613 data-nosnippet>613</a> sender, |
| <a href=#614 id=614 data-nosnippet>614</a> <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.config { |
| <a href=#615 id=615 data-nosnippet>615</a> FlycheckConfig::Automatic { cargo_options, .. } => { |
| <a href=#616 id=616 data-nosnippet>616</a> <span class="kw">let </span>ws_target_dir = |
| <a href=#617 id=617 data-nosnippet>617</a> <span class="self">self</span>.ws_target_dir.as_ref().map(Utf8PathBuf::as_path); |
| <a href=#618 id=618 data-nosnippet>618</a> <span class="kw">let </span>target_dir = |
| <a href=#619 id=619 data-nosnippet>619</a> cargo_options.target_dir_config.target_dir(ws_target_dir); |
| <a href=#620 id=620 data-nosnippet>620</a> |
| <a href=#621 id=621 data-nosnippet>621</a> <span class="comment">// If `"rust-analyzer.cargo.targetDir": null`, we should use |
| <a href=#622 id=622 data-nosnippet>622</a> // workspace's target dir instead of hard-coded fallback. |
| <a href=#623 id=623 data-nosnippet>623</a> </span><span class="kw">let </span>target_dir = target_dir.as_deref().or(ws_target_dir); |
| <a href=#624 id=624 data-nosnippet>624</a> |
| <a href=#625 id=625 data-nosnippet>625</a> <span class="prelude-val">Some</span>( |
| <a href=#626 id=626 data-nosnippet>626</a> <span class="comment">// As `CommandHandle::spawn`'s working directory is |
| <a href=#627 id=627 data-nosnippet>627</a> // rust-analyzer's working directory, which might be different |
| <a href=#628 id=628 data-nosnippet>628</a> // from the flycheck's working directory, we should canonicalize |
| <a href=#629 id=629 data-nosnippet>629</a> // the output directory, otherwise we might write it into the |
| <a href=#630 id=630 data-nosnippet>630</a> // wrong target dir. |
| <a href=#631 id=631 data-nosnippet>631</a> // If `target_dir` is an absolute path, it will replace |
| <a href=#632 id=632 data-nosnippet>632</a> // `self.root` and that's an intended behavior. |
| <a href=#633 id=633 data-nosnippet>633</a> </span><span class="self">self</span>.root |
| <a href=#634 id=634 data-nosnippet>634</a> .join(target_dir.unwrap_or( |
| <a href=#635 id=635 data-nosnippet>635</a> Utf8Path::new(<span class="string">"target"</span>).join(<span class="string">"rust-analyzer"</span>).as_path(), |
| <a href=#636 id=636 data-nosnippet>636</a> )) |
| <a href=#637 id=637 data-nosnippet>637</a> .join(<span class="macro">format!</span>(<span class="string">"flycheck{}"</span>, <span class="self">self</span>.id)) |
| <a href=#638 id=638 data-nosnippet>638</a> .into(), |
| <a href=#639 id=639 data-nosnippet>639</a> ) |
| <a href=#640 id=640 data-nosnippet>640</a> } |
| <a href=#641 id=641 data-nosnippet>641</a> <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| <a href=#642 id=642 data-nosnippet>642</a> }, |
| <a href=#643 id=643 data-nosnippet>643</a> ) { |
| <a href=#644 id=644 data-nosnippet>644</a> <span class="prelude-val">Ok</span>(command_handle) => { |
| <a href=#645 id=645 data-nosnippet>645</a> <span class="macro">tracing::debug!</span>(<span class="question-mark">?</span>origin, command = %debug_command, <span class="string">"did restart flycheck"</span>); |
| <a href=#646 id=646 data-nosnippet>646</a> <span class="self">self</span>.command_handle = <span class="prelude-val">Some</span>(command_handle); |
| <a href=#647 id=647 data-nosnippet>647</a> <span class="self">self</span>.command_receiver = <span class="prelude-val">Some</span>(receiver); |
| <a href=#648 id=648 data-nosnippet>648</a> <span class="self">self</span>.report_progress(Progress::DidStart { user_facing_command }); |
| <a href=#649 id=649 data-nosnippet>649</a> } |
| <a href=#650 id=650 data-nosnippet>650</a> <span class="prelude-val">Err</span>(error) => { |
| <a href=#651 id=651 data-nosnippet>651</a> <span class="self">self</span>.report_progress(Progress::DidFailToRestart(<span class="macro">format!</span>( |
| <a href=#652 id=652 data-nosnippet>652</a> <span class="string">"Failed to run the following command: {debug_command} origin={origin:?} error={error}" |
| <a href=#653 id=653 data-nosnippet>653</a> </span>))); |
| <a href=#654 id=654 data-nosnippet>654</a> } |
| <a href=#655 id=655 data-nosnippet>655</a> } |
| <a href=#656 id=656 data-nosnippet>656</a> } |
| <a href=#657 id=657 data-nosnippet>657</a> Event::CheckEvent(<span class="prelude-val">None</span>) => { |
| <a href=#658 id=658 data-nosnippet>658</a> <span class="macro">tracing::debug!</span>(flycheck_id = <span class="self">self</span>.id, <span class="string">"flycheck finished"</span>); |
| <a href=#659 id=659 data-nosnippet>659</a> |
| <a href=#660 id=660 data-nosnippet>660</a> <span class="comment">// Watcher finished |
| <a href=#661 id=661 data-nosnippet>661</a> </span><span class="kw">let </span>command_handle = <span class="self">self</span>.command_handle.take().unwrap(); |
| <a href=#662 id=662 data-nosnippet>662</a> <span class="self">self</span>.command_receiver.take(); |
| <a href=#663 id=663 data-nosnippet>663</a> <span class="kw">let </span>formatted_handle = <span class="macro">format!</span>(<span class="string">"{command_handle:?}"</span>); |
| <a href=#664 id=664 data-nosnippet>664</a> |
| <a href=#665 id=665 data-nosnippet>665</a> <span class="kw">let </span>res = command_handle.join(); |
| <a href=#666 id=666 data-nosnippet>666</a> <span class="kw">if let </span><span class="prelude-val">Err</span>(error) = <span class="kw-2">&</span>res { |
| <a href=#667 id=667 data-nosnippet>667</a> <span class="macro">tracing::error!</span>( |
| <a href=#668 id=668 data-nosnippet>668</a> <span class="string">"Flycheck failed to run the following command: {}, error={}"</span>, |
| <a href=#669 id=669 data-nosnippet>669</a> formatted_handle, |
| <a href=#670 id=670 data-nosnippet>670</a> error |
| <a href=#671 id=671 data-nosnippet>671</a> ); |
| <a href=#672 id=672 data-nosnippet>672</a> } |
| <a href=#673 id=673 data-nosnippet>673</a> <span class="kw">if </span><span class="self">self</span>.diagnostics_received == DiagnosticsReceived::NotYet { |
| <a href=#674 id=674 data-nosnippet>674</a> <span class="macro">tracing::trace!</span>(flycheck_id = <span class="self">self</span>.id, <span class="string">"clearing diagnostics"</span>); |
| <a href=#675 id=675 data-nosnippet>675</a> <span class="comment">// We finished without receiving any diagnostics. |
| <a href=#676 id=676 data-nosnippet>676</a> // Clear everything for good measure |
| <a href=#677 id=677 data-nosnippet>677</a> </span><span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.scope { |
| <a href=#678 id=678 data-nosnippet>678</a> FlycheckScope::Workspace => { |
| <a href=#679 id=679 data-nosnippet>679</a> <span class="self">self</span>.send(FlycheckMessage::ClearDiagnostics { |
| <a href=#680 id=680 data-nosnippet>680</a> id: <span class="self">self</span>.id, |
| <a href=#681 id=681 data-nosnippet>681</a> kind: ClearDiagnosticsKind::All(ClearScope::Workspace), |
| <a href=#682 id=682 data-nosnippet>682</a> }); |
| <a href=#683 id=683 data-nosnippet>683</a> } |
| <a href=#684 id=684 data-nosnippet>684</a> FlycheckScope::Package { package, workspace_deps } => { |
| <a href=#685 id=685 data-nosnippet>685</a> <span class="kw">for </span>pkg <span class="kw">in |
| <a href=#686 id=686 data-nosnippet>686</a> </span>std::iter::once(package).chain(workspace_deps.iter().flatten()) |
| <a href=#687 id=687 data-nosnippet>687</a> { |
| <a href=#688 id=688 data-nosnippet>688</a> <span class="self">self</span>.send(FlycheckMessage::ClearDiagnostics { |
| <a href=#689 id=689 data-nosnippet>689</a> id: <span class="self">self</span>.id, |
| <a href=#690 id=690 data-nosnippet>690</a> kind: ClearDiagnosticsKind::All(ClearScope::Package( |
| <a href=#691 id=691 data-nosnippet>691</a> pkg.clone(), |
| <a href=#692 id=692 data-nosnippet>692</a> )), |
| <a href=#693 id=693 data-nosnippet>693</a> }); |
| <a href=#694 id=694 data-nosnippet>694</a> } |
| <a href=#695 id=695 data-nosnippet>695</a> } |
| <a href=#696 id=696 data-nosnippet>696</a> } |
| <a href=#697 id=697 data-nosnippet>697</a> } <span class="kw">else if </span>res.is_ok() { |
| <a href=#698 id=698 data-nosnippet>698</a> <span class="comment">// We clear diagnostics for packages on |
| <a href=#699 id=699 data-nosnippet>699</a> // `[CargoCheckMessage::CompilerArtifact]` but there seem to be setups where |
| <a href=#700 id=700 data-nosnippet>700</a> // cargo may not report an artifact to our runner at all. To handle such |
| <a href=#701 id=701 data-nosnippet>701</a> // cases, clear stale diagnostics when flycheck completes successfully. |
| <a href=#702 id=702 data-nosnippet>702</a> </span><span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.scope { |
| <a href=#703 id=703 data-nosnippet>703</a> FlycheckScope::Workspace => { |
| <a href=#704 id=704 data-nosnippet>704</a> <span class="self">self</span>.send(FlycheckMessage::ClearDiagnostics { |
| <a href=#705 id=705 data-nosnippet>705</a> id: <span class="self">self</span>.id, |
| <a href=#706 id=706 data-nosnippet>706</a> kind: ClearDiagnosticsKind::OlderThan( |
| <a href=#707 id=707 data-nosnippet>707</a> <span class="self">self</span>.generation, |
| <a href=#708 id=708 data-nosnippet>708</a> ClearScope::Workspace, |
| <a href=#709 id=709 data-nosnippet>709</a> ), |
| <a href=#710 id=710 data-nosnippet>710</a> }); |
| <a href=#711 id=711 data-nosnippet>711</a> } |
| <a href=#712 id=712 data-nosnippet>712</a> FlycheckScope::Package { package, workspace_deps } => { |
| <a href=#713 id=713 data-nosnippet>713</a> <span class="kw">for </span>pkg <span class="kw">in |
| <a href=#714 id=714 data-nosnippet>714</a> </span>std::iter::once(package).chain(workspace_deps.iter().flatten()) |
| <a href=#715 id=715 data-nosnippet>715</a> { |
| <a href=#716 id=716 data-nosnippet>716</a> <span class="self">self</span>.send(FlycheckMessage::ClearDiagnostics { |
| <a href=#717 id=717 data-nosnippet>717</a> id: <span class="self">self</span>.id, |
| <a href=#718 id=718 data-nosnippet>718</a> kind: ClearDiagnosticsKind::OlderThan( |
| <a href=#719 id=719 data-nosnippet>719</a> <span class="self">self</span>.generation, |
| <a href=#720 id=720 data-nosnippet>720</a> ClearScope::Package(pkg.clone()), |
| <a href=#721 id=721 data-nosnippet>721</a> ), |
| <a href=#722 id=722 data-nosnippet>722</a> }); |
| <a href=#723 id=723 data-nosnippet>723</a> } |
| <a href=#724 id=724 data-nosnippet>724</a> } |
| <a href=#725 id=725 data-nosnippet>725</a> } |
| <a href=#726 id=726 data-nosnippet>726</a> } |
| <a href=#727 id=727 data-nosnippet>727</a> <span class="self">self</span>.clear_diagnostics_state(); |
| <a href=#728 id=728 data-nosnippet>728</a> |
| <a href=#729 id=729 data-nosnippet>729</a> <span class="self">self</span>.report_progress(Progress::DidFinish(res)); |
| <a href=#730 id=730 data-nosnippet>730</a> } |
| <a href=#731 id=731 data-nosnippet>731</a> Event::CheckEvent(<span class="prelude-val">Some</span>(message)) => <span class="kw">match </span>message { |
| <a href=#732 id=732 data-nosnippet>732</a> CheckMessage::CompilerArtifact(msg) => { |
| <a href=#733 id=733 data-nosnippet>733</a> <span class="macro">tracing::trace!</span>( |
| <a href=#734 id=734 data-nosnippet>734</a> flycheck_id = <span class="self">self</span>.id, |
| <a href=#735 id=735 data-nosnippet>735</a> artifact = msg.target.name, |
| <a href=#736 id=736 data-nosnippet>736</a> package_id = msg.package_id.repr, |
| <a href=#737 id=737 data-nosnippet>737</a> <span class="string">"artifact received" |
| <a href=#738 id=738 data-nosnippet>738</a> </span>); |
| <a href=#739 id=739 data-nosnippet>739</a> <span class="self">self</span>.report_progress(Progress::DidCheckCrate(<span class="macro">format!</span>( |
| <a href=#740 id=740 data-nosnippet>740</a> <span class="string">"{} ({})"</span>, |
| <a href=#741 id=741 data-nosnippet>741</a> msg.target.name, |
| <a href=#742 id=742 data-nosnippet>742</a> msg.target.kind.iter().format_with(<span class="string">", "</span>, |kind, f| f(<span class="kw-2">&</span>kind)), |
| <a href=#743 id=743 data-nosnippet>743</a> ))); |
| <a href=#744 id=744 data-nosnippet>744</a> <span class="kw">let </span>package_id = Arc::new(msg.package_id); |
| <a href=#745 id=745 data-nosnippet>745</a> <span class="kw">if </span><span class="self">self |
| <a href=#746 id=746 data-nosnippet>746</a> </span>.diagnostics_cleared_for |
| <a href=#747 id=747 data-nosnippet>747</a> .insert(PackageSpecifier::Cargo { package_id: package_id.clone() }) |
| <a href=#748 id=748 data-nosnippet>748</a> { |
| <a href=#749 id=749 data-nosnippet>749</a> <span class="macro">tracing::trace!</span>( |
| <a href=#750 id=750 data-nosnippet>750</a> flycheck_id = <span class="self">self</span>.id, |
| <a href=#751 id=751 data-nosnippet>751</a> package_id = package_id.repr, |
| <a href=#752 id=752 data-nosnippet>752</a> <span class="string">"clearing diagnostics" |
| <a href=#753 id=753 data-nosnippet>753</a> </span>); |
| <a href=#754 id=754 data-nosnippet>754</a> <span class="self">self</span>.send(FlycheckMessage::ClearDiagnostics { |
| <a href=#755 id=755 data-nosnippet>755</a> id: <span class="self">self</span>.id, |
| <a href=#756 id=756 data-nosnippet>756</a> kind: ClearDiagnosticsKind::All(ClearScope::Package( |
| <a href=#757 id=757 data-nosnippet>757</a> PackageSpecifier::Cargo { package_id }, |
| <a href=#758 id=758 data-nosnippet>758</a> )), |
| <a href=#759 id=759 data-nosnippet>759</a> }); |
| <a href=#760 id=760 data-nosnippet>760</a> } |
| <a href=#761 id=761 data-nosnippet>761</a> } |
| <a href=#762 id=762 data-nosnippet>762</a> CheckMessage::Diagnostic { diagnostic, package_id } => { |
| <a href=#763 id=763 data-nosnippet>763</a> <span class="macro">tracing::trace!</span>( |
| <a href=#764 id=764 data-nosnippet>764</a> flycheck_id = <span class="self">self</span>.id, |
| <a href=#765 id=765 data-nosnippet>765</a> message = diagnostic.message, |
| <a href=#766 id=766 data-nosnippet>766</a> package_id = package_id.as_ref().map(|it| it.as_str()), |
| <a href=#767 id=767 data-nosnippet>767</a> <span class="string">"diagnostic received" |
| <a href=#768 id=768 data-nosnippet>768</a> </span>); |
| <a href=#769 id=769 data-nosnippet>769</a> <span class="kw">if </span><span class="self">self</span>.diagnostics_received == DiagnosticsReceived::NotYet { |
| <a href=#770 id=770 data-nosnippet>770</a> <span class="self">self</span>.diagnostics_received = DiagnosticsReceived::AtLeastOne; |
| <a href=#771 id=771 data-nosnippet>771</a> } |
| <a href=#772 id=772 data-nosnippet>772</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(package_id) = <span class="kw-2">&</span>package_id { |
| <a href=#773 id=773 data-nosnippet>773</a> <span class="kw">if </span><span class="self">self</span>.diagnostics_cleared_for.insert(package_id.clone()) { |
| <a href=#774 id=774 data-nosnippet>774</a> <span class="macro">tracing::trace!</span>( |
| <a href=#775 id=775 data-nosnippet>775</a> flycheck_id = <span class="self">self</span>.id, |
| <a href=#776 id=776 data-nosnippet>776</a> package_id = package_id.as_str(), |
| <a href=#777 id=777 data-nosnippet>777</a> <span class="string">"clearing diagnostics" |
| <a href=#778 id=778 data-nosnippet>778</a> </span>); |
| <a href=#779 id=779 data-nosnippet>779</a> <span class="self">self</span>.send(FlycheckMessage::ClearDiagnostics { |
| <a href=#780 id=780 data-nosnippet>780</a> id: <span class="self">self</span>.id, |
| <a href=#781 id=781 data-nosnippet>781</a> kind: ClearDiagnosticsKind::All(ClearScope::Package( |
| <a href=#782 id=782 data-nosnippet>782</a> package_id.clone(), |
| <a href=#783 id=783 data-nosnippet>783</a> )), |
| <a href=#784 id=784 data-nosnippet>784</a> }); |
| <a href=#785 id=785 data-nosnippet>785</a> } |
| <a href=#786 id=786 data-nosnippet>786</a> } <span class="kw">else if </span><span class="self">self</span>.<span class="macro">diagnostics_received |
| <a href=#787 id=787 data-nosnippet>787</a> !</span>= DiagnosticsReceived::AtLeastOneAndClearedWorkspace |
| <a href=#788 id=788 data-nosnippet>788</a> { |
| <a href=#789 id=789 data-nosnippet>789</a> <span class="self">self</span>.diagnostics_received = |
| <a href=#790 id=790 data-nosnippet>790</a> DiagnosticsReceived::AtLeastOneAndClearedWorkspace; |
| <a href=#791 id=791 data-nosnippet>791</a> <span class="self">self</span>.send(FlycheckMessage::ClearDiagnostics { |
| <a href=#792 id=792 data-nosnippet>792</a> id: <span class="self">self</span>.id, |
| <a href=#793 id=793 data-nosnippet>793</a> kind: ClearDiagnosticsKind::All(ClearScope::Workspace), |
| <a href=#794 id=794 data-nosnippet>794</a> }); |
| <a href=#795 id=795 data-nosnippet>795</a> } |
| <a href=#796 id=796 data-nosnippet>796</a> <span class="self">self</span>.send(FlycheckMessage::AddDiagnostic { |
| <a href=#797 id=797 data-nosnippet>797</a> id: <span class="self">self</span>.id, |
| <a href=#798 id=798 data-nosnippet>798</a> generation: <span class="self">self</span>.generation, |
| <a href=#799 id=799 data-nosnippet>799</a> package_id, |
| <a href=#800 id=800 data-nosnippet>800</a> workspace_root: <span class="self">self</span>.root.clone(), |
| <a href=#801 id=801 data-nosnippet>801</a> diagnostic, |
| <a href=#802 id=802 data-nosnippet>802</a> }); |
| <a href=#803 id=803 data-nosnippet>803</a> } |
| <a href=#804 id=804 data-nosnippet>804</a> }, |
| <a href=#805 id=805 data-nosnippet>805</a> } |
| <a href=#806 id=806 data-nosnippet>806</a> } |
| <a href=#807 id=807 data-nosnippet>807</a> <span class="comment">// If we rerun the thread, we need to discard the previous check results first |
| <a href=#808 id=808 data-nosnippet>808</a> </span><span class="self">self</span>.cancel_check_process(); |
| <a href=#809 id=809 data-nosnippet>809</a> } |
| <a href=#810 id=810 data-nosnippet>810</a> |
| <a href=#811 id=811 data-nosnippet>811</a> <span class="kw">fn </span>cancel_check_process(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#812 id=812 data-nosnippet>812</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(command_handle) = <span class="self">self</span>.command_handle.take() { |
| <a href=#813 id=813 data-nosnippet>813</a> <span class="macro">tracing::debug!</span>( |
| <a href=#814 id=814 data-nosnippet>814</a> command = <span class="question-mark">?</span>command_handle, |
| <a href=#815 id=815 data-nosnippet>815</a> <span class="string">"did cancel flycheck" |
| <a href=#816 id=816 data-nosnippet>816</a> </span>); |
| <a href=#817 id=817 data-nosnippet>817</a> command_handle.cancel(); |
| <a href=#818 id=818 data-nosnippet>818</a> <span class="self">self</span>.command_receiver.take(); |
| <a href=#819 id=819 data-nosnippet>819</a> <span class="self">self</span>.report_progress(Progress::DidCancel); |
| <a href=#820 id=820 data-nosnippet>820</a> } |
| <a href=#821 id=821 data-nosnippet>821</a> <span class="self">self</span>.clear_diagnostics_state(); |
| <a href=#822 id=822 data-nosnippet>822</a> } |
| <a href=#823 id=823 data-nosnippet>823</a> |
| <a href=#824 id=824 data-nosnippet>824</a> <span class="kw">fn </span>clear_diagnostics_state(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <a href=#825 id=825 data-nosnippet>825</a> <span class="self">self</span>.diagnostics_cleared_for.clear(); |
| <a href=#826 id=826 data-nosnippet>826</a> <span class="self">self</span>.diagnostics_received = DiagnosticsReceived::NotYet; |
| <a href=#827 id=827 data-nosnippet>827</a> } |
| <a href=#828 id=828 data-nosnippet>828</a> |
| <a href=#829 id=829 data-nosnippet>829</a> <span class="kw">fn </span>explicit_check_command( |
| <a href=#830 id=830 data-nosnippet>830</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#831 id=831 data-nosnippet>831</a> scope: <span class="kw-2">&</span>FlycheckScope, |
| <a href=#832 id=832 data-nosnippet>832</a> saved_file: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>AbsPath>, |
| <a href=#833 id=833 data-nosnippet>833</a> ) -> <span class="prelude-ty">Option</span><Command> { |
| <a href=#834 id=834 data-nosnippet>834</a> <span class="kw">let </span>label = <span class="kw">match </span>scope { |
| <a href=#835 id=835 data-nosnippet>835</a> <span class="comment">// We could add a runnable like "RunnableKind::FlycheckWorkspace". But generally |
| <a href=#836 id=836 data-nosnippet>836</a> // if you're not running cargo, it's because your workspace is too big to check |
| <a href=#837 id=837 data-nosnippet>837</a> // all at once. You can always use `check_overrideCommand` with no {label}. |
| <a href=#838 id=838 data-nosnippet>838</a> </span>FlycheckScope::Workspace => <span class="kw">return </span><span class="prelude-val">None</span>, |
| <a href=#839 id=839 data-nosnippet>839</a> FlycheckScope::Package { package: PackageSpecifier::BuildInfo { label }, .. } => { |
| <a href=#840 id=840 data-nosnippet>840</a> label.as_str() |
| <a href=#841 id=841 data-nosnippet>841</a> } |
| <a href=#842 id=842 data-nosnippet>842</a> FlycheckScope::Package { |
| <a href=#843 id=843 data-nosnippet>843</a> package: PackageSpecifier::Cargo { package_id: label }, |
| <a href=#844 id=844 data-nosnippet>844</a> .. |
| <a href=#845 id=845 data-nosnippet>845</a> } => <span class="kw-2">&</span>label.repr, |
| <a href=#846 id=846 data-nosnippet>846</a> }; |
| <a href=#847 id=847 data-nosnippet>847</a> <span class="kw">let </span>template = <span class="self">self</span>.config_json.single_template.as_ref()<span class="question-mark">?</span>; |
| <a href=#848 id=848 data-nosnippet>848</a> <span class="kw">let </span>subs = Substitutions { label: <span class="prelude-val">Some</span>(label), saved_file: saved_file.map(|x| x.as_str()) }; |
| <a href=#849 id=849 data-nosnippet>849</a> subs.substitute(template, <span class="kw-2">&</span>FxHashMap::default()) |
| <a href=#850 id=850 data-nosnippet>850</a> } |
| <a href=#851 id=851 data-nosnippet>851</a> |
| <a href=#852 id=852 data-nosnippet>852</a> <span class="doccomment">/// Construct a `Command` object for checking the user's code. If the user |
| <a href=#853 id=853 data-nosnippet>853</a> /// has specified a custom command with placeholders that we cannot fill, |
| <a href=#854 id=854 data-nosnippet>854</a> /// return None. |
| <a href=#855 id=855 data-nosnippet>855</a> </span><span class="kw">fn </span>check_command( |
| <a href=#856 id=856 data-nosnippet>856</a> <span class="kw-2">&</span><span class="self">self</span>, |
| <a href=#857 id=857 data-nosnippet>857</a> scope: <span class="kw-2">&</span>FlycheckScope, |
| <a href=#858 id=858 data-nosnippet>858</a> saved_file: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>AbsPath>, |
| <a href=#859 id=859 data-nosnippet>859</a> target: <span class="prelude-ty">Option</span><Target>, |
| <a href=#860 id=860 data-nosnippet>860</a> ) -> <span class="prelude-ty">Option</span><(Command, FlycheckCommandOrigin)> { |
| <a href=#861 id=861 data-nosnippet>861</a> <span class="kw">match </span><span class="kw-2">&</span><span class="self">self</span>.config { |
| <a href=#862 id=862 data-nosnippet>862</a> FlycheckConfig::Automatic { cargo_options, ansi_color_output } => { |
| <a href=#863 id=863 data-nosnippet>863</a> <span class="comment">// Only use the rust-project.json's flycheck config when no check_overrideCommand |
| <a href=#864 id=864 data-nosnippet>864</a> // is configured. In the FlycheckConcig::CustomCommand branch we will still do |
| <a href=#865 id=865 data-nosnippet>865</a> // label substitution, but on the overrideCommand instead. |
| <a href=#866 id=866 data-nosnippet>866</a> // |
| <a href=#867 id=867 data-nosnippet>867</a> // There needs to be SOME way to override what your discoverConfig tool says, |
| <a href=#868 id=868 data-nosnippet>868</a> // because to change the flycheck runnable there you may have to literally |
| <a href=#869 id=869 data-nosnippet>869</a> // recompile the tool. |
| <a href=#870 id=870 data-nosnippet>870</a> </span><span class="kw">if </span><span class="self">self</span>.config_json.any_configured() { |
| <a href=#871 id=871 data-nosnippet>871</a> <span class="comment">// Completely handle according to rust-project.json. |
| <a href=#872 id=872 data-nosnippet>872</a> // We don't consider this to be "using cargo" so we will not apply any of the |
| <a href=#873 id=873 data-nosnippet>873</a> // CargoOptions to the command. |
| <a href=#874 id=874 data-nosnippet>874</a> </span><span class="kw">let </span>cmd = <span class="self">self</span>.explicit_check_command(scope, saved_file)<span class="question-mark">?</span>; |
| <a href=#875 id=875 data-nosnippet>875</a> <span class="kw">return </span><span class="prelude-val">Some</span>((cmd, FlycheckCommandOrigin::ProjectJsonRunnable)); |
| <a href=#876 id=876 data-nosnippet>876</a> } |
| <a href=#877 id=877 data-nosnippet>877</a> |
| <a href=#878 id=878 data-nosnippet>878</a> <span class="kw">let </span><span class="kw-2">mut </span>cmd = |
| <a href=#879 id=879 data-nosnippet>879</a> toolchain::command(Tool::Cargo.path(), <span class="kw-2">&*</span><span class="self">self</span>.root, <span class="kw-2">&</span>cargo_options.extra_env); |
| <a href=#880 id=880 data-nosnippet>880</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(sysroot_root) = <span class="kw-2">&</span><span class="self">self</span>.sysroot_root |
| <a href=#881 id=881 data-nosnippet>881</a> && !cargo_options.extra_env.contains_key(<span class="string">"RUSTUP_TOOLCHAIN"</span>) |
| <a href=#882 id=882 data-nosnippet>882</a> && std::env::var_os(<span class="string">"RUSTUP_TOOLCHAIN"</span>).is_none() |
| <a href=#883 id=883 data-nosnippet>883</a> { |
| <a href=#884 id=884 data-nosnippet>884</a> cmd.env(<span class="string">"RUSTUP_TOOLCHAIN"</span>, AsRef::<std::path::Path>::as_ref(sysroot_root)); |
| <a href=#885 id=885 data-nosnippet>885</a> } |
| <a href=#886 id=886 data-nosnippet>886</a> cmd.env(<span class="string">"CARGO_LOG"</span>, <span class="string">"cargo::core::compiler::fingerprint=info"</span>); |
| <a href=#887 id=887 data-nosnippet>887</a> cmd.arg(<span class="kw-2">&</span>cargo_options.subcommand); |
| <a href=#888 id=888 data-nosnippet>888</a> |
| <a href=#889 id=889 data-nosnippet>889</a> <span class="kw">match </span>scope { |
| <a href=#890 id=890 data-nosnippet>890</a> FlycheckScope::Workspace => cmd.arg(<span class="string">"--workspace"</span>), |
| <a href=#891 id=891 data-nosnippet>891</a> FlycheckScope::Package { |
| <a href=#892 id=892 data-nosnippet>892</a> package: PackageSpecifier::Cargo { package_id }, |
| <a href=#893 id=893 data-nosnippet>893</a> .. |
| <a href=#894 id=894 data-nosnippet>894</a> } => cmd.arg(<span class="string">"-p"</span>).arg(<span class="kw-2">&</span>package_id.repr), |
| <a href=#895 id=895 data-nosnippet>895</a> FlycheckScope::Package { |
| <a href=#896 id=896 data-nosnippet>896</a> package: PackageSpecifier::BuildInfo { .. }, .. |
| <a href=#897 id=897 data-nosnippet>897</a> } => { |
| <a href=#898 id=898 data-nosnippet>898</a> <span class="comment">// No way to flycheck this single package. All we have is a build label. |
| <a href=#899 id=899 data-nosnippet>899</a> // There's no way to really say whether this build label happens to be |
| <a href=#900 id=900 data-nosnippet>900</a> // a cargo canonical name, so we won't try. |
| <a href=#901 id=901 data-nosnippet>901</a> </span><span class="kw">return </span><span class="prelude-val">None</span>; |
| <a href=#902 id=902 data-nosnippet>902</a> } |
| <a href=#903 id=903 data-nosnippet>903</a> }; |
| <a href=#904 id=904 data-nosnippet>904</a> |
| <a href=#905 id=905 data-nosnippet>905</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(tgt) = target { |
| <a href=#906 id=906 data-nosnippet>906</a> <span class="kw">match </span>tgt { |
| <a href=#907 id=907 data-nosnippet>907</a> Target::Bin(tgt) => cmd.arg(<span class="string">"--bin"</span>).arg(tgt), |
| <a href=#908 id=908 data-nosnippet>908</a> Target::Example(tgt) => cmd.arg(<span class="string">"--example"</span>).arg(tgt), |
| <a href=#909 id=909 data-nosnippet>909</a> Target::Test(tgt) => cmd.arg(<span class="string">"--test"</span>).arg(tgt), |
| <a href=#910 id=910 data-nosnippet>910</a> Target::Benchmark(tgt) => cmd.arg(<span class="string">"--bench"</span>).arg(tgt), |
| <a href=#911 id=911 data-nosnippet>911</a> }; |
| <a href=#912 id=912 data-nosnippet>912</a> } |
| <a href=#913 id=913 data-nosnippet>913</a> |
| <a href=#914 id=914 data-nosnippet>914</a> cmd.arg(<span class="kw">if </span><span class="kw-2">*</span>ansi_color_output { |
| <a href=#915 id=915 data-nosnippet>915</a> <span class="string">"--message-format=json-diagnostic-rendered-ansi" |
| <a href=#916 id=916 data-nosnippet>916</a> </span>} <span class="kw">else </span>{ |
| <a href=#917 id=917 data-nosnippet>917</a> <span class="string">"--message-format=json" |
| <a href=#918 id=918 data-nosnippet>918</a> </span>}); |
| <a href=#919 id=919 data-nosnippet>919</a> |
| <a href=#920 id=920 data-nosnippet>920</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(manifest_path) = <span class="kw-2">&</span><span class="self">self</span>.manifest_path { |
| <a href=#921 id=921 data-nosnippet>921</a> cmd.arg(<span class="string">"--manifest-path"</span>); |
| <a href=#922 id=922 data-nosnippet>922</a> cmd.arg(manifest_path); |
| <a href=#923 id=923 data-nosnippet>923</a> <span class="kw">if </span>manifest_path.extension() == <span class="prelude-val">Some</span>(<span class="string">"rs"</span>) { |
| <a href=#924 id=924 data-nosnippet>924</a> cmd.env(<span class="string">"__CARGO_TEST_CHANNEL_OVERRIDE_DO_NOT_USE_THIS"</span>, <span class="string">"nightly"</span>); |
| <a href=#925 id=925 data-nosnippet>925</a> cmd.arg(<span class="string">"-Zscript"</span>); |
| <a href=#926 id=926 data-nosnippet>926</a> } |
| <a href=#927 id=927 data-nosnippet>927</a> } |
| <a href=#928 id=928 data-nosnippet>928</a> |
| <a href=#929 id=929 data-nosnippet>929</a> cmd.arg(<span class="string">"--keep-going"</span>); |
| <a href=#930 id=930 data-nosnippet>930</a> |
| <a href=#931 id=931 data-nosnippet>931</a> cargo_options.apply_on_command( |
| <a href=#932 id=932 data-nosnippet>932</a> <span class="kw-2">&mut </span>cmd, |
| <a href=#933 id=933 data-nosnippet>933</a> <span class="self">self</span>.ws_target_dir.as_ref().map(Utf8PathBuf::as_path), |
| <a href=#934 id=934 data-nosnippet>934</a> ); |
| <a href=#935 id=935 data-nosnippet>935</a> cmd.args(<span class="kw-2">&</span>cargo_options.extra_args); |
| <a href=#936 id=936 data-nosnippet>936</a> <span class="prelude-val">Some</span>((cmd, FlycheckCommandOrigin::Cargo)) |
| <a href=#937 id=937 data-nosnippet>937</a> } |
| <a href=#938 id=938 data-nosnippet>938</a> FlycheckConfig::CustomCommand { command, args, extra_env, invocation_strategy } => { |
| <a href=#939 id=939 data-nosnippet>939</a> <span class="kw">let </span>root = <span class="kw">match </span>invocation_strategy { |
| <a href=#940 id=940 data-nosnippet>940</a> InvocationStrategy::Once => <span class="kw-2">&*</span><span class="self">self</span>.root, |
| <a href=#941 id=941 data-nosnippet>941</a> InvocationStrategy::PerWorkspace => { |
| <a href=#942 id=942 data-nosnippet>942</a> <span class="comment">// FIXME: &affected_workspace |
| <a href=#943 id=943 data-nosnippet>943</a> </span><span class="kw-2">&*</span><span class="self">self</span>.root |
| <a href=#944 id=944 data-nosnippet>944</a> } |
| <a href=#945 id=945 data-nosnippet>945</a> }; |
| <a href=#946 id=946 data-nosnippet>946</a> <span class="kw">let </span>runnable = project_json::Runnable { |
| <a href=#947 id=947 data-nosnippet>947</a> program: command.clone(), |
| <a href=#948 id=948 data-nosnippet>948</a> cwd: Utf8Path::to_owned(root.as_ref()), |
| <a href=#949 id=949 data-nosnippet>949</a> args: args.clone(), |
| <a href=#950 id=950 data-nosnippet>950</a> kind: project_json::RunnableKind::Flycheck, |
| <a href=#951 id=951 data-nosnippet>951</a> }; |
| <a href=#952 id=952 data-nosnippet>952</a> |
| <a href=#953 id=953 data-nosnippet>953</a> <span class="kw">let </span>label = <span class="kw">match </span>scope { |
| <a href=#954 id=954 data-nosnippet>954</a> FlycheckScope::Workspace => <span class="prelude-val">None</span>, |
| <a href=#955 id=955 data-nosnippet>955</a> <span class="comment">// We support substituting both build labels (e.g. buck, bazel) and cargo package ids. |
| <a href=#956 id=956 data-nosnippet>956</a> // With cargo package ids, you get `cargo check -p path+file:///path/to/rust-analyzer/crates/hir#0.0.0`. |
| <a href=#957 id=957 data-nosnippet>957</a> // That does work! |
| <a href=#958 id=958 data-nosnippet>958</a> </span>FlycheckScope::Package { package, .. } => <span class="prelude-val">Some</span>(package.as_str()), |
| <a href=#959 id=959 data-nosnippet>959</a> }; |
| <a href=#960 id=960 data-nosnippet>960</a> |
| <a href=#961 id=961 data-nosnippet>961</a> <span class="kw">let </span>subs = Substitutions { label, saved_file: saved_file.map(|x| x.as_str()) }; |
| <a href=#962 id=962 data-nosnippet>962</a> <span class="kw">let </span>cmd = subs.substitute(<span class="kw-2">&</span>runnable, extra_env)<span class="question-mark">?</span>; |
| <a href=#963 id=963 data-nosnippet>963</a> |
| <a href=#964 id=964 data-nosnippet>964</a> <span class="prelude-val">Some</span>((cmd, FlycheckCommandOrigin::CheckOverrideCommand)) |
| <a href=#965 id=965 data-nosnippet>965</a> } |
| <a href=#966 id=966 data-nosnippet>966</a> } |
| <a href=#967 id=967 data-nosnippet>967</a> } |
| <a href=#968 id=968 data-nosnippet>968</a> |
| <a href=#969 id=969 data-nosnippet>969</a> <span class="attr">#[track_caller] |
| <a href=#970 id=970 data-nosnippet>970</a> </span><span class="kw">fn </span>send(<span class="kw-2">&</span><span class="self">self</span>, check_task: FlycheckMessage) { |
| <a href=#971 id=971 data-nosnippet>971</a> <span class="self">self</span>.sender.send(check_task).unwrap(); |
| <a href=#972 id=972 data-nosnippet>972</a> } |
| <a href=#973 id=973 data-nosnippet>973</a>} |
| <a href=#974 id=974 data-nosnippet>974</a> |
| <a href=#975 id=975 data-nosnippet>975</a><span class="attr">#[allow(clippy::large_enum_variant)] |
| <a href=#976 id=976 data-nosnippet>976</a>#[derive(Debug)] |
| <a href=#977 id=977 data-nosnippet>977</a></span><span class="kw">enum </span>CheckMessage { |
| <a href=#978 id=978 data-nosnippet>978</a> <span class="doccomment">/// A message from `cargo check`, including details like the path |
| <a href=#979 id=979 data-nosnippet>979</a> /// to the relevant `Cargo.toml`. |
| <a href=#980 id=980 data-nosnippet>980</a> </span>CompilerArtifact(cargo_metadata::Artifact), |
| <a href=#981 id=981 data-nosnippet>981</a> <span class="doccomment">/// A diagnostic message from rustc itself. |
| <a href=#982 id=982 data-nosnippet>982</a> </span>Diagnostic { diagnostic: Diagnostic, package_id: <span class="prelude-ty">Option</span><PackageSpecifier> }, |
| <a href=#983 id=983 data-nosnippet>983</a>} |
| <a href=#984 id=984 data-nosnippet>984</a> |
| <a href=#985 id=985 data-nosnippet>985</a><span class="kw">struct </span>CheckParser; |
| <a href=#986 id=986 data-nosnippet>986</a> |
| <a href=#987 id=987 data-nosnippet>987</a><span class="kw">impl </span>JsonLinesParser<CheckMessage> <span class="kw">for </span>CheckParser { |
| <a href=#988 id=988 data-nosnippet>988</a> <span class="kw">fn </span>from_line(<span class="kw-2">&</span><span class="self">self</span>, line: <span class="kw-2">&</span>str, error: <span class="kw-2">&mut </span>String) -> <span class="prelude-ty">Option</span><CheckMessage> { |
| <a href=#989 id=989 data-nosnippet>989</a> <span class="kw">let </span><span class="kw-2">mut </span>deserializer = serde_json::Deserializer::from_str(line); |
| <a href=#990 id=990 data-nosnippet>990</a> deserializer.disable_recursion_limit(); |
| <a href=#991 id=991 data-nosnippet>991</a> <span class="kw">if let </span><span class="prelude-val">Ok</span>(message) = JsonMessage::deserialize(<span class="kw-2">&mut </span>deserializer) { |
| <a href=#992 id=992 data-nosnippet>992</a> <span class="kw">return match </span>message { |
| <a href=#993 id=993 data-nosnippet>993</a> <span class="comment">// Skip certain kinds of messages to only spend time on what's useful |
| <a href=#994 id=994 data-nosnippet>994</a> </span>JsonMessage::Cargo(message) => <span class="kw">match </span>message { |
| <a href=#995 id=995 data-nosnippet>995</a> cargo_metadata::Message::CompilerArtifact(artifact) <span class="kw">if </span>!artifact.fresh => { |
| <a href=#996 id=996 data-nosnippet>996</a> <span class="prelude-val">Some</span>(CheckMessage::CompilerArtifact(artifact)) |
| <a href=#997 id=997 data-nosnippet>997</a> } |
| <a href=#998 id=998 data-nosnippet>998</a> cargo_metadata::Message::CompilerMessage(msg) => { |
| <a href=#999 id=999 data-nosnippet>999</a> <span class="prelude-val">Some</span>(CheckMessage::Diagnostic { |
| <a href=#1000 id=1000 data-nosnippet>1000</a> diagnostic: msg.message, |
| <a href=#1001 id=1001 data-nosnippet>1001</a> package_id: <span class="prelude-val">Some</span>(PackageSpecifier::Cargo { |
| <a href=#1002 id=1002 data-nosnippet>1002</a> package_id: Arc::new(msg.package_id), |
| <a href=#1003 id=1003 data-nosnippet>1003</a> }), |
| <a href=#1004 id=1004 data-nosnippet>1004</a> }) |
| <a href=#1005 id=1005 data-nosnippet>1005</a> } |
| <a href=#1006 id=1006 data-nosnippet>1006</a> <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| <a href=#1007 id=1007 data-nosnippet>1007</a> }, |
| <a href=#1008 id=1008 data-nosnippet>1008</a> JsonMessage::Rustc(message) => { |
| <a href=#1009 id=1009 data-nosnippet>1009</a> <span class="prelude-val">Some</span>(CheckMessage::Diagnostic { diagnostic: message, package_id: <span class="prelude-val">None </span>}) |
| <a href=#1010 id=1010 data-nosnippet>1010</a> } |
| <a href=#1011 id=1011 data-nosnippet>1011</a> }; |
| <a href=#1012 id=1012 data-nosnippet>1012</a> } |
| <a href=#1013 id=1013 data-nosnippet>1013</a> |
| <a href=#1014 id=1014 data-nosnippet>1014</a> error.push_str(line); |
| <a href=#1015 id=1015 data-nosnippet>1015</a> error.push(<span class="string">'\n'</span>); |
| <a href=#1016 id=1016 data-nosnippet>1016</a> <span class="prelude-val">None |
| <a href=#1017 id=1017 data-nosnippet>1017</a> </span>} |
| <a href=#1018 id=1018 data-nosnippet>1018</a> |
| <a href=#1019 id=1019 data-nosnippet>1019</a> <span class="kw">fn </span>from_eof(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><CheckMessage> { |
| <a href=#1020 id=1020 data-nosnippet>1020</a> <span class="prelude-val">None |
| <a href=#1021 id=1021 data-nosnippet>1021</a> </span>} |
| <a href=#1022 id=1022 data-nosnippet>1022</a>} |
| <a href=#1023 id=1023 data-nosnippet>1023</a> |
| <a href=#1024 id=1024 data-nosnippet>1024</a><span class="attr">#[derive(Deserialize)] |
| <a href=#1025 id=1025 data-nosnippet>1025</a>#[serde(untagged)] |
| <a href=#1026 id=1026 data-nosnippet>1026</a></span><span class="kw">enum </span>JsonMessage { |
| <a href=#1027 id=1027 data-nosnippet>1027</a> Cargo(cargo_metadata::Message), |
| <a href=#1028 id=1028 data-nosnippet>1028</a> Rustc(Diagnostic), |
| <a href=#1029 id=1029 data-nosnippet>1029</a>} |
| <a href=#1030 id=1030 data-nosnippet>1030</a> |
| <a href=#1031 id=1031 data-nosnippet>1031</a><span class="attr">#[cfg(test)] |
| <a href=#1032 id=1032 data-nosnippet>1032</a></span><span class="kw">mod </span>tests { |
| <a href=#1033 id=1033 data-nosnippet>1033</a> <span class="kw">use </span>super::<span class="kw-2">*</span>; |
| <a href=#1034 id=1034 data-nosnippet>1034</a> <span class="kw">use </span>ide_db::FxHashMap; |
| <a href=#1035 id=1035 data-nosnippet>1035</a> <span class="kw">use </span>itertools::Itertools; |
| <a href=#1036 id=1036 data-nosnippet>1036</a> <span class="kw">use </span>paths::Utf8Path; |
| <a href=#1037 id=1037 data-nosnippet>1037</a> <span class="kw">use </span>project_model::project_json; |
| <a href=#1038 id=1038 data-nosnippet>1038</a> |
| <a href=#1039 id=1039 data-nosnippet>1039</a> <span class="attr">#[test] |
| <a href=#1040 id=1040 data-nosnippet>1040</a> </span><span class="kw">fn </span>test_substitutions() { |
| <a href=#1041 id=1041 data-nosnippet>1041</a> <span class="kw">let </span>label = <span class="string">":label"</span>; |
| <a href=#1042 id=1042 data-nosnippet>1042</a> <span class="kw">let </span>saved_file = <span class="string">"file.rs"</span>; |
| <a href=#1043 id=1043 data-nosnippet>1043</a> |
| <a href=#1044 id=1044 data-nosnippet>1044</a> <span class="comment">// Runnable says it needs both; you need both. |
| <a href=#1045 id=1045 data-nosnippet>1045</a> </span><span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">None</span>, <span class="string">"{label} {saved_file}"</span>).as_deref(), <span class="prelude-val">None</span>); |
| <a href=#1046 id=1046 data-nosnippet>1046</a> <span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">None</span>, <span class="string">"{label} {saved_file}"</span>).as_deref(), <span class="prelude-val">None</span>); |
| <a href=#1047 id=1047 data-nosnippet>1047</a> <span class="macro">assert_eq!</span>( |
| <a href=#1048 id=1048 data-nosnippet>1048</a> test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(saved_file), <span class="string">"{label} {saved_file}"</span>).as_deref(), |
| <a href=#1049 id=1049 data-nosnippet>1049</a> <span class="prelude-val">None |
| <a href=#1050 id=1050 data-nosnippet>1050</a> </span>); |
| <a href=#1051 id=1051 data-nosnippet>1051</a> <span class="macro">assert_eq!</span>( |
| <a href=#1052 id=1052 data-nosnippet>1052</a> test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">Some</span>(saved_file), <span class="string">"{label} {saved_file}"</span>).as_deref(), |
| <a href=#1053 id=1053 data-nosnippet>1053</a> <span class="prelude-val">Some</span>(<span class="string">"build :label file.rs"</span>) |
| <a href=#1054 id=1054 data-nosnippet>1054</a> ); |
| <a href=#1055 id=1055 data-nosnippet>1055</a> |
| <a href=#1056 id=1056 data-nosnippet>1056</a> <span class="comment">// Only need label? only need label. |
| <a href=#1057 id=1057 data-nosnippet>1057</a> </span><span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">None</span>, <span class="string">"{label}"</span>).as_deref(), <span class="prelude-val">None</span>); |
| <a href=#1058 id=1058 data-nosnippet>1058</a> <span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">None</span>, <span class="string">"{label}"</span>).as_deref(), <span class="prelude-val">Some</span>(<span class="string">"build :label"</span>),); |
| <a href=#1059 id=1059 data-nosnippet>1059</a> <span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(saved_file), <span class="string">"{label}"</span>).as_deref(), <span class="prelude-val">None</span>,); |
| <a href=#1060 id=1060 data-nosnippet>1060</a> <span class="macro">assert_eq!</span>( |
| <a href=#1061 id=1061 data-nosnippet>1061</a> test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">Some</span>(saved_file), <span class="string">"{label}"</span>).as_deref(), |
| <a href=#1062 id=1062 data-nosnippet>1062</a> <span class="prelude-val">Some</span>(<span class="string">"build :label"</span>), |
| <a href=#1063 id=1063 data-nosnippet>1063</a> ); |
| <a href=#1064 id=1064 data-nosnippet>1064</a> |
| <a href=#1065 id=1065 data-nosnippet>1065</a> <span class="comment">// Only need saved_file |
| <a href=#1066 id=1066 data-nosnippet>1066</a> </span><span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">None</span>, <span class="string">"{saved_file}"</span>).as_deref(), <span class="prelude-val">None</span>); |
| <a href=#1067 id=1067 data-nosnippet>1067</a> <span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">None</span>, <span class="string">"{saved_file}"</span>).as_deref(), <span class="prelude-val">None</span>); |
| <a href=#1068 id=1068 data-nosnippet>1068</a> <span class="macro">assert_eq!</span>( |
| <a href=#1069 id=1069 data-nosnippet>1069</a> test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(saved_file), <span class="string">"{saved_file}"</span>).as_deref(), |
| <a href=#1070 id=1070 data-nosnippet>1070</a> <span class="prelude-val">Some</span>(<span class="string">"build file.rs"</span>) |
| <a href=#1071 id=1071 data-nosnippet>1071</a> ); |
| <a href=#1072 id=1072 data-nosnippet>1072</a> <span class="macro">assert_eq!</span>( |
| <a href=#1073 id=1073 data-nosnippet>1073</a> test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">Some</span>(saved_file), <span class="string">"{saved_file}"</span>).as_deref(), |
| <a href=#1074 id=1074 data-nosnippet>1074</a> <span class="prelude-val">Some</span>(<span class="string">"build file.rs"</span>) |
| <a href=#1075 id=1075 data-nosnippet>1075</a> ); |
| <a href=#1076 id=1076 data-nosnippet>1076</a> |
| <a href=#1077 id=1077 data-nosnippet>1077</a> <span class="comment">// Need neither |
| <a href=#1078 id=1078 data-nosnippet>1078</a> </span><span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">None</span>, <span class="string">"xxx"</span>).as_deref(), <span class="prelude-val">Some</span>(<span class="string">"build xxx"</span>)); |
| <a href=#1079 id=1079 data-nosnippet>1079</a> <span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">None</span>, <span class="string">"xxx"</span>).as_deref(), <span class="prelude-val">Some</span>(<span class="string">"build xxx"</span>)); |
| <a href=#1080 id=1080 data-nosnippet>1080</a> <span class="macro">assert_eq!</span>(test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(saved_file), <span class="string">"xxx"</span>).as_deref(), <span class="prelude-val">Some</span>(<span class="string">"build xxx"</span>)); |
| <a href=#1081 id=1081 data-nosnippet>1081</a> <span class="macro">assert_eq!</span>( |
| <a href=#1082 id=1082 data-nosnippet>1082</a> test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">Some</span>(saved_file), <span class="string">"xxx"</span>).as_deref(), |
| <a href=#1083 id=1083 data-nosnippet>1083</a> <span class="prelude-val">Some</span>(<span class="string">"build xxx"</span>) |
| <a href=#1084 id=1084 data-nosnippet>1084</a> ); |
| <a href=#1085 id=1085 data-nosnippet>1085</a> |
| <a href=#1086 id=1086 data-nosnippet>1086</a> <span class="comment">// {label} mid-argument substitution |
| <a href=#1087 id=1087 data-nosnippet>1087</a> </span><span class="macro">assert_eq!</span>( |
| <a href=#1088 id=1088 data-nosnippet>1088</a> test_substitute(<span class="prelude-val">Some</span>(label), <span class="prelude-val">None</span>, <span class="string">"--label={label}"</span>).as_deref(), |
| <a href=#1089 id=1089 data-nosnippet>1089</a> <span class="prelude-val">Some</span>(<span class="string">"build --label=:label"</span>) |
| <a href=#1090 id=1090 data-nosnippet>1090</a> ); |
| <a href=#1091 id=1091 data-nosnippet>1091</a> |
| <a href=#1092 id=1092 data-nosnippet>1092</a> <span class="comment">// {saved_file} mid-argument substitution |
| <a href=#1093 id=1093 data-nosnippet>1093</a> </span><span class="macro">assert_eq!</span>( |
| <a href=#1094 id=1094 data-nosnippet>1094</a> test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(saved_file), <span class="string">"--saved={saved_file}"</span>).as_deref(), |
| <a href=#1095 id=1095 data-nosnippet>1095</a> <span class="prelude-val">Some</span>(<span class="string">"build --saved=file.rs"</span>) |
| <a href=#1096 id=1096 data-nosnippet>1096</a> ); |
| <a href=#1097 id=1097 data-nosnippet>1097</a> |
| <a href=#1098 id=1098 data-nosnippet>1098</a> <span class="comment">// $saved_file legacy support (no mid-argument substitution, we never supported that) |
| <a href=#1099 id=1099 data-nosnippet>1099</a> </span><span class="macro">assert_eq!</span>( |
| <a href=#1100 id=1100 data-nosnippet>1100</a> test_substitute(<span class="prelude-val">None</span>, <span class="prelude-val">Some</span>(saved_file), <span class="string">"$saved_file"</span>).as_deref(), |
| <a href=#1101 id=1101 data-nosnippet>1101</a> <span class="prelude-val">Some</span>(<span class="string">"build file.rs"</span>) |
| <a href=#1102 id=1102 data-nosnippet>1102</a> ); |
| <a href=#1103 id=1103 data-nosnippet>1103</a> |
| <a href=#1104 id=1104 data-nosnippet>1104</a> <span class="kw">fn </span>test_substitute( |
| <a href=#1105 id=1105 data-nosnippet>1105</a> label: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>, |
| <a href=#1106 id=1106 data-nosnippet>1106</a> saved_file: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>, |
| <a href=#1107 id=1107 data-nosnippet>1107</a> args: <span class="kw-2">&</span>str, |
| <a href=#1108 id=1108 data-nosnippet>1108</a> ) -> <span class="prelude-ty">Option</span><String> { |
| <a href=#1109 id=1109 data-nosnippet>1109</a> Substitutions { label, saved_file } |
| <a href=#1110 id=1110 data-nosnippet>1110</a> .substitute( |
| <a href=#1111 id=1111 data-nosnippet>1111</a> <span class="kw-2">&</span>project_json::Runnable { |
| <a href=#1112 id=1112 data-nosnippet>1112</a> program: <span class="string">"build"</span>.to_owned(), |
| <a href=#1113 id=1113 data-nosnippet>1113</a> args: Vec::from_iter(args.split_whitespace().map(ToOwned::to_owned)), |
| <a href=#1114 id=1114 data-nosnippet>1114</a> cwd: Utf8Path::new(<span class="string">"/path"</span>).to_owned(), |
| <a href=#1115 id=1115 data-nosnippet>1115</a> kind: project_json::RunnableKind::Flycheck, |
| <a href=#1116 id=1116 data-nosnippet>1116</a> }, |
| <a href=#1117 id=1117 data-nosnippet>1117</a> <span class="kw-2">&</span>FxHashMap::default(), |
| <a href=#1118 id=1118 data-nosnippet>1118</a> ) |
| <a href=#1119 id=1119 data-nosnippet>1119</a> .map(|command| { |
| <a href=#1120 id=1120 data-nosnippet>1120</a> command.get_args().map(|x| x.to_string_lossy()).collect_vec().join(<span class="string">" "</span>) |
| <a href=#1121 id=1121 data-nosnippet>1121</a> }) |
| <a href=#1122 id=1122 data-nosnippet>1122</a> .map(|args| <span class="macro">format!</span>(<span class="string">"build {}"</span>, args)) |
| <a href=#1123 id=1123 data-nosnippet>1123</a> } |
| <a href=#1124 id=1124 data-nosnippet>1124</a> } |
| <a href=#1125 id=1125 data-nosnippet>1125</a> |
| <a href=#1126 id=1126 data-nosnippet>1126</a> <span class="attr">#[test] |
| <a href=#1127 id=1127 data-nosnippet>1127</a> </span><span class="kw">fn </span>test_flycheck_config_display() { |
| <a href=#1128 id=1128 data-nosnippet>1128</a> <span class="kw">let </span>clippy = FlycheckConfig::Automatic { |
| <a href=#1129 id=1129 data-nosnippet>1129</a> cargo_options: CargoOptions { |
| <a href=#1130 id=1130 data-nosnippet>1130</a> subcommand: <span class="string">"clippy"</span>.to_owned(), |
| <a href=#1131 id=1131 data-nosnippet>1131</a> target_tuples: <span class="macro">vec!</span>[], |
| <a href=#1132 id=1132 data-nosnippet>1132</a> all_targets: <span class="bool-val">false</span>, |
| <a href=#1133 id=1133 data-nosnippet>1133</a> set_test: <span class="bool-val">false</span>, |
| <a href=#1134 id=1134 data-nosnippet>1134</a> no_default_features: <span class="bool-val">false</span>, |
| <a href=#1135 id=1135 data-nosnippet>1135</a> all_features: <span class="bool-val">false</span>, |
| <a href=#1136 id=1136 data-nosnippet>1136</a> features: <span class="macro">vec!</span>[], |
| <a href=#1137 id=1137 data-nosnippet>1137</a> extra_args: <span class="macro">vec!</span>[], |
| <a href=#1138 id=1138 data-nosnippet>1138</a> extra_test_bin_args: <span class="macro">vec!</span>[], |
| <a href=#1139 id=1139 data-nosnippet>1139</a> extra_env: FxHashMap::default(), |
| <a href=#1140 id=1140 data-nosnippet>1140</a> target_dir_config: TargetDirectoryConfig::default(), |
| <a href=#1141 id=1141 data-nosnippet>1141</a> }, |
| <a href=#1142 id=1142 data-nosnippet>1142</a> ansi_color_output: <span class="bool-val">true</span>, |
| <a href=#1143 id=1143 data-nosnippet>1143</a> }; |
| <a href=#1144 id=1144 data-nosnippet>1144</a> <span class="macro">assert_eq!</span>(clippy.to_string(), <span class="string">"cargo clippy"</span>); |
| <a href=#1145 id=1145 data-nosnippet>1145</a> |
| <a href=#1146 id=1146 data-nosnippet>1146</a> <span class="kw">let </span>custom_dollar = FlycheckConfig::CustomCommand { |
| <a href=#1147 id=1147 data-nosnippet>1147</a> command: <span class="string">"check"</span>.to_owned(), |
| <a href=#1148 id=1148 data-nosnippet>1148</a> args: <span class="macro">vec!</span>[<span class="string">"--input"</span>.to_owned(), <span class="string">"$saved_file"</span>.to_owned()], |
| <a href=#1149 id=1149 data-nosnippet>1149</a> extra_env: FxHashMap::default(), |
| <a href=#1150 id=1150 data-nosnippet>1150</a> invocation_strategy: InvocationStrategy::Once, |
| <a href=#1151 id=1151 data-nosnippet>1151</a> }; |
| <a href=#1152 id=1152 data-nosnippet>1152</a> <span class="macro">assert_eq!</span>(custom_dollar.to_string(), <span class="string">"check --input ..."</span>); |
| <a href=#1153 id=1153 data-nosnippet>1153</a> |
| <a href=#1154 id=1154 data-nosnippet>1154</a> <span class="kw">let </span>custom_inline = FlycheckConfig::CustomCommand { |
| <a href=#1155 id=1155 data-nosnippet>1155</a> command: <span class="string">"check"</span>.to_owned(), |
| <a href=#1156 id=1156 data-nosnippet>1156</a> args: <span class="macro">vec!</span>[<span class="string">"--input"</span>.to_owned(), <span class="string">"{saved_file}"</span>.to_owned()], |
| <a href=#1157 id=1157 data-nosnippet>1157</a> extra_env: FxHashMap::default(), |
| <a href=#1158 id=1158 data-nosnippet>1158</a> invocation_strategy: InvocationStrategy::Once, |
| <a href=#1159 id=1159 data-nosnippet>1159</a> }; |
| <a href=#1160 id=1160 data-nosnippet>1160</a> <span class="macro">assert_eq!</span>(custom_inline.to_string(), <span class="string">"check --input ..."</span>); |
| <a href=#1161 id=1161 data-nosnippet>1161</a> |
| <a href=#1162 id=1162 data-nosnippet>1162</a> <span class="kw">let </span>custom_rs = FlycheckConfig::CustomCommand { |
| <a href=#1163 id=1163 data-nosnippet>1163</a> command: <span class="string">"check"</span>.to_owned(), |
| <a href=#1164 id=1164 data-nosnippet>1164</a> args: <span class="macro">vec!</span>[<span class="string">"--input"</span>.to_owned(), <span class="string">"/path/to/file.rs"</span>.to_owned()], |
| <a href=#1165 id=1165 data-nosnippet>1165</a> extra_env: FxHashMap::default(), |
| <a href=#1166 id=1166 data-nosnippet>1166</a> invocation_strategy: InvocationStrategy::Once, |
| <a href=#1167 id=1167 data-nosnippet>1167</a> }; |
| <a href=#1168 id=1168 data-nosnippet>1168</a> <span class="macro">assert_eq!</span>(custom_rs.to_string(), <span class="string">"check --input ..."</span>); |
| <a href=#1169 id=1169 data-nosnippet>1169</a> } |
| <a href=#1170 id=1170 data-nosnippet>1170</a>} |
| </code></pre></div></section></main></body></html> |
