| <!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 `xtask/src/tidy.rs`."><title>tidy.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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="xtask" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.0 (f8297e351 2025-10-28)" data-channel="1.91.0" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.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-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.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">xtask/</div>tidy.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="attr">#![allow(clippy::disallowed_types, clippy::print_stderr)] |
| <a href=#2 id=2 data-nosnippet>2</a></span><span class="kw">use </span>std::{ |
| <a href=#3 id=3 data-nosnippet>3</a> collections::HashSet, |
| <a href=#4 id=4 data-nosnippet>4</a> path::{Path, PathBuf}, |
| <a href=#5 id=5 data-nosnippet>5</a>}; |
| <a href=#6 id=6 data-nosnippet>6</a> |
| <a href=#7 id=7 data-nosnippet>7</a><span class="kw">use </span>itertools::Itertools; |
| <a href=#8 id=8 data-nosnippet>8</a><span class="kw">use </span>xshell::Shell; |
| <a href=#9 id=9 data-nosnippet>9</a> |
| <a href=#10 id=10 data-nosnippet>10</a><span class="kw">use </span>xshell::cmd; |
| <a href=#11 id=11 data-nosnippet>11</a> |
| <a href=#12 id=12 data-nosnippet>12</a><span class="kw">use crate</span>::{flags::Tidy, project_root, util::list_files}; |
| <a href=#13 id=13 data-nosnippet>13</a> |
| <a href=#14 id=14 data-nosnippet>14</a><span class="kw">impl </span>Tidy { |
| <a href=#15 id=15 data-nosnippet>15</a> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>run(<span class="kw-2">&</span><span class="self">self</span>, sh: <span class="kw-2">&</span>Shell) -> anyhow::Result<()> { |
| <a href=#16 id=16 data-nosnippet>16</a> check_lsp_extensions_docs(sh); |
| <a href=#17 id=17 data-nosnippet>17</a> files_are_tidy(sh); |
| <a href=#18 id=18 data-nosnippet>18</a> check_licenses(sh); |
| <a href=#19 id=19 data-nosnippet>19</a> <span class="prelude-val">Ok</span>(()) |
| <a href=#20 id=20 data-nosnippet>20</a> } |
| <a href=#21 id=21 data-nosnippet>21</a>} |
| <a href=#22 id=22 data-nosnippet>22</a> |
| <a href=#23 id=23 data-nosnippet>23</a><span class="kw">fn </span>check_lsp_extensions_docs(sh: <span class="kw-2">&</span>Shell) { |
| <a href=#24 id=24 data-nosnippet>24</a> <span class="kw">let </span>expected_hash = { |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="kw">let </span>lsp_ext_rs = |
| <a href=#26 id=26 data-nosnippet>26</a> sh.read_file(project_root().join(<span class="string">"crates/rust-analyzer/src/lsp/ext.rs"</span>)).unwrap(); |
| <a href=#27 id=27 data-nosnippet>27</a> stable_hash(lsp_ext_rs.as_str()) |
| <a href=#28 id=28 data-nosnippet>28</a> }; |
| <a href=#29 id=29 data-nosnippet>29</a> |
| <a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span>actual_hash = { |
| <a href=#31 id=31 data-nosnippet>31</a> <span class="kw">let </span>lsp_extensions_md = sh |
| <a href=#32 id=32 data-nosnippet>32</a> .read_file(project_root().join(<span class="string">"docs/book/src/contributing/lsp-extensions.md"</span>)) |
| <a href=#33 id=33 data-nosnippet>33</a> .unwrap(); |
| <a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>text = lsp_extensions_md |
| <a href=#35 id=35 data-nosnippet>35</a> .lines() |
| <a href=#36 id=36 data-nosnippet>36</a> .find_map(|line| line.strip_prefix(<span class="string">"lsp/ext.rs hash:"</span>)) |
| <a href=#37 id=37 data-nosnippet>37</a> .unwrap() |
| <a href=#38 id=38 data-nosnippet>38</a> .trim(); |
| <a href=#39 id=39 data-nosnippet>39</a> u64::from_str_radix(text, <span class="number">16</span>).unwrap() |
| <a href=#40 id=40 data-nosnippet>40</a> }; |
| <a href=#41 id=41 data-nosnippet>41</a> |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="kw">if </span>actual_hash != expected_hash { |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="macro">panic!</span>( |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="string">" |
| <a href=#45 id=45 data-nosnippet>45</a>lsp/ext.rs was changed without touching lsp-extensions.md. |
| <a href=#46 id=46 data-nosnippet>46</a> |
| <a href=#47 id=47 data-nosnippet>47</a>Expected hash: {expected_hash:x} |
| <a href=#48 id=48 data-nosnippet>48</a>Actual hash: {actual_hash:x} |
| <a href=#49 id=49 data-nosnippet>49</a> |
| <a href=#50 id=50 data-nosnippet>50</a>Please adjust docs/book/src/contributing/lsp-extensions.md. |
| <a href=#51 id=51 data-nosnippet>51</a>" |
| <a href=#52 id=52 data-nosnippet>52</a> </span>) |
| <a href=#53 id=53 data-nosnippet>53</a> } |
| <a href=#54 id=54 data-nosnippet>54</a>} |
| <a href=#55 id=55 data-nosnippet>55</a> |
| <a href=#56 id=56 data-nosnippet>56</a><span class="kw">fn </span>files_are_tidy(sh: <span class="kw-2">&</span>Shell) { |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">let </span>files = list_files(<span class="kw-2">&</span>project_root().join(<span class="string">"crates"</span>)); |
| <a href=#58 id=58 data-nosnippet>58</a> |
| <a href=#59 id=59 data-nosnippet>59</a> <span class="kw">let </span><span class="kw-2">mut </span>tidy_docs = TidyDocs::default(); |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="kw">let </span><span class="kw-2">mut </span>tidy_marks = TidyMarks::default(); |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="kw">for </span>path <span class="kw">in </span>files { |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="kw">let </span>extension = path.extension().unwrap_or_default().to_str().unwrap_or_default(); |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="kw">match </span>extension { |
| <a href=#64 id=64 data-nosnippet>64</a> <span class="string">"rs" </span>=> { |
| <a href=#65 id=65 data-nosnippet>65</a> <span class="kw">let </span>text = sh.read_file(<span class="kw-2">&</span>path).unwrap(); |
| <a href=#66 id=66 data-nosnippet>66</a> check_test_attrs(<span class="kw-2">&</span>path, <span class="kw-2">&</span>text); |
| <a href=#67 id=67 data-nosnippet>67</a> check_trailing_ws(<span class="kw-2">&</span>path, <span class="kw-2">&</span>text); |
| <a href=#68 id=68 data-nosnippet>68</a> tidy_docs.visit(<span class="kw-2">&</span>path, <span class="kw-2">&</span>text); |
| <a href=#69 id=69 data-nosnippet>69</a> tidy_marks.visit(<span class="kw-2">&</span>path, <span class="kw-2">&</span>text); |
| <a href=#70 id=70 data-nosnippet>70</a> } |
| <a href=#71 id=71 data-nosnippet>71</a> <span class="string">"toml" </span>=> { |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="kw">let </span>text = sh.read_file(<span class="kw-2">&</span>path).unwrap(); |
| <a href=#73 id=73 data-nosnippet>73</a> check_cargo_toml(<span class="kw-2">&</span>path, text); |
| <a href=#74 id=74 data-nosnippet>74</a> } |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="kw">_ </span>=> (), |
| <a href=#76 id=76 data-nosnippet>76</a> } |
| <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> tidy_docs.finish(); |
| <a href=#80 id=80 data-nosnippet>80</a> tidy_marks.finish(); |
| <a href=#81 id=81 data-nosnippet>81</a>} |
| <a href=#82 id=82 data-nosnippet>82</a> |
| <a href=#83 id=83 data-nosnippet>83</a><span class="kw">fn </span>check_cargo_toml(path: <span class="kw-2">&</span>Path, text: String) { |
| <a href=#84 id=84 data-nosnippet>84</a> <span class="kw">let </span><span class="kw-2">mut </span>section = <span class="prelude-val">None</span>; |
| <a href=#85 id=85 data-nosnippet>85</a> <span class="kw">for </span>(line_no, text) <span class="kw">in </span>text.lines().enumerate() { |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="kw">let </span>text = text.trim(); |
| <a href=#87 id=87 data-nosnippet>87</a> <span class="kw">if </span>text.starts_with(<span class="string">'['</span>) { |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="kw">if </span>!text.ends_with(<span class="string">']'</span>) { |
| <a href=#89 id=89 data-nosnippet>89</a> <span class="macro">panic!</span>( |
| <a href=#90 id=90 data-nosnippet>90</a> <span class="string">"\nplease don't add comments or trailing whitespace in section lines.\n\ |
| <a href=#91 id=91 data-nosnippet>91</a> {}:{}\n"</span>, |
| <a href=#92 id=92 data-nosnippet>92</a> path.display(), |
| <a href=#93 id=93 data-nosnippet>93</a> line_no + <span class="number">1 |
| <a href=#94 id=94 data-nosnippet>94</a> </span>) |
| <a href=#95 id=95 data-nosnippet>95</a> } |
| <a href=#96 id=96 data-nosnippet>96</a> section = <span class="prelude-val">Some</span>(text); |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="kw">continue</span>; |
| <a href=#98 id=98 data-nosnippet>98</a> } |
| <a href=#99 id=99 data-nosnippet>99</a> <span class="kw">let </span>text: String = text.split_whitespace().collect(); |
| <a href=#100 id=100 data-nosnippet>100</a> <span class="kw">if </span>!text.contains(<span class="string">"path="</span>) { |
| <a href=#101 id=101 data-nosnippet>101</a> <span class="kw">continue</span>; |
| <a href=#102 id=102 data-nosnippet>102</a> } |
| <a href=#103 id=103 data-nosnippet>103</a> <span class="kw">match </span>section { |
| <a href=#104 id=104 data-nosnippet>104</a> <span class="prelude-val">Some</span>(s) <span class="kw">if </span>s.contains(<span class="string">"dev-dependencies"</span>) => { |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="kw">if </span>text.contains(<span class="string">"version"</span>) { |
| <a href=#106 id=106 data-nosnippet>106</a> <span class="macro">panic!</span>( |
| <a href=#107 id=107 data-nosnippet>107</a> <span class="string">"\ncargo internal dev-dependencies should not have a version.\n\ |
| <a href=#108 id=108 data-nosnippet>108</a> {}:{}\n"</span>, |
| <a href=#109 id=109 data-nosnippet>109</a> path.display(), |
| <a href=#110 id=110 data-nosnippet>110</a> line_no + <span class="number">1 |
| <a href=#111 id=111 data-nosnippet>111</a> </span>); |
| <a href=#112 id=112 data-nosnippet>112</a> } |
| <a href=#113 id=113 data-nosnippet>113</a> } |
| <a href=#114 id=114 data-nosnippet>114</a> <span class="prelude-val">Some</span>(s) <span class="kw">if </span>s.contains(<span class="string">"dependencies"</span>) => { |
| <a href=#115 id=115 data-nosnippet>115</a> <span class="kw">if </span>!text.contains(<span class="string">"version"</span>) { |
| <a href=#116 id=116 data-nosnippet>116</a> <span class="macro">panic!</span>( |
| <a href=#117 id=117 data-nosnippet>117</a> <span class="string">"\ncargo internal dependencies should have a version.\n\ |
| <a href=#118 id=118 data-nosnippet>118</a> {}:{}\n"</span>, |
| <a href=#119 id=119 data-nosnippet>119</a> path.display(), |
| <a href=#120 id=120 data-nosnippet>120</a> line_no + <span class="number">1 |
| <a href=#121 id=121 data-nosnippet>121</a> </span>); |
| <a href=#122 id=122 data-nosnippet>122</a> } |
| <a href=#123 id=123 data-nosnippet>123</a> } |
| <a href=#124 id=124 data-nosnippet>124</a> <span class="kw">_ </span>=> {} |
| <a href=#125 id=125 data-nosnippet>125</a> } |
| <a href=#126 id=126 data-nosnippet>126</a> } |
| <a href=#127 id=127 data-nosnippet>127</a>} |
| <a href=#128 id=128 data-nosnippet>128</a> |
| <a href=#129 id=129 data-nosnippet>129</a><span class="kw">fn </span>check_licenses(sh: <span class="kw-2">&</span>Shell) { |
| <a href=#130 id=130 data-nosnippet>130</a> <span class="kw">const </span>EXPECTED: [<span class="kw-2">&</span>str; <span class="number">20</span>] = [ |
| <a href=#131 id=131 data-nosnippet>131</a> <span class="string">"(MIT OR Apache-2.0) AND Unicode-3.0"</span>, |
| <a href=#132 id=132 data-nosnippet>132</a> <span class="string">"0BSD OR MIT OR Apache-2.0"</span>, |
| <a href=#133 id=133 data-nosnippet>133</a> <span class="string">"Apache-2.0"</span>, |
| <a href=#134 id=134 data-nosnippet>134</a> <span class="string">"Apache-2.0 OR BSL-1.0"</span>, |
| <a href=#135 id=135 data-nosnippet>135</a> <span class="string">"Apache-2.0 OR MIT"</span>, |
| <a href=#136 id=136 data-nosnippet>136</a> <span class="string">"Apache-2.0 WITH LLVM-exception"</span>, |
| <a href=#137 id=137 data-nosnippet>137</a> <span class="string">"Apache-2.0 WITH LLVM-exception OR Apache-2.0 OR MIT"</span>, |
| <a href=#138 id=138 data-nosnippet>138</a> <span class="string">"Apache-2.0/MIT"</span>, |
| <a href=#139 id=139 data-nosnippet>139</a> <span class="string">"CC0-1.0"</span>, |
| <a href=#140 id=140 data-nosnippet>140</a> <span class="string">"ISC"</span>, |
| <a href=#141 id=141 data-nosnippet>141</a> <span class="string">"MIT"</span>, |
| <a href=#142 id=142 data-nosnippet>142</a> <span class="string">"MIT / Apache-2.0"</span>, |
| <a href=#143 id=143 data-nosnippet>143</a> <span class="string">"MIT OR Apache-2.0"</span>, |
| <a href=#144 id=144 data-nosnippet>144</a> <span class="string">"MIT OR Zlib OR Apache-2.0"</span>, |
| <a href=#145 id=145 data-nosnippet>145</a> <span class="string">"MIT/Apache-2.0"</span>, |
| <a href=#146 id=146 data-nosnippet>146</a> <span class="string">"MPL-2.0"</span>, |
| <a href=#147 id=147 data-nosnippet>147</a> <span class="string">"Unicode-3.0"</span>, |
| <a href=#148 id=148 data-nosnippet>148</a> <span class="string">"Unlicense OR MIT"</span>, |
| <a href=#149 id=149 data-nosnippet>149</a> <span class="string">"Unlicense/MIT"</span>, |
| <a href=#150 id=150 data-nosnippet>150</a> <span class="string">"Zlib"</span>, |
| <a href=#151 id=151 data-nosnippet>151</a> ]; |
| <a href=#152 id=152 data-nosnippet>152</a> |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="kw">let </span>meta = <span class="macro">cmd!</span>(sh, <span class="string">"cargo metadata --format-version 1"</span>).read().unwrap(); |
| <a href=#154 id=154 data-nosnippet>154</a> <span class="kw">let </span><span class="kw-2">mut </span>licenses = meta |
| <a href=#155 id=155 data-nosnippet>155</a> .split([<span class="string">','</span>, <span class="string">'{'</span>, <span class="string">'}'</span>]) |
| <a href=#156 id=156 data-nosnippet>156</a> .filter(|it| it.contains(<span class="string">r#""license""#</span>)) |
| <a href=#157 id=157 data-nosnippet>157</a> .map(|it| it.trim()) |
| <a href=#158 id=158 data-nosnippet>158</a> .map(|it| it[<span class="string">r#""license":"#</span>.len()..].trim_matches(<span class="string">'"'</span>)) |
| <a href=#159 id=159 data-nosnippet>159</a> .collect::<Vec<<span class="kw">_</span>>>(); |
| <a href=#160 id=160 data-nosnippet>160</a> licenses.sort_unstable(); |
| <a href=#161 id=161 data-nosnippet>161</a> licenses.dedup(); |
| <a href=#162 id=162 data-nosnippet>162</a> <span class="kw">if </span>licenses != EXPECTED { |
| <a href=#163 id=163 data-nosnippet>163</a> <span class="kw">let </span><span class="kw-2">mut </span>diff = String::new(); |
| <a href=#164 id=164 data-nosnippet>164</a> |
| <a href=#165 id=165 data-nosnippet>165</a> diff.push_str(<span class="string">"New Licenses:\n"</span>); |
| <a href=#166 id=166 data-nosnippet>166</a> <span class="kw">for </span><span class="kw-2">&</span>l <span class="kw">in </span>licenses.iter() { |
| <a href=#167 id=167 data-nosnippet>167</a> <span class="kw">if </span>!EXPECTED.contains(<span class="kw-2">&</span>l) { |
| <a href=#168 id=168 data-nosnippet>168</a> diff += <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">" {l}\n"</span>) |
| <a href=#169 id=169 data-nosnippet>169</a> } |
| <a href=#170 id=170 data-nosnippet>170</a> } |
| <a href=#171 id=171 data-nosnippet>171</a> |
| <a href=#172 id=172 data-nosnippet>172</a> diff.push_str(<span class="string">"\nMissing Licenses:\n"</span>); |
| <a href=#173 id=173 data-nosnippet>173</a> <span class="kw">for </span>l <span class="kw">in </span>EXPECTED { |
| <a href=#174 id=174 data-nosnippet>174</a> <span class="kw">if </span>!licenses.contains(<span class="kw-2">&</span>l) { |
| <a href=#175 id=175 data-nosnippet>175</a> diff += <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">" {l}\n"</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> <span class="macro">panic!</span>(<span class="string">"different set of licenses!\n{diff}"</span>); |
| <a href=#180 id=180 data-nosnippet>180</a> } |
| <a href=#181 id=181 data-nosnippet>181</a> <span class="macro">assert_eq!</span>(licenses, EXPECTED); |
| <a href=#182 id=182 data-nosnippet>182</a>} |
| <a href=#183 id=183 data-nosnippet>183</a> |
| <a href=#184 id=184 data-nosnippet>184</a><span class="kw">fn </span>check_test_attrs(path: <span class="kw-2">&</span>Path, text: <span class="kw-2">&</span>str) { |
| <a href=#185 id=185 data-nosnippet>185</a> <span class="kw">let </span>panic_rule = <span class="string">"https://github.com/rust-lang/rust-analyzer/blob/master/docs/book/src/contributing/style.md#should_panic"</span>; |
| <a href=#186 id=186 data-nosnippet>186</a> <span class="kw">let </span>need_panic: <span class="kw-2">&</span>[<span class="kw-2">&</span>str] = <span class="kw-2">&</span>[ |
| <a href=#187 id=187 data-nosnippet>187</a> <span class="comment">// This file. |
| <a href=#188 id=188 data-nosnippet>188</a> </span><span class="string">"slow-tests/tidy.rs"</span>, |
| <a href=#189 id=189 data-nosnippet>189</a> <span class="string">"test-utils/src/fixture.rs"</span>, |
| <a href=#190 id=190 data-nosnippet>190</a> <span class="comment">// Generated code from lints contains doc tests in string literals. |
| <a href=#191 id=191 data-nosnippet>191</a> </span><span class="string">"ide-db/src/generated/lints.rs"</span>, |
| <a href=#192 id=192 data-nosnippet>192</a> ]; |
| <a href=#193 id=193 data-nosnippet>193</a> <span class="kw">if </span>need_panic.iter().any(|p| path.ends_with(p)) { |
| <a href=#194 id=194 data-nosnippet>194</a> <span class="kw">return</span>; |
| <a href=#195 id=195 data-nosnippet>195</a> } |
| <a href=#196 id=196 data-nosnippet>196</a> <span class="kw">if let </span><span class="prelude-val">Some</span>((line, <span class="kw">_</span>)) = text |
| <a href=#197 id=197 data-nosnippet>197</a> .lines() |
| <a href=#198 id=198 data-nosnippet>198</a> .tuple_windows() |
| <a href=#199 id=199 data-nosnippet>199</a> .enumerate() |
| <a href=#200 id=200 data-nosnippet>200</a> .find(|(<span class="kw">_</span>, (a, b))| b.contains(<span class="string">"#[should_panic"</span>) && !a.contains(<span class="string">"FIXME"</span>)) |
| <a href=#201 id=201 data-nosnippet>201</a> { |
| <a href=#202 id=202 data-nosnippet>202</a> <span class="macro">panic!</span>( |
| <a href=#203 id=203 data-nosnippet>203</a> <span class="string">"\ndon't add `#[should_panic]` tests, see:\n\n {}\n\n {}:{line}\n"</span>, |
| <a href=#204 id=204 data-nosnippet>204</a> panic_rule, |
| <a href=#205 id=205 data-nosnippet>205</a> path.display(), |
| <a href=#206 id=206 data-nosnippet>206</a> ) |
| <a href=#207 id=207 data-nosnippet>207</a> } |
| <a href=#208 id=208 data-nosnippet>208</a>} |
| <a href=#209 id=209 data-nosnippet>209</a> |
| <a href=#210 id=210 data-nosnippet>210</a><span class="kw">fn </span>check_trailing_ws(path: <span class="kw-2">&</span>Path, text: <span class="kw-2">&</span>str) { |
| <a href=#211 id=211 data-nosnippet>211</a> <span class="kw">if </span>is_exclude_dir(path, <span class="kw-2">&</span>[<span class="string">"test_data"</span>]) { |
| <a href=#212 id=212 data-nosnippet>212</a> <span class="kw">return</span>; |
| <a href=#213 id=213 data-nosnippet>213</a> } |
| <a href=#214 id=214 data-nosnippet>214</a> <span class="kw">for </span>(line_number, line) <span class="kw">in </span>text.lines().enumerate() { |
| <a href=#215 id=215 data-nosnippet>215</a> <span class="kw">if </span>line.chars().last().is_some_and(char::is_whitespace) { |
| <a href=#216 id=216 data-nosnippet>216</a> <span class="macro">panic!</span>(<span class="string">"Trailing whitespace in {} at line {}"</span>, path.display(), line_number + <span class="number">1</span>) |
| <a href=#217 id=217 data-nosnippet>217</a> } |
| <a href=#218 id=218 data-nosnippet>218</a> } |
| <a href=#219 id=219 data-nosnippet>219</a>} |
| <a href=#220 id=220 data-nosnippet>220</a> |
| <a href=#221 id=221 data-nosnippet>221</a><span class="attr">#[derive(Default)] |
| <a href=#222 id=222 data-nosnippet>222</a></span><span class="kw">struct </span>TidyDocs { |
| <a href=#223 id=223 data-nosnippet>223</a> missing_docs: Vec<String>, |
| <a href=#224 id=224 data-nosnippet>224</a> contains_fixme: Vec<PathBuf>, |
| <a href=#225 id=225 data-nosnippet>225</a>} |
| <a href=#226 id=226 data-nosnippet>226</a> |
| <a href=#227 id=227 data-nosnippet>227</a><span class="kw">impl </span>TidyDocs { |
| <a href=#228 id=228 data-nosnippet>228</a> <span class="kw">fn </span>visit(<span class="kw-2">&mut </span><span class="self">self</span>, path: <span class="kw-2">&</span>Path, text: <span class="kw-2">&</span>str) { |
| <a href=#229 id=229 data-nosnippet>229</a> <span class="comment">// Tests and diagnostic fixes don't need module level comments. |
| <a href=#230 id=230 data-nosnippet>230</a> </span><span class="kw">if </span>is_exclude_dir(path, <span class="kw-2">&</span>[<span class="string">"tests"</span>, <span class="string">"test_data"</span>, <span class="string">"fixes"</span>, <span class="string">"grammar"</span>, <span class="string">"stdx"</span>]) { |
| <a href=#231 id=231 data-nosnippet>231</a> <span class="kw">return</span>; |
| <a href=#232 id=232 data-nosnippet>232</a> } |
| <a href=#233 id=233 data-nosnippet>233</a> |
| <a href=#234 id=234 data-nosnippet>234</a> <span class="kw">if </span>is_exclude_file(path) { |
| <a href=#235 id=235 data-nosnippet>235</a> <span class="kw">return</span>; |
| <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="kw">if </span>is_ported_from_rustc(path, <span class="kw-2">&</span>[<span class="string">"crates/hir-ty/src/next_solver"</span>]) { |
| <a href=#239 id=239 data-nosnippet>239</a> <span class="kw">return</span>; |
| <a href=#240 id=240 data-nosnippet>240</a> } |
| <a href=#241 id=241 data-nosnippet>241</a> |
| <a href=#242 id=242 data-nosnippet>242</a> <span class="kw">let </span>first_line = <span class="kw">match </span>text.lines().next() { |
| <a href=#243 id=243 data-nosnippet>243</a> <span class="prelude-val">Some</span>(it) => it, |
| <a href=#244 id=244 data-nosnippet>244</a> <span class="prelude-val">None </span>=> <span class="kw">return</span>, |
| <a href=#245 id=245 data-nosnippet>245</a> }; |
| <a href=#246 id=246 data-nosnippet>246</a> |
| <a href=#247 id=247 data-nosnippet>247</a> <span class="kw">if </span>first_line.starts_with(<span class="string">"//!"</span>) { |
| <a href=#248 id=248 data-nosnippet>248</a> <span class="kw">if </span>first_line.contains(<span class="string">"FIXME"</span>) { |
| <a href=#249 id=249 data-nosnippet>249</a> <span class="self">self</span>.contains_fixme.push(path.to_path_buf()); |
| <a href=#250 id=250 data-nosnippet>250</a> } |
| <a href=#251 id=251 data-nosnippet>251</a> } <span class="kw">else </span>{ |
| <a href=#252 id=252 data-nosnippet>252</a> <span class="kw">if </span>text.contains(<span class="string">"// Feature:"</span>) |
| <a href=#253 id=253 data-nosnippet>253</a> || text.contains(<span class="string">"// Assist:"</span>) |
| <a href=#254 id=254 data-nosnippet>254</a> || text.contains(<span class="string">"// Diagnostic:"</span>) |
| <a href=#255 id=255 data-nosnippet>255</a> { |
| <a href=#256 id=256 data-nosnippet>256</a> <span class="kw">return</span>; |
| <a href=#257 id=257 data-nosnippet>257</a> } |
| <a href=#258 id=258 data-nosnippet>258</a> <span class="self">self</span>.missing_docs.push(path.display().to_string()); |
| <a href=#259 id=259 data-nosnippet>259</a> } |
| <a href=#260 id=260 data-nosnippet>260</a> |
| <a href=#261 id=261 data-nosnippet>261</a> <span class="kw">fn </span>is_exclude_file(d: <span class="kw-2">&</span>Path) -> bool { |
| <a href=#262 id=262 data-nosnippet>262</a> <span class="kw">let </span>file_names = [<span class="string">"tests.rs"</span>, <span class="string">"famous_defs_fixture.rs"</span>, <span class="string">"frontmatter.rs"</span>]; |
| <a href=#263 id=263 data-nosnippet>263</a> |
| <a href=#264 id=264 data-nosnippet>264</a> d.file_name() |
| <a href=#265 id=265 data-nosnippet>265</a> .unwrap_or_default() |
| <a href=#266 id=266 data-nosnippet>266</a> .to_str() |
| <a href=#267 id=267 data-nosnippet>267</a> .map(|f_n| file_names.contains(<span class="kw-2">&</span>f_n)) |
| <a href=#268 id=268 data-nosnippet>268</a> .unwrap_or(<span class="bool-val">false</span>) |
| <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> |
| <a href=#272 id=272 data-nosnippet>272</a> <span class="kw">fn </span>finish(<span class="self">self</span>) { |
| <a href=#273 id=273 data-nosnippet>273</a> <span class="kw">if </span>!<span class="self">self</span>.missing_docs.is_empty() { |
| <a href=#274 id=274 data-nosnippet>274</a> <span class="macro">panic!</span>( |
| <a href=#275 id=275 data-nosnippet>275</a> <span class="string">"\nMissing docs strings\n\n\ |
| <a href=#276 id=276 data-nosnippet>276</a> modules:\n{}\n\n"</span>, |
| <a href=#277 id=277 data-nosnippet>277</a> <span class="self">self</span>.missing_docs.join(<span class="string">"\n"</span>) |
| <a href=#278 id=278 data-nosnippet>278</a> ) |
| <a href=#279 id=279 data-nosnippet>279</a> } |
| <a href=#280 id=280 data-nosnippet>280</a> |
| <a href=#281 id=281 data-nosnippet>281</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(path) = <span class="self">self</span>.contains_fixme.first() { |
| <a href=#282 id=282 data-nosnippet>282</a> <span class="macro">panic!</span>(<span class="string">"FIXME doc in a fully-documented crate: {}"</span>, path.display()) |
| <a href=#283 id=283 data-nosnippet>283</a> } |
| <a href=#284 id=284 data-nosnippet>284</a> } |
| <a href=#285 id=285 data-nosnippet>285</a>} |
| <a href=#286 id=286 data-nosnippet>286</a> |
| <a href=#287 id=287 data-nosnippet>287</a><span class="kw">fn </span>is_exclude_dir(p: <span class="kw-2">&</span>Path, dirs_to_exclude: <span class="kw-2">&</span>[<span class="kw-2">&</span>str]) -> bool { |
| <a href=#288 id=288 data-nosnippet>288</a> p.strip_prefix(project_root()) |
| <a href=#289 id=289 data-nosnippet>289</a> .unwrap() |
| <a href=#290 id=290 data-nosnippet>290</a> .components() |
| <a href=#291 id=291 data-nosnippet>291</a> .rev() |
| <a href=#292 id=292 data-nosnippet>292</a> .skip(<span class="number">1</span>) |
| <a href=#293 id=293 data-nosnippet>293</a> .filter_map(|it| it.as_os_str().to_str()) |
| <a href=#294 id=294 data-nosnippet>294</a> .any(|it| dirs_to_exclude.contains(<span class="kw-2">&</span>it)) |
| <a href=#295 id=295 data-nosnippet>295</a>} |
| <a href=#296 id=296 data-nosnippet>296</a> |
| <a href=#297 id=297 data-nosnippet>297</a><span class="kw">fn </span>is_ported_from_rustc(p: <span class="kw-2">&</span>Path, dirs_to_exclude: <span class="kw-2">&</span>[<span class="kw-2">&</span>str]) -> bool { |
| <a href=#298 id=298 data-nosnippet>298</a> <span class="kw">let </span>p = p.strip_prefix(project_root()).unwrap(); |
| <a href=#299 id=299 data-nosnippet>299</a> dirs_to_exclude.iter().any(|exclude| p.starts_with(exclude)) |
| <a href=#300 id=300 data-nosnippet>300</a>} |
| <a href=#301 id=301 data-nosnippet>301</a> |
| <a href=#302 id=302 data-nosnippet>302</a><span class="attr">#[derive(Default)] |
| <a href=#303 id=303 data-nosnippet>303</a></span><span class="kw">struct </span>TidyMarks { |
| <a href=#304 id=304 data-nosnippet>304</a> hits: HashSet<String>, |
| <a href=#305 id=305 data-nosnippet>305</a> checks: HashSet<String>, |
| <a href=#306 id=306 data-nosnippet>306</a>} |
| <a href=#307 id=307 data-nosnippet>307</a> |
| <a href=#308 id=308 data-nosnippet>308</a><span class="kw">impl </span>TidyMarks { |
| <a href=#309 id=309 data-nosnippet>309</a> <span class="kw">fn </span>visit(<span class="kw-2">&mut </span><span class="self">self</span>, _path: <span class="kw-2">&</span>Path, text: <span class="kw-2">&</span>str) { |
| <a href=#310 id=310 data-nosnippet>310</a> find_marks(<span class="kw-2">&mut </span><span class="self">self</span>.hits, text, <span class="string">"hit"</span>); |
| <a href=#311 id=311 data-nosnippet>311</a> find_marks(<span class="kw-2">&mut </span><span class="self">self</span>.checks, text, <span class="string">"check"</span>); |
| <a href=#312 id=312 data-nosnippet>312</a> find_marks(<span class="kw-2">&mut </span><span class="self">self</span>.checks, text, <span class="string">"check_count"</span>); |
| <a href=#313 id=313 data-nosnippet>313</a> } |
| <a href=#314 id=314 data-nosnippet>314</a> |
| <a href=#315 id=315 data-nosnippet>315</a> <span class="kw">fn </span>finish(<span class="self">self</span>) { |
| <a href=#316 id=316 data-nosnippet>316</a> <span class="macro">assert!</span>(!<span class="self">self</span>.hits.is_empty()); |
| <a href=#317 id=317 data-nosnippet>317</a> |
| <a href=#318 id=318 data-nosnippet>318</a> <span class="kw">let </span>diff: Vec<<span class="kw">_</span>> = |
| <a href=#319 id=319 data-nosnippet>319</a> <span class="self">self</span>.hits.symmetric_difference(<span class="kw-2">&</span><span class="self">self</span>.checks).map(|it| it.as_str()).collect(); |
| <a href=#320 id=320 data-nosnippet>320</a> |
| <a href=#321 id=321 data-nosnippet>321</a> <span class="kw">if </span>!diff.is_empty() { |
| <a href=#322 id=322 data-nosnippet>322</a> <span class="macro">panic!</span>(<span class="string">"unpaired marks: {diff:?}"</span>) |
| <a href=#323 id=323 data-nosnippet>323</a> } |
| <a href=#324 id=324 data-nosnippet>324</a> } |
| <a href=#325 id=325 data-nosnippet>325</a>} |
| <a href=#326 id=326 data-nosnippet>326</a> |
| <a href=#327 id=327 data-nosnippet>327</a><span class="attr">#[allow(deprecated)] |
| <a href=#328 id=328 data-nosnippet>328</a></span><span class="kw">fn </span>stable_hash(text: <span class="kw-2">&</span>str) -> u64 { |
| <a href=#329 id=329 data-nosnippet>329</a> <span class="kw">use </span>std::hash::{Hash, Hasher, SipHasher}; |
| <a href=#330 id=330 data-nosnippet>330</a> |
| <a href=#331 id=331 data-nosnippet>331</a> <span class="kw">let </span>text = text.replace(<span class="string">'\r'</span>, <span class="string">""</span>); |
| <a href=#332 id=332 data-nosnippet>332</a> <span class="kw">let </span><span class="kw-2">mut </span>hasher = SipHasher::default(); |
| <a href=#333 id=333 data-nosnippet>333</a> text.hash(<span class="kw-2">&mut </span>hasher); |
| <a href=#334 id=334 data-nosnippet>334</a> hasher.finish() |
| <a href=#335 id=335 data-nosnippet>335</a>} |
| <a href=#336 id=336 data-nosnippet>336</a> |
| <a href=#337 id=337 data-nosnippet>337</a><span class="kw">fn </span>find_marks(set: <span class="kw-2">&mut </span>HashSet<String>, text: <span class="kw-2">&</span>str, mark: <span class="kw-2">&</span>str) { |
| <a href=#338 id=338 data-nosnippet>338</a> <span class="kw">let </span><span class="kw-2">mut </span>text = text; |
| <a href=#339 id=339 data-nosnippet>339</a> <span class="kw">let </span><span class="kw-2">mut </span>prev_text = <span class="string">""</span>; |
| <a href=#340 id=340 data-nosnippet>340</a> <span class="kw">while </span>text != prev_text { |
| <a href=#341 id=341 data-nosnippet>341</a> prev_text = text; |
| <a href=#342 id=342 data-nosnippet>342</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(idx) = text.find(mark) { |
| <a href=#343 id=343 data-nosnippet>343</a> text = <span class="kw-2">&</span>text[idx + mark.len()..]; |
| <a href=#344 id=344 data-nosnippet>344</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(stripped_text) = text.strip_prefix(<span class="string">"!("</span>) { |
| <a href=#345 id=345 data-nosnippet>345</a> text = stripped_text.trim_start(); |
| <a href=#346 id=346 data-nosnippet>346</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(idx2) = text.find(|c: char| !(c.is_alphanumeric() || c == <span class="string">'_'</span>)) { |
| <a href=#347 id=347 data-nosnippet>347</a> <span class="kw">let </span>mark_text = <span class="kw-2">&</span>text[..idx2]; |
| <a href=#348 id=348 data-nosnippet>348</a> set.insert(mark_text.to_owned()); |
| <a href=#349 id=349 data-nosnippet>349</a> text = <span class="kw-2">&</span>text[idx2..]; |
| <a href=#350 id=350 data-nosnippet>350</a> } |
| <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>} |
| <a href=#355 id=355 data-nosnippet>355</a> |
| <a href=#356 id=356 data-nosnippet>356</a><span class="attr">#[test] |
| <a href=#357 id=357 data-nosnippet>357</a></span><span class="kw">fn </span>test() { |
| <a href=#358 id=358 data-nosnippet>358</a> Tidy {}.run(<span class="kw-2">&</span>Shell::new().unwrap()).unwrap(); |
| <a href=#359 id=359 data-nosnippet>359</a>}</code></pre></div></section></main></body></html> |
