mirror of https://github.com/helix-editor/helix
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
300 lines
16 KiB
HTML
300 lines
16 KiB
HTML
2 years ago
|
<!DOCTYPE HTML>
|
||
|
|
<html lang="en" class="sidebar-visible no-js colibri">
|
||
|
|
<head>
|
||
|
|
<!-- Book generated using mdBook -->
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<title>Adding indent queries</title>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- Custom HTML head -->
|
||
|
|
|
||
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
||
|
|
<meta name="description" content="">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<meta name="theme-color" content="#ffffff" />
|
||
|
|
|
||
|
|
<link rel="icon" href="../favicon.svg">
|
||
|
|
<link rel="shortcut icon" href="../favicon.png">
|
||
|
|
<link rel="stylesheet" href="../css/variables.css">
|
||
|
|
<link rel="stylesheet" href="../css/general.css">
|
||
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
||
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
||
|
|
|
||
|
|
<!-- Fonts -->
|
||
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
||
|
|
<link rel="preconnect" href="https://fonts.gstatic.com">
|
||
|
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@200;400;500;700&display=swap" rel="stylesheet">
|
||
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
||
|
|
|
||
|
|
<!-- Highlight.js Stylesheets -->
|
||
|
|
<link rel="stylesheet" href="../highlight.css">
|
||
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
||
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
||
|
|
|
||
|
|
<!-- Custom theme stylesheets -->
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<!-- Provide site root to javascript -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var path_to_root = "../";
|
||
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "colibri" : "colibri";
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
try {
|
||
|
|
var theme = localStorage.getItem('mdbook-theme');
|
||
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
|
|
||
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
|
|
}
|
||
|
|
} catch (e) { }
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var theme;
|
||
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
html.classList.remove('no-js')
|
||
|
|
html.classList.remove('colibri')
|
||
|
|
html.classList.add(theme);
|
||
|
|
html.classList.add('js');
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var html = document.querySelector('html');
|
||
|
|
var sidebar = 'hidden';
|
||
|
|
if (document.body.clientWidth >= 1080) {
|
||
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
|
|
sidebar = sidebar || 'visible';
|
||
|
|
}
|
||
|
|
html.classList.remove('sidebar-visible');
|
||
|
|
html.classList.add("sidebar-" + sidebar);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
||
|
|
<div class="sidebar-scrollbox">
|
||
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="../title-page.html">Helix</a></li><li class="chapter-item expanded "><a href="../install.html"><strong aria-hidden="true">1.</strong> Installation</a></li><li class="chapter-item expanded "><a href="../usage.html"><strong aria-hidden="true">2.</strong> Usage</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../keymap.html"><strong aria-hidden="true">2.1.</strong> Keymap</a></li><li class="chapter-item expanded "><a href="../commands.html"><strong aria-hidden="true">2.2.</strong> Commands</a></li><li class="chapter-item expanded "><a href="../lang-support.html"><strong aria-hidden="true">2.3.</strong> Language support</a></li></ol></li><li class="chapter-item expanded "><a href="../from-vim.html"><strong aria-hidden="true">3.</strong> Migrating from Vim</a></li><li class="chapter-item expanded "><a href="../configuration.html"><strong aria-hidden="true">4.</strong> Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../themes.html"><strong aria-hidden="true">4.1.</strong> Themes</a></li><li class="chapter-item expanded "><a href="../remapping.html"><strong aria-hidden="true">4.2.</strong> Key remapping</a></li><li class="chapter-item expanded "><a href="../languages.html"><strong aria-hidden="true">4.3.</strong> Languages</a></li></ol></li><li class="chapter-item expanded "><a href="../guides/index.html"><strong aria-hidden="true">5.</strong> Guides</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../guides/adding_languages.html"><strong aria-hidden="true">5.1.</strong> Adding languages</a></li><li class="chapter-item expanded "><a href="../guides/textobject.html"><strong aria-hidden="true">5.2.</strong> Adding textobject queries</a></li><li class="chapter-item expanded "><a href="../guides/indent.html" class="active"><strong aria-hidden="true">5.3.</strong> Adding indent queries</a></li><li class="chapter-item expanded "><a href="../guides/injection.html"><strong aria-hidden="true">5.4.</strong> Adding injection queries</a></li></ol></li></ol>
|
||
|
|
</div>
|
||
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div id="page-wrapper" class="page-wrapper">
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<div id="menu-bar-hover-placeholder"></div>
|
||
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
||
|
|
<div class="left-buttons">
|
||
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
||
|
|
<i class="fa fa-bars"></i>
|
||
|
|
</button>
|
||
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
||
|
|
<i class="fa fa-paint-brush"></i>
|
||
|
|
</button>
|
||
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
||
|
|
<li role="none"><button role="menuitem" class="theme" id="colibri">Colibri (default)</button></li>
|
||
|
|
</ul>
|
||
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
||
|
|
<i class="fa fa-search"></i>
|
||
|
|
</button>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<h1 class="menu-title"></h1>
|
||
|
|
|
||
|
|
<div class="right-buttons">
|
||
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
|
|
<i id="print-button" class="fa fa-print"></i>
|
||
|
|
</a>
|
||
|
|
<a href="https://github.com/helix-editor/helix" title="Git repository" aria-label="Git repository">
|
||
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div id="search-wrapper" class="hidden">
|
||
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
||
|
|
<input type="search" name="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
||
|
|
</form>
|
||
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
||
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
||
|
|
<ul id="searchresults">
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
||
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<div id="content" class="content">
|
||
|
|
<main>
|
||
|
|
<h1 id="adding-indent-queries"><a class="header" href="#adding-indent-queries">Adding indent queries</a></h1>
|
||
|
|
<p>Helix uses tree-sitter to correctly indent new lines. This requires
|
||
|
|
a tree-sitter grammar and an <code>indent.scm</code> query file placed in
|
||
|
|
<code>runtime/queries/{language}/indents.scm</code>. The indentation for a line
|
||
|
|
is calculated by traversing the syntax tree from the lowest node at the
|
||
|
|
beginning of the new line. Each of these nodes contributes to the total
|
||
|
|
indent when it is captured by the query (in what way depends on the name
|
||
|
|
of the capture).</p>
|
||
|
|
<p>Note that it matters where these added indents begin. For example,
|
||
|
|
multiple indent level increases that start on the same line only increase
|
||
|
|
the total indent level by 1.</p>
|
||
|
|
<h2 id="scopes"><a class="header" href="#scopes">Scopes</a></h2>
|
||
|
|
<p>Added indents don't always apply to the whole node. For example, in most
|
||
|
|
cases when a node should be indented, we actually only want everything
|
||
|
|
except for its first line to be indented. For this, there are several
|
||
|
|
scopes (more scopes may be added in the future if required):</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p><code>all</code>:
|
||
|
|
This scope applies to the whole captured node. This is only different from
|
||
|
|
<code>tail</code> when the captured node is the first node on its line.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>tail</code>:
|
||
|
|
This scope applies to everything except for the first line of the
|
||
|
|
captured node.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p>Every capture type has a default scope which should do the right thing
|
||
|
|
in most situations. When a different scope is required, this can be
|
||
|
|
changed by using a <code>#set!</code> declaration anywhere in the pattern:</p>
|
||
|
|
<pre><code class="language-scm">(assignment_expression
|
||
|
|
right: (_) @indent
|
||
|
|
(#set! "scope" "all"))
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="capture-types"><a class="header" href="#capture-types">Capture types</a></h2>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p><code>@indent</code> (default scope <code>tail</code>):
|
||
|
|
Increase the indent level by 1. Multiple occurrences in the same line
|
||
|
|
don't stack. If there is at least one <code>@indent</code> and one <code>@outdent</code>
|
||
|
|
capture on the same line, the indent level isn't changed at all.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>@outdent</code> (default scope <code>all</code>):
|
||
|
|
Decrease the indent level by 1. The same rules as for <code>@indent</code> apply.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>@extend</code>:
|
||
|
|
Extend the range of this node to the end of the line and to lines that
|
||
|
|
are indented more than the line that this node starts on. This is useful
|
||
|
|
for languages like Python, where for the purpose of indentation some nodes
|
||
|
|
(like functions or classes) should also contain indented lines that follow them.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>@extend.prevent-once</code>:
|
||
|
|
Prevents the first extension of an ancestor of this node. For example, in Python
|
||
|
|
a return expression always ends the block that it is in. Note that this only stops the
|
||
|
|
extension of the next <code>@extend</code> capture. If multiple ancestors are captured,
|
||
|
|
only the extension of the innermost one is prevented. All other ancestors are unaffected
|
||
|
|
(regardless of whether the innermost ancestor would actually have been extended).</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h2 id="predicates"><a class="header" href="#predicates">Predicates</a></h2>
|
||
|
|
<p>In some cases, an S-expression cannot express exactly what pattern should be matched.
|
||
|
|
For that, tree-sitter allows for predicates to appear anywhere within a pattern,
|
||
|
|
similar to how <code>#set!</code> declarations work:</p>
|
||
|
|
<pre><code class="language-scm">(some_kind
|
||
|
|
(child_kind) @indent
|
||
|
|
(#predicate? arg1 arg2 ...)
|
||
|
|
)
|
||
|
|
</code></pre>
|
||
|
|
<p>The number of arguments depends on the predicate that's used.
|
||
|
|
Each argument is either a capture (<code>@name</code>) or a string (<code>"some string"</code>).
|
||
|
|
The following predicates are supported by tree-sitter:</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p><code>#eq?</code>/<code>#not-eq?</code>:
|
||
|
|
The first argument (a capture) must/must not be equal to the second argument
|
||
|
|
(a capture or a string).</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>#match?</code>/<code>#not-match?</code>:
|
||
|
|
The first argument (a capture) must/must not match the regex given in the
|
||
|
|
second argument (a string).</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
<p>Additionally, we support some custom predicates for indent queries:</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p><code>#not-kind-eq?</code>:
|
||
|
|
The kind of the first argument (a capture) must not be equal to the second
|
||
|
|
argument (a string).</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>#same-line?</code>/<code>#not-same-line?</code>:
|
||
|
|
The captures given by the 2 arguments must/must not start on the same line.</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</main>
|
||
|
|
|
||
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
|
|
<!-- Mobile navigation buttons -->
|
||
|
|
<a rel="prev" href="../guides/textobject.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next" href="../guides/injection.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<div style="clear: both"></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
|
|
<a rel="prev" href="../guides/textobject.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
|
|
<i class="fa fa-angle-left"></i>
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<a rel="next" href="../guides/injection.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
|
|
<i class="fa fa-angle-right"></i>
|
||
|
|
</a>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
window.playground_copyable = true;
|
||
|
|
</script>
|
||
|
|
|
||
|
|
|
||
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
||
|
|
|
||
|
|
<!-- Custom JS scripts -->
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|