<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/rust_analyzer.md - fork/rules_rust @ rust-analyzer</title>
<meta name="description" content="docs/rust_analyzer.md in fork/rules_rust at rust-analyzer.">
<meta property="og:title" content="docs/rust_analyzer.md - fork/rules_rust @ rust-analyzer">
<meta property="og:description" content="docs/rust_analyzer.md in fork/rules_rust at rust-analyzer.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="rust-analyzer" data-tip="d8ea6b8c806c8581efd1e7cbdaadcf037aba2310">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/rules_rust</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/rules_rust</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Daniel Wagner-Hall</span><span class="commit-message" data-commit="56237415eea9134d7760de6ff58f92785704ac7c">stardoc: Use backtick not `&lt;code&gt;` for attr default values  (#1682)</span><span class="snapshot-sha sha" data-commit="56237415eea9134d7760de6ff58f92785704ac7c">56237415</span><time datetime="2022-11-30T17:28:41+00:00" title="2022-11-30 17:28:41 +0000">2022-11-30</time></p>
<header class="topbar"><details class="switcher"><summary>rust-analyzer</summary><div class="menu"><strong>branches</strong><a href="/fork/rules_rust/ref/cleanup/">cleanup</a><a href="/fork/rules_rust/ref/gh-pages/">gh-pages</a><a href="/fork/rules_rust/ref/main/">main</a><a href="/fork/rules_rust/ref/patching/">patching</a><a class="current" href="/fork/rules_rust/ref/rust-analyzer/">rust-analyzer</a><strong>tags</strong><a href="/fork/rules_rust/ref/0.10.0/">0.10.0</a><a href="/fork/rules_rust/ref/0.11.0/">0.11.0</a><a href="/fork/rules_rust/ref/0.5.0/">0.5.0</a><a href="/fork/rules_rust/ref/0.6.0/">0.6.0</a><a href="/fork/rules_rust/ref/0.7.0/">0.7.0</a><a href="/fork/rules_rust/ref/0.8.0/">0.8.0</a><a href="/fork/rules_rust/ref/0.8.1/">0.8.1</a><a href="/fork/rules_rust/ref/0.9.0/">0.9.0</a><a class="all" href="/fork/rules_rust/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/rules_rust/">rules_rust</a> / <a href="/fork/rules_rust/ref/rust-analyzer/tree/docs/">docs</a> / <span class="cur">rust_analyzer.md</span></nav>
<span class="view-stats"><span>4.8 KiB</span><span>131 lines</span></span><span class="actions"><a class="raw" href="/fork/rules_rust/raw/f7b7f0f8109d7b73b1186e1c239ae8f3e7f6a87e/docs/rust_analyzer.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;
<h1>Rust Analyzer</h1>
<ul>
<li><a href="#rust_analyzer_aspect">rust_analyzer_aspect</a></li>
<li><a href="#rust_analyzer_toolchain">rust_analyzer_toolchain</a></li>
</ul>
<h2>Overview</h2>
<p>For <a href="https://rust-analyzer.github.io/manual.html#non-cargo-based-projects">non-Cargo projects</a>,
<a href="https://rust-analyzer.github.io/">rust-analyzer</a> depends on a <code>rust-project.json</code> file at the
root of the project that describes its structure. The <code>rust_analyzer</code> rule facilitates generating
such a file.</p>
<h3>Setup</h3>
<p>First, ensure <code>rules_rust</code> is setup in your workspace. By default, <code>rust_register_toolchains</code> will
ensure a <a href="#rust_analyzer_toolchain">rust_analyzer_toolchain</a> is registered within the WORKSPACE.</p>
<p>Next, load the dependencies for the <code>rust-project.json</code> generator tool:</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//tools/rust_analyzer:deps.bzl&quot;</a-s>, <a-s>&quot;rust_analyzer_dependencies&quot;</a-s>)

