blob: 1f6193bcc82849baa7d619de490bb5418f77caa5 [file] [log] [blame] [edit]
<!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/main.rs`."><title>main.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-84e720fa.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.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../../static.files/storage-4e99c027.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-fd3af306.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-32bb7600.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">xtask/</div>main.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! See &lt;https://github.com/matklad/cargo-xtask/&gt;.
<a href=#2 id=2 data-nosnippet>2</a>//!
<a href=#3 id=3 data-nosnippet>3</a>//! This binary defines various auxiliary build commands, which are not
<a href=#4 id=4 data-nosnippet>4</a>//! expressible with just `cargo`. Notably, it provides tests via `cargo test -p xtask`
<a href=#5 id=5 data-nosnippet>5</a>//! for code generation and `cargo xtask install` for installation of
<a href=#6 id=6 data-nosnippet>6</a>//! rust-analyzer server and client.
<a href=#7 id=7 data-nosnippet>7</a>//!
<a href=#8 id=8 data-nosnippet>8</a>//! This binary is integrated into the `cargo` command line by using an alias in
<a href=#9 id=9 data-nosnippet>9</a>//! `.cargo/config`.
<a href=#10 id=10 data-nosnippet>10</a>
<a href=#11 id=11 data-nosnippet>11</a></span><span class="attr">#![warn(rust_2018_idioms, unused_lifetimes)]
<a href=#12 id=12 data-nosnippet>12</a>#![allow(
<a href=#13 id=13 data-nosnippet>13</a> clippy::print_stderr,
<a href=#14 id=14 data-nosnippet>14</a> clippy::print_stdout,
<a href=#15 id=15 data-nosnippet>15</a> clippy::disallowed_methods,
<a href=#16 id=16 data-nosnippet>16</a> clippy::disallowed_types
<a href=#17 id=17 data-nosnippet>17</a>)]
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a></span><span class="kw">mod </span>flags;
<a href=#20 id=20 data-nosnippet>20</a>
<a href=#21 id=21 data-nosnippet>21</a><span class="kw">mod </span>codegen;
<a href=#22 id=22 data-nosnippet>22</a><span class="kw">mod </span>dist;
<a href=#23 id=23 data-nosnippet>23</a><span class="kw">mod </span>install;
<a href=#24 id=24 data-nosnippet>24</a><span class="kw">mod </span>metrics;
<a href=#25 id=25 data-nosnippet>25</a><span class="kw">mod </span>pgo;
<a href=#26 id=26 data-nosnippet>26</a><span class="kw">mod </span>publish;
<a href=#27 id=27 data-nosnippet>27</a><span class="kw">mod </span>release;
<a href=#28 id=28 data-nosnippet>28</a><span class="kw">mod </span>tidy;
<a href=#29 id=29 data-nosnippet>29</a><span class="kw">mod </span>util;
<a href=#30 id=30 data-nosnippet>30</a>
<a href=#31 id=31 data-nosnippet>31</a><span class="kw">use </span>anyhow::bail;
<a href=#32 id=32 data-nosnippet>32</a><span class="kw">use </span>std::{env, path::PathBuf};
<a href=#33 id=33 data-nosnippet>33</a><span class="kw">use </span>xshell::{Shell, cmd};
<a href=#34 id=34 data-nosnippet>34</a>
<a href=#35 id=35 data-nosnippet>35</a><span class="kw">fn </span>main() -&gt; anyhow::Result&lt;()&gt; {
<a href=#36 id=36 data-nosnippet>36</a> <span class="kw">let </span>flags = flags::Xtask::from_env_or_exit();
<a href=#37 id=37 data-nosnippet>37</a>
<a href=#38 id=38 data-nosnippet>38</a> <span class="kw">let </span>sh = <span class="kw-2">&amp;</span>Shell::new()<span class="question-mark">?</span>;
<a href=#39 id=39 data-nosnippet>39</a> sh.change_dir(project_root());
<a href=#40 id=40 data-nosnippet>40</a>
<a href=#41 id=41 data-nosnippet>41</a> <span class="kw">match </span>flags.subcommand {
<a href=#42 id=42 data-nosnippet>42</a> flags::XtaskCmd::Install(cmd) =&gt; cmd.run(sh),
<a href=#43 id=43 data-nosnippet>43</a> flags::XtaskCmd::FuzzTests(<span class="kw">_</span>) =&gt; run_fuzzer(sh),
<a href=#44 id=44 data-nosnippet>44</a> flags::XtaskCmd::Release(cmd) =&gt; cmd.run(sh),
<a href=#45 id=45 data-nosnippet>45</a> flags::XtaskCmd::Dist(cmd) =&gt; cmd.run(sh),
<a href=#46 id=46 data-nosnippet>46</a> flags::XtaskCmd::PublishReleaseNotes(cmd) =&gt; cmd.run(sh),
<a href=#47 id=47 data-nosnippet>47</a> flags::XtaskCmd::Metrics(cmd) =&gt; cmd.run(sh),
<a href=#48 id=48 data-nosnippet>48</a> flags::XtaskCmd::Codegen(cmd) =&gt; cmd.run(sh),
<a href=#49 id=49 data-nosnippet>49</a> flags::XtaskCmd::Bb(cmd) =&gt; {
<a href=#50 id=50 data-nosnippet>50</a> {
<a href=#51 id=51 data-nosnippet>51</a> <span class="kw">let </span>_d = sh.push_dir(<span class="string">"./crates/rust-analyzer"</span>);
<a href=#52 id=52 data-nosnippet>52</a> <span class="macro">cmd!</span>(sh, <span class="string">"cargo build --release --features jemalloc"</span>).run()<span class="question-mark">?</span>;
<a href=#53 id=53 data-nosnippet>53</a> }
<a href=#54 id=54 data-nosnippet>54</a> sh.copy_file(
<a href=#55 id=55 data-nosnippet>55</a> <span class="string">"./target/release/rust-analyzer"</span>,
<a href=#56 id=56 data-nosnippet>56</a> <span class="macro">format!</span>(<span class="string">"./target/rust-analyzer-{}"</span>, cmd.suffix),
<a href=#57 id=57 data-nosnippet>57</a> )<span class="question-mark">?</span>;
<a href=#58 id=58 data-nosnippet>58</a> <span class="prelude-val">Ok</span>(())
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a> flags::XtaskCmd::Tidy(cmd) =&gt; cmd.run(sh),
<a href=#61 id=61 data-nosnippet>61</a> }
<a href=#62 id=62 data-nosnippet>62</a>}
<a href=#63 id=63 data-nosnippet>63</a>
<a href=#64 id=64 data-nosnippet>64</a><span class="doccomment">/// Returns the path to the root directory of `rust-analyzer` project.
<a href=#65 id=65 data-nosnippet>65</a></span><span class="kw">fn </span>project_root() -&gt; PathBuf {
<a href=#66 id=66 data-nosnippet>66</a> <span class="kw">let </span>dir =
<a href=#67 id=67 data-nosnippet>67</a> env::var(<span class="string">"CARGO_MANIFEST_DIR"</span>).unwrap_or_else(|<span class="kw">_</span>| <span class="macro">env!</span>(<span class="string">"CARGO_MANIFEST_DIR"</span>).to_owned());
<a href=#68 id=68 data-nosnippet>68</a> PathBuf::from(dir).parent().unwrap().to_owned()
<a href=#69 id=69 data-nosnippet>69</a>}
<a href=#70 id=70 data-nosnippet>70</a>
<a href=#71 id=71 data-nosnippet>71</a><span class="kw">fn </span>run_fuzzer(sh: <span class="kw-2">&amp;</span>Shell) -&gt; anyhow::Result&lt;()&gt; {
<a href=#72 id=72 data-nosnippet>72</a> <span class="kw">let </span>_d = sh.push_dir(<span class="string">"./crates/syntax"</span>);
<a href=#73 id=73 data-nosnippet>73</a> <span class="kw">let </span>_e = sh.push_env(<span class="string">"RUSTUP_TOOLCHAIN"</span>, <span class="string">"nightly"</span>);
<a href=#74 id=74 data-nosnippet>74</a> <span class="kw">if </span><span class="macro">cmd!</span>(sh, <span class="string">"cargo fuzz --help"</span>).read().is_err() {
<a href=#75 id=75 data-nosnippet>75</a> <span class="macro">cmd!</span>(sh, <span class="string">"cargo install cargo-fuzz"</span>).run()<span class="question-mark">?</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> <span class="comment">// Expecting nightly rustc
<a href=#79 id=79 data-nosnippet>79</a> </span><span class="kw">let </span>out = <span class="macro">cmd!</span>(sh, <span class="string">"rustc --version"</span>).read()<span class="question-mark">?</span>;
<a href=#80 id=80 data-nosnippet>80</a> <span class="kw">if </span>!out.contains(<span class="string">"nightly"</span>) {
<a href=#81 id=81 data-nosnippet>81</a> <span class="macro">bail!</span>(<span class="string">"fuzz tests require nightly rustc"</span>)
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a>
<a href=#84 id=84 data-nosnippet>84</a> <span class="macro">cmd!</span>(sh, <span class="string">"cargo fuzz run parser"</span>).run()<span class="question-mark">?</span>;
<a href=#85 id=85 data-nosnippet>85</a> <span class="prelude-val">Ok</span>(())
<a href=#86 id=86 data-nosnippet>86</a>}
<a href=#87 id=87 data-nosnippet>87</a>
<a href=#88 id=88 data-nosnippet>88</a><span class="kw">fn </span>date_iso(sh: <span class="kw-2">&amp;</span>Shell) -&gt; anyhow::Result&lt;String&gt; {
<a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>res = <span class="macro">cmd!</span>(sh, <span class="string">"date -u +%Y-%m-%d"</span>).read()<span class="question-mark">?</span>;
<a href=#90 id=90 data-nosnippet>90</a> <span class="prelude-val">Ok</span>(res)
<a href=#91 id=91 data-nosnippet>91</a>}
<a href=#92 id=92 data-nosnippet>92</a>
<a href=#93 id=93 data-nosnippet>93</a><span class="kw">fn </span>is_release_tag(tag: <span class="kw-2">&amp;</span>str) -&gt; bool {
<a href=#94 id=94 data-nosnippet>94</a> tag.len() == <span class="string">"2020-02-24"</span>.len() &amp;&amp; tag.starts_with(|c: char| c.is_ascii_digit())
<a href=#95 id=95 data-nosnippet>95</a>}</code></pre></div></section></main></body></html>