diff options
Diffstat (limited to 'docs/posts/lightweight_linting')
-rw-r--r-- | docs/posts/lightweight_linting/index.html | 212 |
1 files changed, 151 insertions, 61 deletions
diff --git a/docs/posts/lightweight_linting/index.html b/docs/posts/lightweight_linting/index.html index 9bc84f2..b30c719 100644 --- a/docs/posts/lightweight_linting/index.html +++ b/docs/posts/lightweight_linting/index.html | |||
@@ -28,12 +28,12 @@ | |||
28 | 26/01 — 2022 | 28 | 26/01 — 2022 |
29 | <div class="stats"> | 29 | <div class="stats"> |
30 | <span class="stats-number"> | 30 | <span class="stats-number"> |
31 | 170.62 | 31 | 170.63 |
32 | </span> | 32 | </span> |
33 | <span class="stats-unit">cm</span> | 33 | <span class="stats-unit">cm</span> |
34 |   | 34 |   |
35 | <span class="stats-number"> | 35 | <span class="stats-number"> |
36 | 8.5 | 36 | 8.6 |
37 | </span> | 37 | </span> |
38 | <span class="stats-unit">min</span> | 38 | <span class="stats-unit">min</span> |
39 | </div> | 39 | </div> |
@@ -42,14 +42,23 @@ | |||
42 | Lightweight Linting | 42 | Lightweight Linting |
43 | </h1> | 43 | </h1> |
44 | <div class="post-text"> | 44 | <div class="post-text"> |
45 | <p><a href="https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries">Tree-sitter</a> queries allow you to search for patterns in syntax trees, much like a regex would, in text. Combine that with some Rust glue to write simple, custom linters.</p> | 45 | <p><a |
46 | href="https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries">Tree-sitter</a> | ||
47 | queries allow you to search for patterns in syntax trees, much like a | ||
48 | regex would, in text. Combine that with some Rust glue to write simple, | ||
49 | custom linters.</p> | ||
46 | <h3 id="tree-sitter-syntax-trees">Tree-sitter syntax trees</h3> | 50 | <h3 id="tree-sitter-syntax-trees">Tree-sitter syntax trees</h3> |
47 | <p>Here is a quick crash course on syntax trees generated by tree-sitter. Syntax trees produced by tree-sitter are represented by S-expressions. The generated S-expression for the following Rust code,</p> | 51 | <p>Here is a quick crash course on syntax trees generated by |
48 | <div class="sourceCode" id="cb1"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> main() <span class="op">{</span></span> | 52 | tree-sitter. Syntax trees produced by tree-sitter are represented by |
53 | S-expressions. The generated S-expression for the following Rust | ||
54 | code,</p> | ||
55 | <div class="sourceCode" id="cb1"><pre | ||
56 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> main() <span class="op">{</span></span> | ||
49 | <span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> x <span class="op">=</span> <span class="dv">2</span><span class="op">;</span></span> | 57 | <span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> x <span class="op">=</span> <span class="dv">2</span><span class="op">;</span></span> |
50 | <span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div> | 58 | <span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div> |
51 | <p>would be:</p> | 59 | <p>would be:</p> |
52 | <div class="sourceCode" id="cb2"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>(source_file</span> | 60 | <div class="sourceCode" id="cb2"><pre |
61 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a>(source_file</span> | ||
53 | <span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> (function_item</span> | 62 | <span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> (function_item</span> |
54 | <span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> name: (identifier)</span> | 63 | <span id="cb2-3"><a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> name: (identifier)</span> |
55 | <span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> parameters: (parameters)</span> | 64 | <span id="cb2-4"><a href="#cb2-4" aria-hidden="true" tabindex="-1"></a> parameters: (parameters)</span> |
@@ -58,13 +67,19 @@ | |||
58 | <span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a> (let_declaration </span> | 67 | <span id="cb2-7"><a href="#cb2-7" aria-hidden="true" tabindex="-1"></a> (let_declaration </span> |
59 | <span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span> | 68 | <span id="cb2-8"><a href="#cb2-8" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span> |
60 | <span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a> value: (integer_literal)))))</span></code></pre></div> | 69 | <span id="cb2-9"><a href="#cb2-9" aria-hidden="true" tabindex="-1"></a> value: (integer_literal)))))</span></code></pre></div> |
61 | <p>Syntax trees generated by tree-sitter have a couple of other cool properties: they are <em>lossless</em> syntax trees. Given a lossless syntax tree, you can regenerate the original source code in its entirety. Consider the following addition to our example:</p> | 70 | <p>Syntax trees generated by tree-sitter have a couple of other cool |
62 | <div class="sourceCode" id="cb3"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a> <span class="kw">fn</span> main() <span class="op">{</span></span> | 71 | properties: they are <em>lossless</em> syntax trees. Given a lossless |
72 | syntax tree, you can regenerate the original source code in its | ||
73 | entirety. Consider the following addition to our example:</p> | ||
74 | <div class="sourceCode" id="cb3"><pre | ||
75 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a> <span class="kw">fn</span> main() <span class="op">{</span></span> | ||
63 | <span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="co">// a comment goes here</span></span> | 76 | <span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="op">+</span> <span class="co">// a comment goes here</span></span> |
64 | <span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> x <span class="op">=</span> <span class="dv">2</span><span class="op">;</span></span> | 77 | <span id="cb3-3"><a href="#cb3-3" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> x <span class="op">=</span> <span class="dv">2</span><span class="op">;</span></span> |
65 | <span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div> | 78 | <span id="cb3-4"><a href="#cb3-4" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span></code></pre></div> |
66 | <p>The tree-sitter syntax tree preserves the comment, while the typical abstract syntax tree wouldn’t:</p> | 79 | <p>The tree-sitter syntax tree preserves the comment, while the typical |
67 | <div class="sourceCode" id="cb4"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a> (source_file</span> | 80 | abstract syntax tree wouldn’t:</p> |
81 | <div class="sourceCode" id="cb4"><pre | ||
82 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a> (source_file</span> | ||
68 | <span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> (function_item</span> | 83 | <span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> (function_item</span> |
69 | <span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a> name: (identifier)</span> | 84 | <span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a> name: (identifier)</span> |
70 | <span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a> parameters: (parameters)</span> | 85 | <span id="cb4-4"><a href="#cb4-4" aria-hidden="true" tabindex="-1"></a> parameters: (parameters)</span> |
@@ -75,25 +90,34 @@ | |||
75 | <span id="cb4-9"><a href="#cb4-9" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span> | 90 | <span id="cb4-9"><a href="#cb4-9" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span> |
76 | <span id="cb4-10"><a href="#cb4-10" aria-hidden="true" tabindex="-1"></a> value: (integer_literal)))))</span></code></pre></div> | 91 | <span id="cb4-10"><a href="#cb4-10" aria-hidden="true" tabindex="-1"></a> value: (integer_literal)))))</span></code></pre></div> |
77 | <h3 id="tree-sitter-queries">Tree-sitter queries</h3> | 92 | <h3 id="tree-sitter-queries">Tree-sitter queries</h3> |
78 | <p>Tree-sitter provides a DSL to match over CSTs. These queries resemble our S-expression syntax trees, here is a query to match all line comments in a Rust CST:</p> | 93 | <p>Tree-sitter provides a DSL to match over CSTs. These queries resemble |
79 | <div class="sourceCode" id="cb5"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>(line_comment)</span> | 94 | our S-expression syntax trees, here is a query to match all line |
95 | comments in a Rust CST:</p> | ||
96 | <div class="sourceCode" id="cb5"><pre | ||
97 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>(line_comment)</span> | ||
80 | <span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a></span> | 98 | <span id="cb5-2"><a href="#cb5-2" aria-hidden="true" tabindex="-1"></a></span> |
81 | <span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="co">; matches the following rust code</span></span> | 99 | <span id="cb5-3"><a href="#cb5-3" aria-hidden="true" tabindex="-1"></a><span class="co">; matches the following rust code</span></span> |
82 | <span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a><span class="co">; // a comment goes here</span></span></code></pre></div> | 100 | <span id="cb5-4"><a href="#cb5-4" aria-hidden="true" tabindex="-1"></a><span class="co">; // a comment goes here</span></span></code></pre></div> |
83 | <p>Neat, eh? But don’t take my word for it, give it a go on the <a href="https://tree-sitter.github.io/tree-sitter/playground">tree-sitter playground</a>. Type in a query like so:</p> | 101 | <p>Neat, eh? But don’t take my word for it, give it a go on the <a |
84 | <div class="sourceCode" id="cb6"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="co">; the web playground requires you to specify a "capture"</span></span> | 102 | href="https://tree-sitter.github.io/tree-sitter/playground">tree-sitter |
103 | playground</a>. Type in a query like so:</p> | ||
104 | <div class="sourceCode" id="cb6"><pre | ||
105 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="co">; the web playground requires you to specify a "capture"</span></span> | ||
85 | <span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="co">; you will notice the capture and the nodes it captured</span></span> | 106 | <span id="cb6-2"><a href="#cb6-2" aria-hidden="true" tabindex="-1"></a><span class="co">; you will notice the capture and the nodes it captured</span></span> |
86 | <span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="co">; turn blue</span></span> | 107 | <span id="cb6-3"><a href="#cb6-3" aria-hidden="true" tabindex="-1"></a><span class="co">; turn blue</span></span> |
87 | <span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a>(line_comment) @capture</span></code></pre></div> | 108 | <span id="cb6-4"><a href="#cb6-4" aria-hidden="true" tabindex="-1"></a>(line_comment) @capture</span></code></pre></div> |
88 | <p>Here’s another to match <code>let</code> expressions that bind an integer to an identifier:</p> | 109 | <p>Here’s another to match <code>let</code> expressions that bind an |
89 | <div class="sourceCode" id="cb7"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a>(let_declaration</span> | 110 | integer to an identifier:</p> |
111 | <div class="sourceCode" id="cb7"><pre | ||
112 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a>(let_declaration</span> | ||
90 | <span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span> | 113 | <span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span> |
91 | <span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span> | 114 | <span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span> |
92 | <span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a> </span> | 115 | <span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a> </span> |
93 | <span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="co">; matches:</span></span> | 116 | <span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="co">; matches:</span></span> |
94 | <span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 2;</span></span></code></pre></div> | 117 | <span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 2;</span></span></code></pre></div> |
95 | <p>We can <em>capture</em> nodes into variables:</p> | 118 | <p>We can <em>capture</em> nodes into variables:</p> |
96 | <div class="sourceCode" id="cb8"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a>(let_declaration </span> | 119 | <div class="sourceCode" id="cb8"><pre |
120 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a>(let_declaration </span> | ||
97 | <span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span> | 121 | <span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span> |
98 | <span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span> | 122 | <span id="cb8-3"><a href="#cb8-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span> |
99 | <span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> </span> | 123 | <span id="cb8-4"><a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> </span> |
@@ -103,7 +127,8 @@ | |||
103 | <span id="cb8-8"><a href="#cb8-8" aria-hidden="true" tabindex="-1"></a><span class="co">; captures:</span></span> | 127 | <span id="cb8-8"><a href="#cb8-8" aria-hidden="true" tabindex="-1"></a><span class="co">; captures:</span></span> |
104 | <span id="cb8-9"><a href="#cb8-9" aria-hidden="true" tabindex="-1"></a><span class="co">; foo</span></span></code></pre></div> | 128 | <span id="cb8-9"><a href="#cb8-9" aria-hidden="true" tabindex="-1"></a><span class="co">; foo</span></span></code></pre></div> |
105 | <p>And apply certain <em>predicates</em> to captures:</p> | 129 | <p>And apply certain <em>predicates</em> to captures:</p> |
106 | <div class="sourceCode" id="cb9"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>((let_declaration</span> | 130 | <div class="sourceCode" id="cb9"><pre |
131 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a>((let_declaration</span> | ||
107 | <span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span> | 132 | <span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span> |
108 | <span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span> | 133 | <span id="cb9-3"><a href="#cb9-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span> |
109 | <span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a> (<span class="sc">#e</span>q? @my-capture <span class="st">"foo"</span>))</span> | 134 | <span id="cb9-4"><a href="#cb9-4" aria-hidden="true" tabindex="-1"></a> (<span class="sc">#e</span>q? @my-capture <span class="st">"foo"</span>))</span> |
@@ -113,8 +138,10 @@ | |||
113 | <span id="cb9-8"><a href="#cb9-8" aria-hidden="true" tabindex="-1"></a></span> | 138 | <span id="cb9-8"><a href="#cb9-8" aria-hidden="true" tabindex="-1"></a></span> |
114 | <span id="cb9-9"><a href="#cb9-9" aria-hidden="true" tabindex="-1"></a><span class="co">; and not:</span></span> | 139 | <span id="cb9-9"><a href="#cb9-9" aria-hidden="true" tabindex="-1"></a><span class="co">; and not:</span></span> |
115 | <span id="cb9-10"><a href="#cb9-10" aria-hidden="true" tabindex="-1"></a><span class="co">; let bar = 2;</span></span></code></pre></div> | 140 | <span id="cb9-10"><a href="#cb9-10" aria-hidden="true" tabindex="-1"></a><span class="co">; let bar = 2;</span></span></code></pre></div> |
116 | <p>The <code>#match?</code> predicate checks if a capture matches a regex:</p> | 141 | <p>The <code>#match?</code> predicate checks if a capture matches a |
117 | <div class="sourceCode" id="cb10"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a>((let_declaration</span> | 142 | regex:</p> |
143 | <div class="sourceCode" id="cb10"><pre | ||
144 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a>((let_declaration</span> | ||
118 | <span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span> | 145 | <span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier) @my-capture</span> |
119 | <span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span> | 146 | <span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a> value: (integer_literal))</span> |
120 | <span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a> (#match? @my-capture <span class="st">"foo|bar"</span>))</span> | 147 | <span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a> (#match? @my-capture <span class="st">"foo|bar"</span>))</span> |
@@ -122,8 +149,10 @@ | |||
122 | <span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a><span class="co">; matches both `foo` and `bar`:</span></span> | 149 | <span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a><span class="co">; matches both `foo` and `bar`:</span></span> |
123 | <span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 2;</span></span> | 150 | <span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 2;</span></span> |
124 | <span id="cb10-8"><a href="#cb10-8" aria-hidden="true" tabindex="-1"></a><span class="co">; let bar = 2;</span></span></code></pre></div> | 151 | <span id="cb10-8"><a href="#cb10-8" aria-hidden="true" tabindex="-1"></a><span class="co">; let bar = 2;</span></span></code></pre></div> |
125 | <p>Exhibit indifference, as a stoic programmer would, with the <em>wildcard</em> pattern:</p> | 152 | <p>Exhibit indifference, as a stoic programmer would, with the |
126 | <div class="sourceCode" id="cb11"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a>(let_declaration</span> | 153 | <em>wildcard</em> pattern:</p> |
154 | <div class="sourceCode" id="cb11"><pre | ||
155 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a>(let_declaration</span> | ||
127 | <span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span> | 156 | <span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a> pattern: (identifier)</span> |
128 | <span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a> value: (<span class="op">_</span>))</span> | 157 | <span id="cb11-3"><a href="#cb11-3" aria-hidden="true" tabindex="-1"></a> value: (<span class="op">_</span>))</span> |
129 | <span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> </span> | 158 | <span id="cb11-4"><a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> </span> |
@@ -131,73 +160,106 @@ | |||
131 | <span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = "foo";</span></span> | 160 | <span id="cb11-6"><a href="#cb11-6" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = "foo";</span></span> |
132 | <span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 42;</span></span> | 161 | <span id="cb11-7"><a href="#cb11-7" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = 42;</span></span> |
133 | <span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = bar;</span></span></code></pre></div> | 162 | <span id="cb11-8"><a href="#cb11-8" aria-hidden="true" tabindex="-1"></a><span class="co">; let foo = bar;</span></span></code></pre></div> |
134 | <p><a href="https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries">The documentation</a> does the tree-sitter query DSL more justice, but we now know enough to write our first lint.</p> | 163 | <p><a |
164 | href="https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries">The | ||
165 | documentation</a> does the tree-sitter query DSL more justice, but we | ||
166 | now know enough to write our first lint.</p> | ||
135 | <h3 id="write-you-a-tree-sitter-lint">Write you a tree-sitter lint</h3> | 167 | <h3 id="write-you-a-tree-sitter-lint">Write you a tree-sitter lint</h3> |
136 | <p>Strings in <code>std::env</code> functions are error prone:</p> | 168 | <p>Strings in <code>std::env</code> functions are error prone:</p> |
137 | <div class="sourceCode" id="cb12"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(<span class="st">"RUST_BACKTACE"</span>)<span class="op">;</span></span> | 169 | <div class="sourceCode" id="cb12"><pre |
170 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb12-1"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(<span class="st">"RUST_BACKTACE"</span>)<span class="op">;</span></span> | ||
138 | <span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a> <span class="co">// ^^^^ "TACE" instead of "TRACE"</span></span></code></pre></div> | 171 | <span id="cb12-2"><a href="#cb12-2" aria-hidden="true" tabindex="-1"></a> <span class="co">// ^^^^ "TACE" instead of "TRACE"</span></span></code></pre></div> |
139 | <p>I prefer this instead:</p> | 172 | <p>I prefer this instead:</p> |
140 | <div class="sourceCode" id="cb13"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="co">// somewhere in a module that is well spellchecked</span></span> | 173 | <div class="sourceCode" id="cb13"><pre |
174 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb13-1"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a><span class="co">// somewhere in a module that is well spellchecked</span></span> | ||
141 | <span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a><span class="kw">static</span> BACKTRACE<span class="op">:</span> <span class="op">&</span><span class="dt">str</span> <span class="op">=</span> <span class="st">"RUST_BACKTRACE"</span><span class="op">;</span></span> | 175 | <span id="cb13-2"><a href="#cb13-2" aria-hidden="true" tabindex="-1"></a><span class="kw">static</span> BACKTRACE<span class="op">:</span> <span class="op">&</span><span class="dt">str</span> <span class="op">=</span> <span class="st">"RUST_BACKTRACE"</span><span class="op">;</span></span> |
142 | <span id="cb13-3"><a href="#cb13-3" aria-hidden="true" tabindex="-1"></a></span> | 176 | <span id="cb13-3"><a href="#cb13-3" aria-hidden="true" tabindex="-1"></a></span> |
143 | <span id="cb13-4"><a href="#cb13-4" aria-hidden="true" tabindex="-1"></a><span class="co">// rest of the codebase</span></span> | 177 | <span id="cb13-4"><a href="#cb13-4" aria-hidden="true" tabindex="-1"></a><span class="co">// rest of the codebase</span></span> |
144 | <span id="cb13-5"><a href="#cb13-5" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(BACKTRACE)<span class="op">;</span></span></code></pre></div> | 178 | <span id="cb13-5"><a href="#cb13-5" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(BACKTRACE)<span class="op">;</span></span></code></pre></div> |
145 | <p>Let’s write a lint to find <code>std::env</code> functions that use strings. Put aside the effectiveness of this lint for the moment, and take a stab at writing a tree-sitter query. For reference, a function call like so:</p> | 179 | <p>Let’s write a lint to find <code>std::env</code> functions that use |
146 | <div class="sourceCode" id="cb14"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a>remove_var(<span class="st">"RUST_BACKTRACE"</span>)</span></code></pre></div> | 180 | strings. Put aside the effectiveness of this lint for the moment, and |
181 | take a stab at writing a tree-sitter query. For reference, a function | ||
182 | call like so:</p> | ||
183 | <div class="sourceCode" id="cb14"><pre | ||
184 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb14-1"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a>remove_var(<span class="st">"RUST_BACKTRACE"</span>)</span></code></pre></div> | ||
147 | <p>Produces the following S-expression:</p> | 185 | <p>Produces the following S-expression:</p> |
148 | <div class="sourceCode" id="cb15"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a>(call_expression</span> | 186 | <div class="sourceCode" id="cb15"><pre |
187 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a>(call_expression</span> | ||
149 | <span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a> function: (identifier)</span> | 188 | <span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a> function: (identifier)</span> |
150 | <span id="cb15-3"><a href="#cb15-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments (string_literal)))</span></code></pre></div> | 189 | <span id="cb15-3"><a href="#cb15-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments (string_literal)))</span></code></pre></div> |
151 | <p>We are definitely looking for a <code>call_expression</code>:</p> | 190 | <p>We are definitely looking for a <code>call_expression</code>:</p> |
152 | <div class="sourceCode" id="cb16"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a>(call_expression) @raise</span></code></pre></div> | 191 | <div class="sourceCode" id="cb16"><pre |
153 | <p>Whose function name matches <code>std::env::var</code> or <code>std::env::remove_var</code> at the very least (I know, I know, this isn’t the most optimal regex):</p> | 192 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a>(call_expression) @raise</span></code></pre></div> |
154 | <div class="sourceCode" id="cb17"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span> | 193 | <p>Whose function name matches <code>std::env::var</code> or |
194 | <code>std::env::remove_var</code> at the very least (I know, I know, | ||
195 | this isn’t the most optimal regex):</p> | ||
196 | <div class="sourceCode" id="cb17"><pre | ||
197 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb17-1"><a href="#cb17-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span> | ||
155 | <span id="cb17-2"><a href="#cb17-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name) @raise</span> | 198 | <span id="cb17-2"><a href="#cb17-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name) @raise</span> |
156 | <span id="cb17-3"><a href="#cb17-3" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">"std::env::(var|remove_var)"</span>))</span></code></pre></div> | 199 | <span id="cb17-3"><a href="#cb17-3" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">"std::env::(var|remove_var)"</span>))</span></code></pre></div> |
157 | <p>Let’s turn that <code>std::</code> prefix optional:</p> | 200 | <p>Let’s turn that <code>std::</code> prefix optional:</p> |
158 | <div class="sourceCode" id="cb18"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span> | 201 | <div class="sourceCode" id="cb18"><pre |
202 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb18-1"><a href="#cb18-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span> | ||
159 | <span id="cb18-2"><a href="#cb18-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name) @raise</span> | 203 | <span id="cb18-2"><a href="#cb18-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name) @raise</span> |
160 | <span id="cb18-3"><a href="#cb18-3" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">"(std::|)env::(var|remove_var)"</span>))</span></code></pre></div> | 204 | <span id="cb18-3"><a href="#cb18-3" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">"(std::|)env::(var|remove_var)"</span>))</span></code></pre></div> |
161 | <p>And ensure that <code>arguments</code> is a string:</p> | 205 | <p>And ensure that <code>arguments</code> is a string:</p> |
162 | <div class="sourceCode" id="cb19"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span> | 206 | <div class="sourceCode" id="cb19"><pre |
207 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb19-1"><a href="#cb19-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span> | ||
163 | <span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name</span> | 208 | <span id="cb19-2"><a href="#cb19-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name</span> |
164 | <span id="cb19-3"><a href="#cb19-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments (string_literal)))</span> | 209 | <span id="cb19-3"><a href="#cb19-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments (string_literal)))</span> |
165 | <span id="cb19-4"><a href="#cb19-4" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">"(std::|)env::(var|remove_var)"</span>))</span></code></pre></div> | 210 | <span id="cb19-4"><a href="#cb19-4" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">"(std::|)env::(var|remove_var)"</span>))</span></code></pre></div> |
166 | <h3 id="running-our-linter">Running our linter</h3> | 211 | <h3 id="running-our-linter">Running our linter</h3> |
167 | <p>We could always plug our query into the web playground, but let’s go a step further:</p> | 212 | <p>We could always plug our query into the web playground, but let’s go |
168 | <div class="sourceCode" id="cb20"><pre class="sourceCode bash"><code class="sourceCode bash"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a><span class="ex">cargo</span> new <span class="at">--bin</span> toy-lint</span></code></pre></div> | 213 | a step further:</p> |
169 | <p>Add <code>tree-sitter</code> and <code>tree-sitter-rust</code> to your dependencies:</p> | 214 | <div class="sourceCode" id="cb20"><pre |
170 | <div class="sourceCode" id="cb21"><pre class="sourceCode toml"><code class="sourceCode toml"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="co"># within Cargo.toml</span></span> | 215 | class="sourceCode bash"><code class="sourceCode bash"><span id="cb20-1"><a href="#cb20-1" aria-hidden="true" tabindex="-1"></a><span class="ex">cargo</span> new <span class="at">--bin</span> toy-lint</span></code></pre></div> |
216 | <p>Add <code>tree-sitter</code> and <code>tree-sitter-rust</code> to | ||
217 | your dependencies:</p> | ||
218 | <div class="sourceCode" id="cb21"><pre | ||
219 | class="sourceCode toml"><code class="sourceCode toml"><span id="cb21-1"><a href="#cb21-1" aria-hidden="true" tabindex="-1"></a><span class="co"># within Cargo.toml</span></span> | ||
171 | <span id="cb21-2"><a href="#cb21-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[</span><span class="dt">dependencies</span><span class="kw">]</span></span> | 220 | <span id="cb21-2"><a href="#cb21-2" aria-hidden="true" tabindex="-1"></a><span class="kw">[</span><span class="dt">dependencies</span><span class="kw">]</span></span> |
172 | <span id="cb21-3"><a href="#cb21-3" aria-hidden="true" tabindex="-1"></a><span class="dt">tree-sitter</span> <span class="op">=</span> <span class="st">"0.20"</span></span> | 221 | <span id="cb21-3"><a href="#cb21-3" aria-hidden="true" tabindex="-1"></a><span class="dt">tree-sitter</span> <span class="op">=</span> <span class="st">"0.20"</span></span> |
173 | <span id="cb21-4"><a href="#cb21-4" aria-hidden="true" tabindex="-1"></a></span> | 222 | <span id="cb21-4"><a href="#cb21-4" aria-hidden="true" tabindex="-1"></a></span> |
174 | <span id="cb21-5"><a href="#cb21-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[</span><span class="dt">dependencies</span><span class="kw">.</span><span class="dt">tree-sitter-rust</span><span class="kw">]</span></span> | 223 | <span id="cb21-5"><a href="#cb21-5" aria-hidden="true" tabindex="-1"></a><span class="kw">[</span><span class="dt">dependencies</span><span class="kw">.</span><span class="dt">tree-sitter-rust</span><span class="kw">]</span></span> |
175 | <span id="cb21-6"><a href="#cb21-6" aria-hidden="true" tabindex="-1"></a><span class="dt">git</span> <span class="op">=</span> <span class="st">"https://github.com/tree-sitter/tree-sitter-rust"</span></span></code></pre></div> | 224 | <span id="cb21-6"><a href="#cb21-6" aria-hidden="true" tabindex="-1"></a><span class="dt">git</span> <span class="op">=</span> <span class="st">"https://github.com/tree-sitter/tree-sitter-rust"</span></span></code></pre></div> |
176 | <p>Let’s load in some Rust code to work with. As <a href="https://en.wikipedia.org/wiki/Self-reference">an ode to Gödel</a> (G<code>ode</code>l?), why not load in our linter itself:</p> | 225 | <p>Let’s load in some Rust code to work with. As <a |
177 | <div class="sourceCode" id="cb22"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> main() <span class="op">{</span></span> | 226 | href="https://en.wikipedia.org/wiki/Self-reference">an ode to Gödel</a> |
227 | (G<code>ode</code>l?), why not load in our linter itself:</p> | ||
228 | <div class="sourceCode" id="cb22"><pre | ||
229 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb22-1"><a href="#cb22-1" aria-hidden="true" tabindex="-1"></a><span class="kw">fn</span> main() <span class="op">{</span></span> | ||
178 | <span id="cb22-2"><a href="#cb22-2" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> src <span class="op">=</span> <span class="pp">include_str!</span>(<span class="st">"main.rs"</span>)<span class="op">;</span></span> | 230 | <span id="cb22-2"><a href="#cb22-2" aria-hidden="true" tabindex="-1"></a> <span class="kw">let</span> src <span class="op">=</span> <span class="pp">include_str!</span>(<span class="st">"main.rs"</span>)<span class="op">;</span></span> |
179 | <span id="cb22-3"><a href="#cb22-3" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div> | 231 | <span id="cb22-3"><a href="#cb22-3" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div> |
180 | <p>Most tree-sitter APIs require a reference to a <code>Language</code> struct, we will be working with Rust if you haven’t already guessed:</p> | 232 | <p>Most tree-sitter APIs require a reference to a <code>Language</code> |
181 | <div class="sourceCode" id="cb23"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Language<span class="op">;</span></span> | 233 | struct, we will be working with Rust if you haven’t already guessed:</p> |
234 | <div class="sourceCode" id="cb23"><pre | ||
235 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb23-1"><a href="#cb23-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Language<span class="op">;</span></span> | ||
182 | <span id="cb23-2"><a href="#cb23-2" aria-hidden="true" tabindex="-1"></a></span> | 236 | <span id="cb23-2"><a href="#cb23-2" aria-hidden="true" tabindex="-1"></a></span> |
183 | <span id="cb23-3"><a href="#cb23-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> rust_lang<span class="op">:</span> Language <span class="op">=</span> <span class="pp">tree_sitter_rust::</span>language()<span class="op">;</span></span></code></pre></div> | 237 | <span id="cb23-3"><a href="#cb23-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> rust_lang<span class="op">:</span> Language <span class="op">=</span> <span class="pp">tree_sitter_rust::</span>language()<span class="op">;</span></span></code></pre></div> |
184 | <p>Enough scaffolding, let’s parse some Rust:</p> | 238 | <p>Enough scaffolding, let’s parse some Rust:</p> |
185 | <div class="sourceCode" id="cb24"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Parser<span class="op">;</span></span> | 239 | <div class="sourceCode" id="cb24"><pre |
240 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb24-1"><a href="#cb24-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Parser<span class="op">;</span></span> | ||
186 | <span id="cb24-2"><a href="#cb24-2" aria-hidden="true" tabindex="-1"></a></span> | 241 | <span id="cb24-2"><a href="#cb24-2" aria-hidden="true" tabindex="-1"></a></span> |
187 | <span id="cb24-3"><a href="#cb24-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> <span class="kw">mut</span> parser <span class="op">=</span> <span class="pp">Parser::</span>new()<span class="op">;</span></span> | 242 | <span id="cb24-3"><a href="#cb24-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> <span class="kw">mut</span> parser <span class="op">=</span> <span class="pp">Parser::</span>new()<span class="op">;</span></span> |
188 | <span id="cb24-4"><a href="#cb24-4" aria-hidden="true" tabindex="-1"></a>parser<span class="op">.</span>set_language(rust_lang)<span class="op">.</span>unwrap()<span class="op">;</span></span> | 243 | <span id="cb24-4"><a href="#cb24-4" aria-hidden="true" tabindex="-1"></a>parser<span class="op">.</span>set_language(rust_lang)<span class="op">.</span>unwrap()<span class="op">;</span></span> |
189 | <span id="cb24-5"><a href="#cb24-5" aria-hidden="true" tabindex="-1"></a></span> | 244 | <span id="cb24-5"><a href="#cb24-5" aria-hidden="true" tabindex="-1"></a></span> |
190 | <span id="cb24-6"><a href="#cb24-6" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> parse_tree <span class="op">=</span> parser<span class="op">.</span>parse(<span class="op">&</span>src<span class="op">,</span> <span class="cn">None</span>)<span class="op">.</span>unwrap()<span class="op">;</span></span></code></pre></div> | 245 | <span id="cb24-6"><a href="#cb24-6" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> parse_tree <span class="op">=</span> parser<span class="op">.</span>parse(<span class="op">&</span>src<span class="op">,</span> <span class="cn">None</span>)<span class="op">.</span>unwrap()<span class="op">;</span></span></code></pre></div> |
191 | <p>The second argument to <code>Parser::parse</code> may be of interest. Tree-sitter has this cool feature that allows for quick reparsing of existing parse trees if they contain edits. If you do happen to want to reparse a source file, you can pass in the old tree:</p> | 246 | <p>The second argument to <code>Parser::parse</code> may be of interest. |
192 | <div class="sourceCode" id="cb25"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a><span class="co">// if you wish to reparse instead of parse</span></span> | 247 | Tree-sitter has this cool feature that allows for quick reparsing of |
248 | existing parse trees if they contain edits. If you do happen to want to | ||
249 | reparse a source file, you can pass in the old tree:</p> | ||
250 | <div class="sourceCode" id="cb25"><pre | ||
251 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb25-1"><a href="#cb25-1" aria-hidden="true" tabindex="-1"></a><span class="co">// if you wish to reparse instead of parse</span></span> | ||
193 | <span id="cb25-2"><a href="#cb25-2" aria-hidden="true" tabindex="-1"></a>old_tree<span class="op">.</span>edit(<span class="co">/* redacted */</span>)<span class="op">;</span></span> | 252 | <span id="cb25-2"><a href="#cb25-2" aria-hidden="true" tabindex="-1"></a>old_tree<span class="op">.</span>edit(<span class="co">/* redacted */</span>)<span class="op">;</span></span> |
194 | <span id="cb25-3"><a href="#cb25-3" aria-hidden="true" tabindex="-1"></a></span> | 253 | <span id="cb25-3"><a href="#cb25-3" aria-hidden="true" tabindex="-1"></a></span> |
195 | <span id="cb25-4"><a href="#cb25-4" aria-hidden="true" tabindex="-1"></a><span class="co">// generate shiny new reparsed tree</span></span> | 254 | <span id="cb25-4"><a href="#cb25-4" aria-hidden="true" tabindex="-1"></a><span class="co">// generate shiny new reparsed tree</span></span> |
196 | <span id="cb25-5"><a href="#cb25-5" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> new_tree <span class="op">=</span> parser<span class="op">.</span>parse(<span class="op">&</span>src<span class="op">,</span> <span class="cn">Some</span>(old_tree))<span class="op">.</span>unwrap()</span></code></pre></div> | 255 | <span id="cb25-5"><a href="#cb25-5" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> new_tree <span class="op">=</span> parser<span class="op">.</span>parse(<span class="op">&</span>src<span class="op">,</span> <span class="cn">Some</span>(old_tree))<span class="op">.</span>unwrap()</span></code></pre></div> |
197 | <p>Anyhow (<a href="http://github.com/dtolnay/anyhow">hah!</a>), now that we have a parse tree, we can inspect it:</p> | 256 | <p>Anyhow (<a href="http://github.com/dtolnay/anyhow">hah!</a>), now |
198 | <div class="sourceCode" id="cb26"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a><span class="pp">println!</span>(<span class="st">"{}"</span><span class="op">,</span> parse_tree<span class="op">.</span>root_node()<span class="op">.</span>to_sexp())<span class="op">;</span></span></code></pre></div> | 257 | that we have a parse tree, we can inspect it:</p> |
258 | <div class="sourceCode" id="cb26"><pre | ||
259 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb26-1"><a href="#cb26-1" aria-hidden="true" tabindex="-1"></a><span class="pp">println!</span>(<span class="st">"{}"</span><span class="op">,</span> parse_tree<span class="op">.</span>root_node()<span class="op">.</span>to_sexp())<span class="op">;</span></span></code></pre></div> | ||
199 | <p>Or better yet, run a query on it:</p> | 260 | <p>Or better yet, run a query on it:</p> |
200 | <div class="sourceCode" id="cb27"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Query<span class="op">;</span></span> | 261 | <div class="sourceCode" id="cb27"><pre |
262 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb27-1"><a href="#cb27-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>Query<span class="op">;</span></span> | ||
201 | <span id="cb27-2"><a href="#cb27-2" aria-hidden="true" tabindex="-1"></a></span> | 263 | <span id="cb27-2"><a href="#cb27-2" aria-hidden="true" tabindex="-1"></a></span> |
202 | <span id="cb27-3"><a href="#cb27-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> query <span class="op">=</span> <span class="pp">Query::</span>new(</span> | 264 | <span id="cb27-3"><a href="#cb27-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> query <span class="op">=</span> <span class="pp">Query::</span>new(</span> |
203 | <span id="cb27-4"><a href="#cb27-4" aria-hidden="true" tabindex="-1"></a> rust_lang<span class="op">,</span></span> | 265 | <span id="cb27-4"><a href="#cb27-4" aria-hidden="true" tabindex="-1"></a> rust_lang<span class="op">,</span></span> |
@@ -209,8 +271,11 @@ | |||
209 | <span id="cb27-10"><a href="#cb27-10" aria-hidden="true" tabindex="-1"></a><span class="st"> "#</span></span> | 271 | <span id="cb27-10"><a href="#cb27-10" aria-hidden="true" tabindex="-1"></a><span class="st"> "#</span></span> |
210 | <span id="cb27-11"><a href="#cb27-11" aria-hidden="true" tabindex="-1"></a>)</span> | 272 | <span id="cb27-11"><a href="#cb27-11" aria-hidden="true" tabindex="-1"></a>)</span> |
211 | <span id="cb27-12"><a href="#cb27-12" aria-hidden="true" tabindex="-1"></a><span class="op">.</span>unwrap()<span class="op">;</span></span></code></pre></div> | 273 | <span id="cb27-12"><a href="#cb27-12" aria-hidden="true" tabindex="-1"></a><span class="op">.</span>unwrap()<span class="op">;</span></span></code></pre></div> |
212 | <p>A <code>QueryCursor</code> is tree-sitter’s way of maintaining state as we iterate through the matches or captures produced by running a query on the parse tree. Observe:</p> | 274 | <p>A <code>QueryCursor</code> is tree-sitter’s way of maintaining state |
213 | <div class="sourceCode" id="cb28"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>QueryCursor<span class="op">;</span></span> | 275 | as we iterate through the matches or captures produced by running a |
276 | query on the parse tree. Observe:</p> | ||
277 | <div class="sourceCode" id="cb28"><pre | ||
278 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb28-1"><a href="#cb28-1" aria-hidden="true" tabindex="-1"></a><span class="kw">use</span> <span class="pp">tree_sitter::</span>QueryCursor<span class="op">;</span></span> | ||
214 | <span id="cb28-2"><a href="#cb28-2" aria-hidden="true" tabindex="-1"></a></span> | 279 | <span id="cb28-2"><a href="#cb28-2" aria-hidden="true" tabindex="-1"></a></span> |
215 | <span id="cb28-3"><a href="#cb28-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> <span class="kw">mut</span> query_cursor <span class="op">=</span> <span class="pp">QueryCursor::</span>new()<span class="op">;</span></span> | 280 | <span id="cb28-3"><a href="#cb28-3" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> <span class="kw">mut</span> query_cursor <span class="op">=</span> <span class="pp">QueryCursor::</span>new()<span class="op">;</span></span> |
216 | <span id="cb28-4"><a href="#cb28-4" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> all_matches <span class="op">=</span> query_cursor<span class="op">.</span>matches(</span> | 281 | <span id="cb28-4"><a href="#cb28-4" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> all_matches <span class="op">=</span> query_cursor<span class="op">.</span>matches(</span> |
@@ -218,15 +283,22 @@ | |||
218 | <span id="cb28-6"><a href="#cb28-6" aria-hidden="true" tabindex="-1"></a> parse_tree<span class="op">.</span>root_node()<span class="op">,</span></span> | 283 | <span id="cb28-6"><a href="#cb28-6" aria-hidden="true" tabindex="-1"></a> parse_tree<span class="op">.</span>root_node()<span class="op">,</span></span> |
219 | <span id="cb28-7"><a href="#cb28-7" aria-hidden="true" tabindex="-1"></a> src<span class="op">.</span>as_bytes()<span class="op">,</span></span> | 284 | <span id="cb28-7"><a href="#cb28-7" aria-hidden="true" tabindex="-1"></a> src<span class="op">.</span>as_bytes()<span class="op">,</span></span> |
220 | <span id="cb28-8"><a href="#cb28-8" aria-hidden="true" tabindex="-1"></a>)<span class="op">;</span></span></code></pre></div> | 285 | <span id="cb28-8"><a href="#cb28-8" aria-hidden="true" tabindex="-1"></a>)<span class="op">;</span></span></code></pre></div> |
221 | <p>We begin by passing our query to the cursor, followed by the “root node”, which is another way of saying, “start from the top”, and lastly, the source itself. If you have already taken a look at the C API, you will notice that the last argument, the source (known as the <code>TextProvider</code>), is not required. The Rust bindings seem to require this argument to provide predicate functionality such as <code>#match?</code> and <code>#eq?</code>.</p> | 286 | <p>We begin by passing our query to the cursor, followed by the “root |
287 | node”, which is another way of saying, “start from the top”, and lastly, | ||
288 | the source itself. If you have already taken a look at the C API, you | ||
289 | will notice that the last argument, the source (known as the | ||
290 | <code>TextProvider</code>), is not required. The Rust bindings seem to | ||
291 | require this argument to provide predicate functionality such as | ||
292 | <code>#match?</code> and <code>#eq?</code>.</p> | ||
222 | <p>Do something with the matches:</p> | 293 | <p>Do something with the matches:</p> |
223 | <div class="sourceCode" id="cb29"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb29-1"><a href="#cb29-1" aria-hidden="true" tabindex="-1"></a><span class="co">// get the index of the capture named "raise"</span></span> | 294 | <div class="sourceCode" id="cb29"><pre |
295 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb29-1"><a href="#cb29-1" aria-hidden="true" tabindex="-1"></a><span class="co">// get the index of the capture named "raise"</span></span> | ||
224 | <span id="cb29-2"><a href="#cb29-2" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> raise_idx <span class="op">=</span> query<span class="op">.</span>capture_index_for_name(<span class="st">"raise"</span>)<span class="op">.</span>unwrap()<span class="op">;</span></span> | 296 | <span id="cb29-2"><a href="#cb29-2" aria-hidden="true" tabindex="-1"></a><span class="kw">let</span> raise_idx <span class="op">=</span> query<span class="op">.</span>capture_index_for_name(<span class="st">"raise"</span>)<span class="op">.</span>unwrap()<span class="op">;</span></span> |
225 | <span id="cb29-3"><a href="#cb29-3" aria-hidden="true" tabindex="-1"></a></span> | 297 | <span id="cb29-3"><a href="#cb29-3" aria-hidden="true" tabindex="-1"></a></span> |
226 | <span id="cb29-4"><a href="#cb29-4" aria-hidden="true" tabindex="-1"></a><span class="kw">for</span> each_match <span class="kw">in</span> all_matches <span class="op">{</span></span> | 298 | <span id="cb29-4"><a href="#cb29-4" aria-hidden="true" tabindex="-1"></a><span class="cf">for</span> each_match <span class="kw">in</span> all_matches <span class="op">{</span></span> |
227 | <span id="cb29-5"><a href="#cb29-5" aria-hidden="true" tabindex="-1"></a> <span class="co">// iterate over all captures called "raise"</span></span> | 299 | <span id="cb29-5"><a href="#cb29-5" aria-hidden="true" tabindex="-1"></a> <span class="co">// iterate over all captures called "raise"</span></span> |
228 | <span id="cb29-6"><a href="#cb29-6" aria-hidden="true" tabindex="-1"></a> <span class="co">// ignore captures such as "fn-name"</span></span> | 300 | <span id="cb29-6"><a href="#cb29-6" aria-hidden="true" tabindex="-1"></a> <span class="co">// ignore captures such as "fn-name"</span></span> |
229 | <span id="cb29-7"><a href="#cb29-7" aria-hidden="true" tabindex="-1"></a> <span class="kw">for</span> capture <span class="kw">in</span> each_match</span> | 301 | <span id="cb29-7"><a href="#cb29-7" aria-hidden="true" tabindex="-1"></a> <span class="cf">for</span> capture <span class="kw">in</span> each_match</span> |
230 | <span id="cb29-8"><a href="#cb29-8" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>captures</span> | 302 | <span id="cb29-8"><a href="#cb29-8" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>captures</span> |
231 | <span id="cb29-9"><a href="#cb29-9" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>iter()</span> | 303 | <span id="cb29-9"><a href="#cb29-9" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>iter()</span> |
232 | <span id="cb29-10"><a href="#cb29-10" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>filter(<span class="op">|</span>c<span class="op">|</span> c<span class="op">.</span>idx <span class="op">==</span> raise_idx)</span> | 304 | <span id="cb29-10"><a href="#cb29-10" aria-hidden="true" tabindex="-1"></a> <span class="op">.</span>filter(<span class="op">|</span>c<span class="op">|</span> c<span class="op">.</span>idx <span class="op">==</span> raise_idx)</span> |
@@ -241,8 +313,10 @@ | |||
241 | <span id="cb29-19"><a href="#cb29-19" aria-hidden="true" tabindex="-1"></a> )<span class="op">;</span></span> | 313 | <span id="cb29-19"><a href="#cb29-19" aria-hidden="true" tabindex="-1"></a> )<span class="op">;</span></span> |
242 | <span id="cb29-20"><a href="#cb29-20" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span> | 314 | <span id="cb29-20"><a href="#cb29-20" aria-hidden="true" tabindex="-1"></a> <span class="op">}</span></span> |
243 | <span id="cb29-21"><a href="#cb29-21" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div> | 315 | <span id="cb29-21"><a href="#cb29-21" aria-hidden="true" tabindex="-1"></a><span class="op">}</span></span></code></pre></div> |
244 | <p>Lastly, add the following line to your source code, to get the linter to catch something:</p> | 316 | <p>Lastly, add the following line to your source code, to get the linter |
245 | <div class="sourceCode" id="cb30"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb30-1"><a href="#cb30-1" aria-hidden="true" tabindex="-1"></a><span class="pp">env::</span>remove_var(<span class="st">"RUST_BACKTRACE"</span>)<span class="op">;</span></span></code></pre></div> | 317 | to catch something:</p> |
318 | <div class="sourceCode" id="cb30"><pre | ||
319 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb30-1"><a href="#cb30-1" aria-hidden="true" tabindex="-1"></a><span class="pp">env::</span>remove_var(<span class="st">"RUST_BACKTRACE"</span>)<span class="op">;</span></span></code></pre></div> | ||
246 | <p>And <code>cargo run</code>:</p> | 320 | <p>And <code>cargo run</code>:</p> |
247 | <pre class="shell"><code>λ cargo run | 321 | <pre class="shell"><code>λ cargo run |
248 | Compiling toy-lint v0.1.0 (/redacted/path/to/toy-lint) | 322 | Compiling toy-lint v0.1.0 (/redacted/path/to/toy-lint) |
@@ -251,17 +325,33 @@ | |||
251 | [Line: 40, Col: 4] Offending source code: `env::remove_var("RUST_BACKTRACE")`</code></pre> | 325 | [Line: 40, Col: 4] Offending source code: `env::remove_var("RUST_BACKTRACE")`</code></pre> |
252 | <p>Thank you tree-sitter!</p> | 326 | <p>Thank you tree-sitter!</p> |
253 | <h3 id="bonus">Bonus</h3> | 327 | <h3 id="bonus">Bonus</h3> |
254 | <p>Keen readers will notice that I avoided <code>std::env::set_var</code>. Because <code>set_var</code> is called with two arguments, a “key” and a “value”, unlike <code>env::var</code> and <code>env::remove_var</code>. As a result, it requires more juggling:</p> | 328 | <p>Keen readers will notice that I avoided |
255 | <div class="sourceCode" id="cb32"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb32-1"><a href="#cb32-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span> | 329 | <code>std::env::set_var</code>. Because <code>set_var</code> is called |
330 | with two arguments, a “key” and a “value”, unlike <code>env::var</code> | ||
331 | and <code>env::remove_var</code>. As a result, it requires more | ||
332 | juggling:</p> | ||
333 | <div class="sourceCode" id="cb32"><pre | ||
334 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb32-1"><a href="#cb32-1" aria-hidden="true" tabindex="-1"></a>((call_expression</span> | ||
256 | <span id="cb32-2"><a href="#cb32-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name</span> | 335 | <span id="cb32-2"><a href="#cb32-2" aria-hidden="true" tabindex="-1"></a> function: (<span class="op">_</span>) @fn-name</span> |
257 | <span id="cb32-3"><a href="#cb32-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments <span class="op">.</span> (string_literal)<span class="op">?</span> <span class="op">.</span> (string_literal) <span class="op">.</span>)) @raise</span> | 336 | <span id="cb32-3"><a href="#cb32-3" aria-hidden="true" tabindex="-1"></a> arguments: (arguments <span class="op">.</span> (string_literal)<span class="op">?</span> <span class="op">.</span> (string_literal) <span class="op">.</span>)) @raise</span> |
258 | <span id="cb32-4"><a href="#cb32-4" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">"(std::|)env::(var|remove_var|set_var)"</span>))</span></code></pre></div> | 337 | <span id="cb32-4"><a href="#cb32-4" aria-hidden="true" tabindex="-1"></a> (#match? @fn-name <span class="st">"(std::|)env::(var|remove_var|set_var)"</span>))</span></code></pre></div> |
259 | <p>The interesting part of this query is the humble <code>.</code>, the <em>anchor</em> operator. Anchors help constrain child nodes in certain ways. In this case, it ensures that we match exactly two <code>string_literal</code>s who are siblings or exactly one <code>string_literal</code> with no siblings. Unfortunately, this query also matches the following invalid Rust code:</p> | 338 | <p>The interesting part of this query is the humble <code>.</code>, the |
260 | <div class="sourceCode" id="cb33"><pre class="sourceCode rust"><code class="sourceCode rust"><span id="cb33-1"><a href="#cb33-1" aria-hidden="true" tabindex="-1"></a><span class="co">// remove_var accepts only 1 arg!</span></span> | 339 | <em>anchor</em> operator. Anchors help constrain child nodes in certain |
340 | ways. In this case, it ensures that we match exactly two | ||
341 | <code>string_literal</code>s who are siblings or exactly one | ||
342 | <code>string_literal</code> with no siblings. Unfortunately, this query | ||
343 | also matches the following invalid Rust code:</p> | ||
344 | <div class="sourceCode" id="cb33"><pre | ||
345 | class="sourceCode rust"><code class="sourceCode rust"><span id="cb33-1"><a href="#cb33-1" aria-hidden="true" tabindex="-1"></a><span class="co">// remove_var accepts only 1 arg!</span></span> | ||
261 | <span id="cb33-2"><a href="#cb33-2" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(<span class="st">"RUST_BACKTRACE"</span><span class="op">,</span> <span class="st">"1"</span>)<span class="op">;</span></span></code></pre></div> | 346 | <span id="cb33-2"><a href="#cb33-2" aria-hidden="true" tabindex="-1"></a><span class="pp">std::env::</span>remove_var(<span class="st">"RUST_BACKTRACE"</span><span class="op">,</span> <span class="st">"1"</span>)<span class="op">;</span></span></code></pre></div> |
262 | <h3 id="notes">Notes</h3> | 347 | <h3 id="notes">Notes</h3> |
263 | <p>All-in-all, the query DSL does a great job in lowering the bar to writing language tools. The knowledge gained from mastering the query DSL can be applied to other languages that have tree-sitter grammars too. This query detects <code>to_json</code> methods that do not accept additional arguments, in Ruby:</p> | 348 | <p>All-in-all, the query DSL does a great job in lowering the bar to |
264 | <div class="sourceCode" id="cb34"><pre class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb34-1"><a href="#cb34-1" aria-hidden="true" tabindex="-1"></a>((method</span> | 349 | writing language tools. The knowledge gained from mastering the query |
350 | DSL can be applied to other languages that have tree-sitter grammars | ||
351 | too. This query detects <code>to_json</code> methods that do not accept | ||
352 | additional arguments, in Ruby:</p> | ||
353 | <div class="sourceCode" id="cb34"><pre | ||
354 | class="sourceCode scheme"><code class="sourceCode scheme"><span id="cb34-1"><a href="#cb34-1" aria-hidden="true" tabindex="-1"></a>((method</span> | ||
265 | <span id="cb34-2"><a href="#cb34-2" aria-hidden="true" tabindex="-1"></a> name: (identifier) @fn</span> | 355 | <span id="cb34-2"><a href="#cb34-2" aria-hidden="true" tabindex="-1"></a> name: (identifier) @fn</span> |
266 | <span id="cb34-3"><a href="#cb34-3" aria-hidden="true" tabindex="-1"></a> !parameters)</span> | 356 | <span id="cb34-3"><a href="#cb34-3" aria-hidden="true" tabindex="-1"></a> !parameters)</span> |
267 | <span id="cb34-4"><a href="#cb34-4" aria-hidden="true" tabindex="-1"></a> (<span class="sc">#i</span>s? @fn <span class="st">"to_json"</span>))</span></code></pre></div> | 357 | <span id="cb34-4"><a href="#cb34-4" aria-hidden="true" tabindex="-1"></a> (<span class="sc">#i</span>s? @fn <span class="st">"to_json"</span>))</span></code></pre></div> |