<a-f>rust_analyzer_dependencies</a-f>()</pre>
<p>Finally, run <code>bazel run @rules_rust//tools/rust_analyzer:gen_rust_project</code>
whenever dependencies change to regenerate the <code>rust-project.json</code> file. It
should be added to <code>.gitignore</code> because it is effectively a build artifact.
Once the <code>rust-project.json</code> has been generated in the project root,
rust-analyzer can pick it up upon restart.</p>
<p>For users who do not use <code>rust_register_toolchains</code> to register toolchains, the following can be added
to their WORKSPACE to register a <code>rust_analyzer_toolchain</code>. Please make sure the Rust version used in
this toolchain matches the version used by the currently registered toolchain or the sources/documentation
will not match what's being compiled with and can lead to confusing results.</p>
<pre class="language-python"><a-f>load</a-f>(<a-s>&quot;@rules_rust//rust:repositories.bzl&quot;</a-s>, <a-s>&quot;rust_analyzer_toolchain_repository&quot;</a-s>)

<a-f>register_toolchains</a-f>(<a-f>rust_analyzer_toolchain_repository</a-f>(
    <a-v>name</a-v> <a-o>=</a-o> <a-s>&quot;rust_analyzer_toolchain&quot;</a-s>,
    <a-c># This should match the currently registered toolchain.</a-c>
    <a-v>version</a-v> <a-o>=</a-o> <a-s>&quot;1.62.0&quot;</a-s>,
))</pre>
<h4>VSCode</h4>
<p>To set this up using <a href="https://code.visualstudio.com/">VSCode</a>, users should first install the
<a href="https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer">rust_analyzer plugin</a>.
With that in place, the following task can be added to the <code>.vscode/tasks.json</code> file of the workspace
to ensure a <code>rust-project.json</code> file is created and up to date when the editor is opened.</p>
<pre class="language-json">{
    <a-s>&quot;version&quot;</a-s>: <a-s>&quot;2.0.0&quot;</a-s>,
    <a-s>&quot;tasks&quot;</a-s>: [
        {
            <a-s>&quot;label&quot;</a-s>: <a-s>&quot;Generate rust-project.json&quot;</a-s>,
            <a-s>&quot;command&quot;</a-s>: <a-s>&quot;bazel&quot;</a-s>,
            <a-s>&quot;args&quot;</a-s>: [<a-s>&quot;run&quot;</a-s>, <a-s>&quot;@rules_rust//tools/rust_analyzer:gen_rust_project&quot;</a-s>],
            <a-s>&quot;options&quot;</a-s>: {
                <a-s>&quot;cwd&quot;</a-s>: <a-s>&quot;${workspaceFolder}&quot;</a-s>
            },
            <a-s>&quot;group&quot;</a-s>: <a-s>&quot;build&quot;</a-s>,
            <a-s>&quot;problemMatcher&quot;</a-s>: [],
            <a-s>&quot;presentation&quot;</a-s>: {
                <a-s>&quot;reveal&quot;</a-s>: <a-s>&quot;never&quot;</a-s>,
                <a-s>&quot;panel&quot;</a-s>: <a-s>&quot;dedicated&quot;</a-s>,
            },
            <a-s>&quot;runOptions&quot;</a-s>: {
                <a-s>&quot;runOn&quot;</a-s>: <a-s>&quot;folderOpen&quot;</a-s>
            }
        },
    ]
}</pre>
<p>&lt;a id="rust_analyzer_toolchain"&gt;&lt;/a&gt;</p>
<h2>rust_analyzer_toolchain</h2>
&lt;pre&gt;
rust_analyzer_toolchain(&lt;a href="#rust_analyzer_toolchain-name"&gt;name&lt;/a&gt;, &lt;a href="#rust_analyzer_toolchain-proc_macro_srv"&gt;proc_macro_srv&lt;/a&gt;, &lt;a href="#rust_analyzer_toolchain-rustc"&gt;rustc&lt;/a&gt;, &lt;a href="#rust_analyzer_toolchain-rustc_srcs"&gt;rustc_srcs&lt;/a&gt;)
&lt;/pre&gt;
<p>A toolchain for <a href="https://rust-analyzer.github.io/">rust-analyzer</a>.</p>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="rust_analyzer_toolchain-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_analyzer_toolchain-proc_macro_srv"&gt;&lt;/a&gt;proc_macro_srv</td><td style="text-align: left">The path to a &lt;code&gt;rust_analyzer_proc_macro_srv&lt;/code&gt; binary.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">optional</td><td style="text-align: left">&lt;code&gt;None&lt;/code&gt;</td></tr>
<tr><td style="text-align: left">&lt;a id="rust_analyzer_toolchain-rustc"&gt;&lt;/a&gt;rustc</td><td style="text-align: left">The path to a &lt;code&gt;rustc&lt;/code&gt; binary.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
<tr><td style="text-align: left">&lt;a id="rust_analyzer_toolchain-rustc_srcs"&gt;&lt;/a&gt;rustc_srcs</td><td style="text-align: left">The source code of rustc.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels"&gt;Label&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
</tbody></table>
<p>&lt;a id="rust_analyzer_aspect"&gt;&lt;/a&gt;</p>
<h2>rust_analyzer_aspect</h2>
&lt;pre&gt;
rust_analyzer_aspect(&lt;a href="#rust_analyzer_aspect-name"&gt;name&lt;/a&gt;)
&lt;/pre&gt;
<p>Annotates rust rules with RustAnalyzerInfo later used to build a rust-project.json</p>
<p><strong>ASPECT ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Type</th></tr></thead><tbody>
<tr><td style="text-align: left">deps</td><td style="text-align: left">String</td></tr>
<tr><td style="text-align: left">proc_macro_deps</td><td style="text-align: left">String</td></tr>
<tr><td style="text-align: left">crate</td><td style="text-align: left">String</td></tr>
<tr><td style="text-align: left">actual</td><td style="text-align: left">String</td></tr>
</tbody></table>
<p><strong>ATTRIBUTES</strong></p>
<table><thead><tr><th style="text-align: left">Name</th><th style="text-align: left">Description</th><th style="text-align: left">Type</th><th style="text-align: left">Mandatory</th><th style="text-align: left">Default</th></tr></thead><tbody>
<tr><td style="text-align: left">&lt;a id="rust_analyzer_aspect-name"&gt;&lt;/a&gt;name</td><td style="text-align: left">A unique name for this target.</td><td style="text-align: left">&lt;a href="https://bazel.build/concepts/labels#target-names"&gt;Name&lt;/a&gt;</td><td style="text-align: left">required</td><td style="text-align: left"></td></tr>
</tbody></table>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!-- Generated with Stardoc: http://skydoc.bazel.build --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>#</a-p> <a-tt>Rust Analyzer</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>* </a-p>[rust_analyzer_aspect](#rust_analyzer_aspect)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>* </a-p>[rust_analyzer_toolchain](#rust_analyzer_toolchain)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>## </a-p><a-tt>Overview</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>For [non-Cargo projects](https://rust-analyzer.github.io/manual.html#non-cargo-based-projects),</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>[rust-analyzer](https://rust-analyzer.github.io/) depends on a `rust-project.json` file at the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>root of the project that describes its structure. The `rust_analyzer` rule facilitates generating</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>such a file.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>### </a-p><a-tt>Setup</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>First, ensure `rules_rust` is setup in your workspace. By default, `rust_register_toolchains` will</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>ensure a [rust_analyzer_toolchain](#rust_analyzer_toolchain) is registered within the WORKSPACE.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>Next, load the dependencies for the `rust-project.json` generator tool:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//tools/rust_analyzer:deps.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_analyzer_dependencies&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>rust_analyzer_dependencies()</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>Finally, run `bazel run @rules_rust//tools/rust_analyzer:gen_rust_project`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>whenever dependencies change to regenerate the `rust-project.json` file. It</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>should be added to `.gitignore` because it is effectively a build artifact.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>Once the `rust-project.json` has been generated in the project root,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>rust-analyzer can pick it up upon restart.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>For users who do not use `rust_register_toolchains` to register toolchains, the following can be added</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>to their WORKSPACE to register a `rust_analyzer_toolchain`. Please make sure the Rust version used in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>this toolchain matches the version used by the currently registered toolchain or the sources/documentation</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>will not match what&#39;s being compiled with and can lead to confusing results.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>```</a-p><a-tl>python</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>load(</a-p><a-s>&quot;@rules_rust//rust:repositories.bzl&quot;</a-s><a-p>, </a-p><a-s>&quot;rust_analyzer_toolchain_repository&quot;</a-s><a-p>)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>register_toolchains(</a-p><a-f>rust_analyzer_toolchain_repository</a-f><a-p>(</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>    </a-p><a-v>name</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;rust_analyzer_toolchain&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>    </a-p><a-c># This should match the currently registered toolchain.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>    </a-p><a-v>version</a-v><a-p> </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;1.62.0&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>))</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>#### </a-p><a-tt>VSCode</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>To set this up using [VSCode](https://code.visualstudio.com/), users should first install the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>[rust_analyzer plugin](https://marketplace.visualstudio.com/items?itemName=matklad.rust-analyzer).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>With that in place, the following task can be added to the `.vscode/tasks.json` file of the workspace</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>to ensure a `rust-project.json` file is created and up to date when the editor is opened.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"><a-p>```</a-p><a-tl>json</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>{</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"><a-p>    </a-p><a-s>&quot;version&quot;</a-s><a-p>: </a-p><a-s>&quot;2.0.0&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>    </a-p><a-s>&quot;tasks&quot;</a-s><a-p>: [</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>        {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>            </a-p><a-s>&quot;label&quot;</a-s><a-p>: </a-p><a-s>&quot;Generate rust-project.json&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>            </a-p><a-s>&quot;command&quot;</a-s><a-p>: </a-p><a-s>&quot;bazel&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>            </a-p><a-s>&quot;args&quot;</a-s><a-p>: [</a-p><a-s>&quot;run&quot;</a-s><a-p>, </a-p><a-s>&quot;@rules_rust//tools/rust_analyzer:gen_rust_project&quot;</a-s><a-p>],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>            </a-p><a-s>&quot;options&quot;</a-s><a-p>: {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>                </a-p><a-s>&quot;cwd&quot;</a-s><a-p>: </a-p><a-s>&quot;${workspaceFolder}&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>            },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"><a-p>            </a-p><a-s>&quot;group&quot;</a-s><a-p>: </a-p><a-s>&quot;build&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>            </a-p><a-s>&quot;problemMatcher&quot;</a-s><a-p>: [],</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>            </a-p><a-s>&quot;presentation&quot;</a-s><a-p>: {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>                </a-p><a-s>&quot;reveal&quot;</a-s><a-p>: </a-p><a-s>&quot;never&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>                </a-p><a-s>&quot;panel&quot;</a-s><a-p>: </a-p><a-s>&quot;dedicated&quot;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>            },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>            </a-p><a-s>&quot;runOptions&quot;</a-s><a-p>: {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>                </a-p><a-s>&quot;runOn&quot;</a-s><a-p>: </a-p><a-s>&quot;folderOpen&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>            }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>        },</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>    ]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>&lt;a id=&quot;rust_analyzer_toolchain&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>## </a-p><a-tt>rust_analyzer_toolchain</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>rust_analyzer_toolchain(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_analyzer_toolchain-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_analyzer_toolchain-proc_macro_srv</a-s><a-p>&quot;&gt;proc_macro_srv&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_analyzer_toolchain-rustc</a-s><a-p>&quot;&gt;rustc&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;, &lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_analyzer_toolchain-rustc_srcs</a-s><a-p>&quot;&gt;rustc_srcs&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>A toolchain for [rust-analyzer](https://rust-analyzer.github.io/).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>**ATTRIBUTES**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>| Name  | Description | Type | Mandatory | Default |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"><a-p>| :------------- | :------------- | :------------- | :------------- | :------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_analyzer_toolchain-name&quot;&gt;&lt;/a&gt;name |  A unique name for this target.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_analyzer_toolchain-proc_macro_srv&quot;&gt;&lt;/a&gt;proc_macro_srv |  The path to a &lt;code&gt;rust_analyzer_proc_macro_srv&lt;/code&gt; binary.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | optional | &lt;code&gt;None&lt;/code&gt; |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_analyzer_toolchain-rustc&quot;&gt;&lt;/a&gt;rustc |  The path to a &lt;code&gt;rustc&lt;/code&gt; binary.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>| &lt;a id=&quot;rust_analyzer_toolchain-rustc_srcs&quot;&gt;&lt;/a&gt;rustc_srcs |  The source code of rustc.   | &lt;a href=&quot;https://bazel.build/concepts/labels&quot;&gt;Label&lt;/a&gt; | required |  |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>&lt;a id=&quot;rust_analyzer_aspect&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-p>## </a-p><a-tt>rust_analyzer_aspect</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>&lt;</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>rust_analyzer_aspect(&lt;</a-p><a-tg>a</a-tg><a-p> </a-p><a-at>href</a-at><a-p>=&quot;</a-p><a-s>#rust_analyzer_aspect-name</a-s><a-p>&quot;&gt;name&lt;/</a-p><a-tg>a</a-tg><a-p>&gt;)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>&lt;/</a-p><a-tg>pre</a-tg><a-p>&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text">Annotates rust rules with RustAnalyzerInfo later used to build a rust-project.json</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text">**ASPECT ATTRIBUTES**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text">| Name | Type |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text">| :------------- | :------------- |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text">| deps| String |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text">| proc_macro_deps| String |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text">| crate| String |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text">| actual| String |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text">**ATTRIBUTES**</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text">| Name  | Description | Type | Mandatory | Default |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text">| :------------- | :------------- | :------------- | :------------- | :------------- |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text">| &lt;a id=&quot;rust_analyzer_aspect-name&quot;&gt;&lt;/a&gt;name |  A unique name for this target.   | &lt;a href=&quot;https://bazel.build/concepts/labels#target-names&quot;&gt;Name&lt;/a&gt; | required |   |</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"></span></span></pre></div></div>
</main>
</body>
</html>
