diff options
Diffstat (limited to 'master/guides')
| -rw-r--r-- | master/guides/adding_languages.html | 289 | ||||
| -rw-r--r-- | master/guides/indent.html | 563 | ||||
| -rw-r--r-- | master/guides/index.html | 236 | ||||
| -rw-r--r-- | master/guides/injection.html | 302 | ||||
| -rw-r--r-- | master/guides/rainbow_bracket_queries.html | 323 | ||||
| -rw-r--r-- | master/guides/textobject.html | 270 |
6 files changed, 0 insertions, 1983 deletions
diff --git a/master/guides/adding_languages.html b/master/guides/adding_languages.html deleted file mode 100644 index 13781aba..00000000 --- a/master/guides/adding_languages.html +++ /dev/null @@ -1,289 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="colibri" dir="ltr"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>Adding languages</title> - - - <!-- Custom HTML head --> - - <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="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 --> - <link rel="stylesheet" href="../custom.css"> - - </head> - <body class="sidebar-visible no-js"> - <div id="body-container"> - <!-- Provide site root to javascript --> - <script> - 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> - 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> - 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('colibri') - html.classList.add(theme); - var body = document.querySelector('body'); - body.classList.remove('no-js') - body.classList.add('js'); - </script> - - <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> - - <!-- Hide / unhide sidebar before it is displayed --> - <script> - var body = document.querySelector('body'); - var sidebar = null; - var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); - if (document.body.clientWidth >= 1080) { - try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } - sidebar = sidebar || 'visible'; - } else { - sidebar = 'hidden'; - } - sidebar_toggle.checked = sidebar === 'visible'; - body.classList.remove('sidebar-visible'); - body.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" class="active"><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"><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><li class="chapter-item expanded "><a href="../guides/rainbow_bracket_queries.html"><strong aria-hidden="true">5.5.</strong> Adding rainbow bracket queries</a></li></ol></li></ol> - </div> - <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> - </nav> - - <!-- Track and set sidebar scroll position --> - <script> - var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); - sidebarScrollbox.addEventListener('click', function(e) { - if (e.target.tagName === 'A') { - sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); - } - }, { passive: true }); - var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); - sessionStorage.removeItem('sidebar-scroll'); - if (sidebarScrollTop) { - // preserve sidebar scroll position when navigating via links within sidebar - sidebarScrollbox.scrollTop = sidebarScrollTop; - } else { - // scroll sidebar to current active section when navigating via "next/previous chapter" buttons - var activeSection = document.querySelector('#sidebar .active'); - if (activeSection) { - activeSection.scrollIntoView({ block: 'center' }); - } - } - </script> - - <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"> - <div class="left-buttons"> - <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> - <i class="fa fa-bars"></i> - </label> - <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</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> - <a href="https://github.com/helix-editor/helix/edit/master/book/src/guides/adding_languages.md" title="Suggest an edit" aria-label="Suggest an edit"> - <i id="git-edit-button" class="fa fa-edit"></i> - </a> - - </div> - </div> - - <div id="search-wrapper" class="hidden"> - <form id="searchbar-outer" class="searchbar-outer"> - <input type="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> - 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-new-languages-to-helix"><a class="header" href="#adding-new-languages-to-helix">Adding new languages to Helix</a></h1> -<p>In order to add a new language to Helix, you will need to follow the steps -below.</p> -<h2 id="language-configuration"><a class="header" href="#language-configuration">Language configuration</a></h2> -<ol> -<li>Add a new <code>[[language]]</code> entry in the <code>languages.toml</code> file and provide the -necessary configuration for the new language. For more information on -language configuration, refer to the -<a href="../languages.html">language configuration section</a> of the documentation. -A new language server can be added by extending the <code>[language-server]</code> table in the same file.</li> -<li>If you are adding a new language or updating an existing language server -configuration, run the command <code>cargo xtask docgen</code> to update the -<a href="../lang-support.html">Language Support</a> documentation.</li> -</ol> -<blockquote> -<p>๐ก If you are adding a new Language Server configuration, make sure to update -the -<a href="https://github.com/helix-editor/helix/wiki/How-to-install-the-default-language-servers">Language Server Wiki</a> -with the installation instructions.</p> -</blockquote> -<h2 id="grammar-configuration"><a class="header" href="#grammar-configuration">Grammar configuration</a></h2> -<ol> -<li>If a tree-sitter grammar is available for the new language, add a new -<code>[[grammar]]</code> entry to the <code>languages.toml</code> file.</li> -<li>If you are testing the grammar locally, you can use the <code>source.path</code> key -with an absolute path to the grammar. However, before submitting a pull -request, make sure to switch to using <code>source.git</code>.</li> -</ol> -<h2 id="queries"><a class="header" href="#queries">Queries</a></h2> -<ol> -<li>In order to provide syntax highlighting and indentation for the new language, -you will need to add queries.</li> -<li>Create a new directory for the language with the path -<code>runtime/queries/<name>/</code>.</li> -<li>Refer to the -<a href="https://tree-sitter.github.io/tree-sitter/syntax-highlighting#queries">tree-sitter website</a> -for more information on writing queries.</li> -<li>A list of highlight captures can be found <a href="https://docs.helix-editor.com/themes.html#scopes">on the themes page</a>.</li> -</ol> -<blockquote> -<p>๐ก In Helix, the first matching query takes precedence when evaluating -queries, which is different from other editors such as Neovim where the last -matching query supersedes the ones before it. See -<a href="https://github.com/helix-editor/helix/pull/1170#issuecomment-997294090">this issue</a> -for an example.</p> -</blockquote> -<h2 id="common-issues"><a class="header" href="#common-issues">Common issues</a></h2> -<ul> -<li>If you encounter errors when running Helix after switching branches, you may -need to update the tree-sitter grammars. Run the command <code>hx --grammar fetch</code> -to fetch the grammars and <code>hx --grammar build</code> to build any out-of-date -grammars.</li> -<li>If a parser is causing a segfault, or you want to remove it, make sure to -remove the compiled parser located at <code>runtime/grammars/<name>.so</code>.</li> -<li>If you are attempting to add queries and Helix is unable to locate them, ensure that the environment variable <code>HELIX_RUNTIME</code> is set to the location of the <code>runtime</code> folder you're developing in.</li> -</ul> - - </main> - - <nav class="nav-wrapper" aria-label="Page navigation"> - <!-- Mobile navigation buttons --> - <a rel="prev" href="../guides/index.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 prefetch" href="../guides/textobject.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/index.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 prefetch" href="../guides/textobject.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> - window.playground_copyable = true; - </script> - - - <script src="../elasticlunr.min.js"></script> - <script src="../mark.min.js"></script> - <script src="../searcher.js"></script> - - <script src="../clipboard.min.js"></script> - <script src="../highlight.js"></script> - <script src="../book.js"></script> - - <!-- Custom JS scripts --> - - - </div> - </body> -</html> diff --git a/master/guides/indent.html b/master/guides/indent.html deleted file mode 100644 index 25be199a..00000000 --- a/master/guides/indent.html +++ /dev/null @@ -1,563 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="colibri" dir="ltr"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>Adding indent queries</title> - - - <!-- Custom HTML head --> - - <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="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 --> - <link rel="stylesheet" href="../custom.css"> - - </head> - <body class="sidebar-visible no-js"> - <div id="body-container"> - <!-- Provide site root to javascript --> - <script> - 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> - 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> - 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('colibri') - html.classList.add(theme); - var body = document.querySelector('body'); - body.classList.remove('no-js') - body.classList.add('js'); - </script> - - <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> - - <!-- Hide / unhide sidebar before it is displayed --> - <script> - var body = document.querySelector('body'); - var sidebar = null; - var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); - if (document.body.clientWidth >= 1080) { - try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } - sidebar = sidebar || 'visible'; - } else { - sidebar = 'hidden'; - } - sidebar_toggle.checked = sidebar === 'visible'; - body.classList.remove('sidebar-visible'); - body.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><li class="chapter-item expanded "><a href="../guides/rainbow_bracket_queries.html"><strong aria-hidden="true">5.5.</strong> Adding rainbow bracket queries</a></li></ol></li></ol> - </div> - <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> - </nav> - - <!-- Track and set sidebar scroll position --> - <script> - var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); - sidebarScrollbox.addEventListener('click', function(e) { - if (e.target.tagName === 'A') { - sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); - } - }, { passive: true }); - var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); - sessionStorage.removeItem('sidebar-scroll'); - if (sidebarScrollTop) { - // preserve sidebar scroll position when navigating via links within sidebar - sidebarScrollbox.scrollTop = sidebarScrollTop; - } else { - // scroll sidebar to current active section when navigating via "next/previous chapter" buttons - var activeSection = document.querySelector('#sidebar .active'); - if (activeSection) { - activeSection.scrollIntoView({ block: 'center' }); - } - } - </script> - - <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"> - <div class="left-buttons"> - <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> - <i class="fa fa-bars"></i> - </label> - <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</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> - <a href="https://github.com/helix-editor/helix/edit/master/book/src/guides/indent.md" title="Suggest an edit" aria-label="Suggest an edit"> - <i id="git-edit-button" class="fa fa-edit"></i> - </a> - - </div> - </div> - - <div id="search-wrapper" class="hidden"> - <form id="searchbar-outer" class="searchbar-outer"> - <input type="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> - 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 (see -<a href="#indent-queries">Indent queries</a>). 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. See <a href="#capture-types">Capture types</a>.</p> -<p>By default, Helix uses the <code>hybrid</code> indentation heuristic. This means that -indent queries are not used to compute the expected absolute indentation of a -line but rather the expected difference in indentation between the new and an -already existing line. This difference is then added to the actual indentation -of the already existing line. Since this makes errors in the indent queries -harder to find, it is recommended to disable it when testing via -<code>:set indent-heuristic tree-sitter</code>. The rest of this guide assumes that -the <code>tree-sitter</code> heuristic is used.</p> -<h2 id="indent-queries"><a class="header" href="#indent-queries">Indent queries</a></h2> -<p>When Helix is inserting a new line through <code>o</code>, <code>O</code>, or <code><ret></code>, to determine -the indent level for the new line, the query in <code>indents.scm</code> is run on the -document. The starting position of the query is the end of the line above where -a new line will be inserted.</p> -<p>For <code>o</code>, the inserted line is the line below the cursor, so that starting -position of the query is the end of the current line.</p> -<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)] -</span><span class="boring">fn main() { -</span>fn need_hero(some_hero: Hero, life: Life) -> { - matches!(some_hero, Hero { // โโโโโโโโโโโโโโโโโโโฎ - strong: true,//โโฎ โ โ โ - fast: true, // โ โ โฐโโ query start โ - sure: true, // โ โฐโโโโโ cursor โโ traversal - soon: true, // โฐโโโโโโโโ new line inserted โ start node - }) && // โ -// โ โ -// โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ - some_hero > life -} -<span class="boring">}</span></code></pre></pre> -<p>For <code>O</code>, the newly inserted line is the <em>current</em> line, so the starting position -of the query is the end of the line above the cursor.</p> -<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)] -</span><span class="boring">fn main() { -</span>fn need_hero(some_hero: Hero, life: Life) -> { // โโโฎ - matches!(some_hero, Hero { // โโฎ โ โ - strong: true,// โ โญโโโโฏ โ โ - fast: true, // โ โ query start โโฏ โ - sure: true, // โฐโโโโผ cursor โโ traversal - soon: true, // โฐ new line inserted โ start node - }) && // โ - some_hero > life // โ -} // โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ -<span class="boring">}</span></code></pre></pre> -<p>From this starting node, the syntax tree is traversed up until the root node. -Each indent capture is collected along the way, and then combined according to -their <a href="#capture-types">capture types</a> and <a href="#scopes">scopes</a> to a final indent -level for the line.</p> -<h3 id="capture-types"><a class="header" href="#capture-types">Capture types</a></h3> -<ul> -<li><code>@indent</code> (default scope <code>tail</code>): -Increase the indent level by 1. Multiple occurrences in the same line <em>do not</em> -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.</li> -<li><code>@outdent</code> (default scope <code>all</code>): -Decrease the indent level by 1. The same rules as for <code>@indent</code> apply.</li> -<li><code>@indent.always</code> (default scope <code>tail</code>): -Increase the indent level by 1. Multiple occurrences on the same line <em>do</em> -stack. The final indent level is <code>@indent.always</code> โ <code>@outdent.always</code>. If -an <code>@indent</code> and an <code>@indent.always</code> are on the same line, the <code>@indent</code> is -ignored.</li> -<li><code>@outdent.always</code> (default scope <code>all</code>): -Decrease the indent level by 1. The same rules as for <code>@indent.always</code> apply.</li> -<li><code>@align</code> (default scope <code>all</code>): -Align everything inside this node to some anchor. The anchor is given -by the start of the node captured by <code>@anchor</code> in the same pattern. -Every pattern with an <code>@align</code> should contain exactly one <code>@anchor</code>. -Indent (and outdent) for nodes below (in terms of their starting line) -the <code>@align</code> node is added to the indentation required for alignment.</li> -<li><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.</li> -<li><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).</li> -</ul> -<h4 id="indent--outdent"><a class="header" href="#indent--outdent"><code>@indent</code> / <code>@outdent</code></a></h4> -<p>Consider this example:</p> -<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)] -</span><span class="boring">fn main() { -</span>fn shout(things: Vec<Thing>) { - // โ - // โโโโโโโโโโโโโโโโโโโโโโโโโฎ indent level - // @indent โโโโโโโโโโโโโโโ - // โ - let it_all = |out| { things.filter(|thing| { // โ 1 - // โ โ โ - // โโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโผโโโโโโโโโโโโโโ - // @indent @indent โ - // โ 2 - thing.can_do_with(out) // โ - })}; // โโโโโโโโโโโโโโโ - //โโโ โ 1 -} //โฐโผโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโ -// 3x @outdent -<span class="boring">}</span></code></pre></pre> -<pre><code class="language-scm">((block) @indent) -["}" ")"] @outdent -</code></pre> -<p>Note how on the second line, we have two blocks begin on the same line. In this -case, since both captures occur on the same line, they are combined and only -result in a net increase of 1. Also note that the closing <code>}</code>s are part of the -<code>@indent</code> captures, but the 3 <code>@outdent</code>s also combine into 1 and result in that -line losing one indent level.</p> -<h4 id="extend--extendprevent-once"><a class="header" href="#extend--extendprevent-once"><code>@extend</code> / <code>@extend.prevent-once</code></a></h4> -<p>For an example of where <code>@extend</code> can be useful, consider Python, which is -whitespace-sensitive.</p> -<pre><code class="language-scm">] - (parenthesized_expression) - (function_definition) - (class_definition) -] @indent - -</code></pre> -<pre><code class="language-python">class Hero: - def __init__(self, strong, fast, sure, soon):# โโโฎ - self.is_strong = strong # โ - self.is_fast = fast # โญโโโ query start โ - self.is_sure = sure # โ โญโ cursor โ - self.is_soon = soon # โ โ โ - # โ โ โ โ โ - # โ โฐโโโโโโโฏ โ โ - # โฐโโโโโโโโโโโโโโโโโโโโโโฏ โ - # โโ traversal - def need_hero(self, life): # โ start node - return ( # โ - self.is_strong # โ - and self.is_fast # โ - and self.is_sure # โ - and self.is_soon # โ - and self > life # โ - ) # โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ -</code></pre> -<p>Without braces to catch the scope of the function, the smallest descendant of -the cursor on a line feed ends up being the entire inside of the class. Because -of this, it will miss the entire function node and its indent capture, leading -to an indent level one too small.</p> -<p>To address this case, <code>@extend</code> tells helix to "extend" the captured node's span -to the line feed and every consecutive line that has a greater indent level than -the line of the node.</p> -<pre><code class="language-scm">(parenthesized_expression) @indent - -] - (function_definition) - (class_definition) -] @indent @extend - -</code></pre> -<pre><code class="language-python">class Hero: - def __init__(self, strong, fast, sure, soon):# โโโฎ - self.is_strong = strong # โ - self.is_fast = fast # โญโโโ query start โโ traversal - self.is_sure = sure # โ โญโ cursor โ start node - self.is_soon = soon # โ โ โโโโโโโโโโโโโโโโโฏ - # โ โ โ โ - # โ โฐโโโโโโโฏ โ - # โฐโโโโโโโโโโโโโโโโโโโโโโฏ - def need_hero(self, life): - return ( - self.is_strong - and self.is_fast - and self.is_sure - and self.is_soon - and self > life - ) -</code></pre> -<p>Furthermore, there are some cases where extending to everything with a greater -indent level may not be desirable. Consider the <code>need_hero</code> function above. If -our cursor is on the last line of the returned expression.</p> -<pre><code class="language-python">class Hero: - def __init__(self, strong, fast, sure, soon): - self.is_strong = strong - self.is_fast = fast - self.is_sure = sure - self.is_soon = soon - - def need_hero(self, life): - return ( - self.is_strong - and self.is_fast - and self.is_sure - and self.is_soon - and self > life - ) # โโโโ cursor - #โโโโโโโโโโโ where cursor should go on new line -</code></pre> -<p>In Python, the are a few tokens that will always end a scope, such as a return -statement. Since the scope ends, so should the indent level. But because the -function span is extended to every line with a greater indent level, a new line -would just continue on the same level. And an <code>@outdent</code> would not help us here -either, since it would cause everything in the parentheses to become outdented -as well.</p> -<p>To help, we need to signal an end to the extension. We can do this with -<code>@extend.prevent-once</code>.</p> -<pre><code class="language-scm">(parenthesized_expression) @indent - -] - (function_definition) - (class_definition) -] @indent @extend - -(return_statement) @extend.prevent-once -</code></pre> -<h4 id="indentalways--outdentalways"><a class="header" href="#indentalways--outdentalways"><code>@indent.always</code> / <code>@outdent.always</code></a></h4> -<p>As mentioned before, normally if there is more than one <code>@indent</code> or <code>@outdent</code> -capture on the same line, they are combined.</p> -<p>Sometimes, there are cases when you may want to ensure that every indent capture -is additive, regardless of how many occur on the same line. Consider this -example in YAML.</p> -<pre><code class="language-yaml"> - foo: bar -# โ โ -# โ โฐโโโโโโโโโโโโโโโ start of map -# โฐโโโโโโโโโโโโโโโโโ start of list element - baz: quux # โโโโ cursor - # โโโโโโโโโโโโโโ where the cursor should go on a new line - garply: waldo - - quux: - bar: baz - xyzzy: thud - fred: plugh -</code></pre> -<p>In YAML, you often have lists of maps. In these cases, the syntax is such that -the list element and the map both start on the same line. But we really do want -to start an indentation for each of these so that subsequent keys in the map -hang over the list and align properly. This is where <code>@indent.always</code> helps.</p> -<pre><code class="language-scm">((block_sequence_item) @item @indent.always @extend - (#not-one-line? @item)) - -((block_mapping_pair - key: (_) @key - value: (_) @val - (#not-same-line? @key @val) - ) @indent.always @extend -) -</code></pre> -<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> -<li> -<p><code>#any-of?</code>/<code>#not-any-of?</code>: -The first argument (a capture) must/must not be one of the other arguments -(strings).</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> -<li> -<p><code>#one-line?</code>/<code>#not-one-line?</code>: -The captures given by the fist argument must/must span a total of one line.</p> -</li> -</ul> -<h3 id="scopes"><a class="header" href="#scopes">Scopes</a></h3> -<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><code>tail</code>: -This scope applies to everything except for the first line of the -captured node.</li> -<li><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.</li> -</ul> -<p>For example, imagine we have the following function</p> -<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)] -</span><span class="boring">fn main() { -</span>fn aha() { // โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ - let take = "on me"; // โโโโโโโโโโโโโโโโฎ scope: โ - let take = "me on"; // โโ "tail" โโ (block) @indent - let ill = be_gone_days(1 || 2); // โ โ -} // โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโดโ "}" @outdent - // scope: "all" -<span class="boring">}</span></code></pre></pre> -<p>We can write the following query with the <code>#set!</code> declaration:</p> -<pre><code class="language-scm">((block) @indent - (#set! "scope" "tail")) -("}" @outdent - (#set! "scope" "all")) -</code></pre> -<p>As we can see, the "tail" scope covers the node, except for the first line. -Everything up to and including the closing brace gets an indent level of 1. -Then, on the closing brace, we encounter an outdent with a scope of "all", which -means the first line is included, and the indent level is cancelled out on this -line. (Note these scopes are the defaults for <code>@indent</code> and <code>@outdent</code>โthey are -written explicitly for demonstration.)</p> - - </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 prefetch" 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 prefetch" 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> - window.playground_copyable = true; - </script> - - - <script src="../elasticlunr.min.js"></script> - <script src="../mark.min.js"></script> - <script src="../searcher.js"></script> - - <script src="../clipboard.min.js"></script> - <script src="../highlight.js"></script> - <script src="../book.js"></script> - - <!-- Custom JS scripts --> - - - </div> - </body> -</html> diff --git a/master/guides/index.html b/master/guides/index.html deleted file mode 100644 index 0941314e..00000000 --- a/master/guides/index.html +++ /dev/null @@ -1,236 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="colibri" dir="ltr"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>Guides</title> - - - <!-- Custom HTML head --> - - <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="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 --> - <link rel="stylesheet" href="../custom.css"> - - </head> - <body class="sidebar-visible no-js"> - <div id="body-container"> - <!-- Provide site root to javascript --> - <script> - 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> - 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> - 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('colibri') - html.classList.add(theme); - var body = document.querySelector('body'); - body.classList.remove('no-js') - body.classList.add('js'); - </script> - - <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> - - <!-- Hide / unhide sidebar before it is displayed --> - <script> - var body = document.querySelector('body'); - var sidebar = null; - var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); - if (document.body.clientWidth >= 1080) { - try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } - sidebar = sidebar || 'visible'; - } else { - sidebar = 'hidden'; - } - sidebar_toggle.checked = sidebar === 'visible'; - body.classList.remove('sidebar-visible'); - body.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" class="active"><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"><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><li class="chapter-item expanded "><a href="../guides/rainbow_bracket_queries.html"><strong aria-hidden="true">5.5.</strong> Adding rainbow bracket queries</a></li></ol></li></ol> - </div> - <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> - </nav> - - <!-- Track and set sidebar scroll position --> - <script> - var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); - sidebarScrollbox.addEventListener('click', function(e) { - if (e.target.tagName === 'A') { - sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); - } - }, { passive: true }); - var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); - sessionStorage.removeItem('sidebar-scroll'); - if (sidebarScrollTop) { - // preserve sidebar scroll position when navigating via links within sidebar - sidebarScrollbox.scrollTop = sidebarScrollTop; - } else { - // scroll sidebar to current active section when navigating via "next/previous chapter" buttons - var activeSection = document.querySelector('#sidebar .active'); - if (activeSection) { - activeSection.scrollIntoView({ block: 'center' }); - } - } - </script> - - <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"> - <div class="left-buttons"> - <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> - <i class="fa fa-bars"></i> - </label> - <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</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> - <a href="https://github.com/helix-editor/helix/edit/master/book/src/guides/README.md" title="Suggest an edit" aria-label="Suggest an edit"> - <i id="git-edit-button" class="fa fa-edit"></i> - </a> - - </div> - </div> - - <div id="search-wrapper" class="hidden"> - <form id="searchbar-outer" class="searchbar-outer"> - <input type="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> - 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="guides"><a class="header" href="#guides">Guides</a></h1> -<p>This section contains guides for adding new language server configurations, -tree-sitter grammars, textobject and rainbow bracket queries, and other similar items.</p> - - </main> - - <nav class="nav-wrapper" aria-label="Page navigation"> - <!-- Mobile navigation buttons --> - <a rel="prev" href="../languages.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 prefetch" href="../guides/adding_languages.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="../languages.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 prefetch" href="../guides/adding_languages.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> - window.playground_copyable = true; - </script> - - - <script src="../elasticlunr.min.js"></script> - <script src="../mark.min.js"></script> - <script src="../searcher.js"></script> - - <script src="../clipboard.min.js"></script> - <script src="../highlight.js"></script> - <script src="../book.js"></script> - - <!-- Custom JS scripts --> - - - </div> - </body> -</html> diff --git a/master/guides/injection.html b/master/guides/injection.html deleted file mode 100644 index f4fe238b..00000000 --- a/master/guides/injection.html +++ /dev/null @@ -1,302 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="colibri" dir="ltr"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>Adding injection queries</title> - - - <!-- Custom HTML head --> - - <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="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 --> - <link rel="stylesheet" href="../custom.css"> - - </head> - <body class="sidebar-visible no-js"> - <div id="body-container"> - <!-- Provide site root to javascript --> - <script> - 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> - 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> - 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('colibri') - html.classList.add(theme); - var body = document.querySelector('body'); - body.classList.remove('no-js') - body.classList.add('js'); - </script> - - <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> - - <!-- Hide / unhide sidebar before it is displayed --> - <script> - var body = document.querySelector('body'); - var sidebar = null; - var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); - if (document.body.clientWidth >= 1080) { - try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } - sidebar = sidebar || 'visible'; - } else { - sidebar = 'hidden'; - } - sidebar_toggle.checked = sidebar === 'visible'; - body.classList.remove('sidebar-visible'); - body.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"><strong aria-hidden="true">5.3.</strong> Adding indent queries</a></li><li class="chapter-item expanded "><a href="../guides/injection.html" class="active"><strong aria-hidden="true">5.4.</strong> Adding injection queries</a></li><li class="chapter-item expanded "><a href="../guides/rainbow_bracket_queries.html"><strong aria-hidden="true">5.5.</strong> Adding rainbow bracket queries</a></li></ol></li></ol> - </div> - <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> - </nav> - - <!-- Track and set sidebar scroll position --> - <script> - var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); - sidebarScrollbox.addEventListener('click', function(e) { - if (e.target.tagName === 'A') { - sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); - } - }, { passive: true }); - var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); - sessionStorage.removeItem('sidebar-scroll'); - if (sidebarScrollTop) { - // preserve sidebar scroll position when navigating via links within sidebar - sidebarScrollbox.scrollTop = sidebarScrollTop; - } else { - // scroll sidebar to current active section when navigating via "next/previous chapter" buttons - var activeSection = document.querySelector('#sidebar .active'); - if (activeSection) { - activeSection.scrollIntoView({ block: 'center' }); - } - } - </script> - - <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"> - <div class="left-buttons"> - <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> - <i class="fa fa-bars"></i> - </label> - <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</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> - <a href="https://github.com/helix-editor/helix/edit/master/book/src/guides/injection.md" title="Suggest an edit" aria-label="Suggest an edit"> - <i id="git-edit-button" class="fa fa-edit"></i> - </a> - - </div> - </div> - - <div id="search-wrapper" class="hidden"> - <form id="searchbar-outer" class="searchbar-outer"> - <input type="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> - 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-injection-queries"><a class="header" href="#adding-injection-queries">Adding Injection Queries</a></h1> -<p>Writing language injection queries allows one to highlight a specific node as a different language. -In addition to the <a href="http://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection">standard</a> language injection options used by tree-sitter, there -are a few Helix specific extensions that allow for more control.</p> -<p>And example of a simple query that would highlight all strings as bash in Nix:</p> -<pre><code class="language-scm">((string_expression (string_fragment) @injection.content) - (#set! injection.language "bash")) -</code></pre> -<h2 id="capture-types"><a class="header" href="#capture-types">Capture Types</a></h2> -<ul> -<li> -<p><code>@injection.language</code> (standard): -The captured node may contain the language name used to highlight the node captured by -<code>@injection.content</code>.</p> -</li> -<li> -<p><code>@injection.content</code> (standard): -Marks the content to be highlighted as the language captured with <code>@injection.language</code> <em>et al</em>.</p> -</li> -<li> -<p><code>@injection.filename</code> (extension): -The captured node may contain a filename with a file-extension known to Helix, -highlighting <code>@injection.content</code> as that language. This uses the language extensions defined in -both the default languages.toml distributed with Helix, as well as user defined languages.</p> -</li> -<li> -<p><code>@injection.shebang</code> (extension): -The captured node may contain a shebang used to choose a language to highlight as. This also uses -the shebangs defined in the default and user <code>languages.toml</code>.</p> -</li> -</ul> -<h2 id="settings"><a class="header" href="#settings">Settings</a></h2> -<ul> -<li> -<p><code>injection.combined</code> (standard): -Indicates that all the matching nodes in the tree should have their content parsed as one -nested document.</p> -</li> -<li> -<p><code>injection.language</code> (standard): -Forces the captured content to be highlighted as the given language</p> -</li> -<li> -<p><code>injection.include-children</code> (standard): -Indicates that the content nodeโs entire text should be re-parsed, including the text of its child -nodes. By default, child nodesโ text will be excluded from the injected document.</p> -</li> -<li> -<p><code>injection.include-unnamed-children</code> (extension): -Same as <code>injection.include-children</code> but only for unnamed child nodes.</p> -</li> -</ul> -<h2 id="predicates"><a class="header" href="#predicates">Predicates</a></h2> -<ul> -<li> -<p><code>#eq?</code> (standard): -The first argument (a capture) must be equal to the second argument -(a capture or a string).</p> -</li> -<li> -<p><code>#match?</code> (standard): -The first argument (a capture) must match the regex given in the -second argument (a string).</p> -</li> -<li> -<p><code>#any-of?</code> (standard): -The first argument (a capture) must be one of the other arguments (strings).</p> -</li> -</ul> - - </main> - - <nav class="nav-wrapper" aria-label="Page navigation"> - <!-- Mobile navigation buttons --> - <a rel="prev" href="../guides/indent.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 prefetch" href="../guides/rainbow_bracket_queries.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/indent.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 prefetch" href="../guides/rainbow_bracket_queries.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> - window.playground_copyable = true; - </script> - - - <script src="../elasticlunr.min.js"></script> - <script src="../mark.min.js"></script> - <script src="../searcher.js"></script> - - <script src="../clipboard.min.js"></script> - <script src="../highlight.js"></script> - <script src="../book.js"></script> - - <!-- Custom JS scripts --> - - - </div> - </body> -</html> diff --git a/master/guides/rainbow_bracket_queries.html b/master/guides/rainbow_bracket_queries.html deleted file mode 100644 index c64d737c..00000000 --- a/master/guides/rainbow_bracket_queries.html +++ /dev/null @@ -1,323 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="colibri" dir="ltr"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>Adding rainbow bracket queries</title> - - - <!-- Custom HTML head --> - - <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="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 --> - <link rel="stylesheet" href="../custom.css"> - - </head> - <body class="sidebar-visible no-js"> - <div id="body-container"> - <!-- Provide site root to javascript --> - <script> - 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> - 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> - 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('colibri') - html.classList.add(theme); - var body = document.querySelector('body'); - body.classList.remove('no-js') - body.classList.add('js'); - </script> - - <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> - - <!-- Hide / unhide sidebar before it is displayed --> - <script> - var body = document.querySelector('body'); - var sidebar = null; - var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); - if (document.body.clientWidth >= 1080) { - try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } - sidebar = sidebar || 'visible'; - } else { - sidebar = 'hidden'; - } - sidebar_toggle.checked = sidebar === 'visible'; - body.classList.remove('sidebar-visible'); - body.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"><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><li class="chapter-item expanded "><a href="../guides/rainbow_bracket_queries.html" class="active"><strong aria-hidden="true">5.5.</strong> Adding rainbow bracket queries</a></li></ol></li></ol> - </div> - <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> - </nav> - - <!-- Track and set sidebar scroll position --> - <script> - var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); - sidebarScrollbox.addEventListener('click', function(e) { - if (e.target.tagName === 'A') { - sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); - } - }, { passive: true }); - var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); - sessionStorage.removeItem('sidebar-scroll'); - if (sidebarScrollTop) { - // preserve sidebar scroll position when navigating via links within sidebar - sidebarScrollbox.scrollTop = sidebarScrollTop; - } else { - // scroll sidebar to current active section when navigating via "next/previous chapter" buttons - var activeSection = document.querySelector('#sidebar .active'); - if (activeSection) { - activeSection.scrollIntoView({ block: 'center' }); - } - } - </script> - - <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"> - <div class="left-buttons"> - <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> - <i class="fa fa-bars"></i> - </label> - <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</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> - <a href="https://github.com/helix-editor/helix/edit/master/book/src/guides/rainbow_bracket_queries.md" title="Suggest an edit" aria-label="Suggest an edit"> - <i id="git-edit-button" class="fa fa-edit"></i> - </a> - - </div> - </div> - - <div id="search-wrapper" class="hidden"> - <form id="searchbar-outer" class="searchbar-outer"> - <input type="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> - 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-rainbow-bracket-queries"><a class="header" href="#adding-rainbow-bracket-queries">Adding Rainbow Bracket Queries</a></h1> -<p>Helix uses <code>rainbows.scm</code> tree-sitter query files to provide rainbow bracket -functionality.</p> -<p>Tree-sitter queries are documented in the tree-sitter online documentation. -If you're writing queries for the first time, be sure to check out the section -on <a href="https://tree-sitter.github.io/tree-sitter/syntax-highlighting#highlights">syntax highlighting queries</a> and on <a href="https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries">query syntax</a>.</p> -<p>Rainbow queries have two captures: <code>@rainbow.scope</code> and <code>@rainbow.bracket</code>. -<code>@rainbow.scope</code> should capture any node that increases the nesting level -while <code>@rainbow.bracket</code> should capture any bracket nodes. Put another way: -<code>@rainbow.scope</code> switches to the next rainbow color for all nodes in the tree -under it while <code>@rainbow.bracket</code> paints captured nodes with the current -rainbow color.</p> -<p>For an example, let's add rainbow queries for the tree-sitter query (TSQ) -language itself. These queries will go into a -<code>runtime/queries/tsq/rainbows.scm</code> file in the repository root.</p> -<p>First we'll add the <code>@rainbow.bracket</code> captures. TSQ only has parentheses and -square brackets:</p> -<pre><code class="language-tsq">["(" ")" "[" "]"] @rainbow.bracket -</code></pre> -<p>The ordering of the nodes within the alternation (square brackets) is not -taken into consideration.</p> -<blockquote> -<p>Note: Why are these nodes quoted? Most syntax highlights capture text -surrounded by parentheses. These are <em>named nodes</em> and correspond to the -names of rules in the grammar. Brackets are usually written in tree-sitter -grammars as literal strings, for example:</p> -<pre><code class="language-js">{ - // ... - arguments: seq("(", repeat($.argument), ")"), - // ... -} -</code></pre> -<p>Nodes written as literal strings in tree-sitter grammars may be captured -in queries with those same literal strings.</p> -</blockquote> -<p>Then we'll add <code>@rainbow.scope</code> captures. The easiest way to do this is to -view the <code>grammar.js</code> file in the tree-sitter grammar's repository. For TSQ, -that file is <a href="https://github.com/the-mikedavis/tree-sitter-tsq/blob/48b5e9f82ae0a4727201626f33a17f69f8e0ff86/grammar.js">here</a>. As we scroll down the <code>grammar.js</code>, we -see that the <code>(alternation)</code>, (L36) <code>(group)</code> (L57), <code>(named_node)</code> (L59), -<code>(predicate)</code> (L87) and <code>(wildcard_node)</code> (L97) nodes all contain literal -parentheses or square brackets in their definitions. These nodes are all -direct parents of brackets and happen to also be the nodes we want to change -to the next rainbow color, so we capture them as <code>@rainbow.scope</code>.</p> -<pre><code class="language-tsq">[ - (group) - (named_node) - (wildcard_node) - (predicate) - (alternation) -] @rainbow.scope -</code></pre> -<p>This strategy works as a rule of thumb for most programming and configuration -languages. Markup languages can be trickier and may take additional -experimentation to find the correct nodes to use for scopes and brackets.</p> -<p>The <code>:tree-sitter-subtree</code> command shows the syntax tree under the primary -selection in S-expression format and can be a useful tool for determining how -to write a query.</p> -<h3 id="properties"><a class="header" href="#properties">Properties</a></h3> -<p>The <code>rainbow.include-children</code> property may be applied to <code>@rainbow.scope</code> -captures. By default, all <code>@rainbow.bracket</code> captures must be direct descendant -of a node captured with <code>@rainbow.scope</code> in a syntax tree in order to be -highlighted. The <code>rainbow.include-children</code> property disables that check and -allows <code>@rainbow.bracket</code> captures to be highlighted if they are direct or -indirect descendants of some node captured with <code>@rainbow.scope</code>.</p> -<p>For example, this property is used in the HTML rainbow queries.</p> -<p>For a document like <code><a>link</a></code>, the syntax tree is:</p> -<pre><code class="language-tsq">(element ; <a>link</a> - (start_tag ; <a> - (tag_name)) ; a - (text) ; link - (end_tag ; </a> - (tag_name))) ; a -</code></pre> -<p>If we want to highlight the <code><</code>, <code>></code> and <code></</code> nodes with rainbow colors, we -capture them as <code>@rainbow.bracket</code>:</p> -<pre><code class="language-tsq">["<" ">" "</"] @rainbow.bracket -</code></pre> -<p>And we capture <code>(element)</code> as <code>@rainbow.scope</code> because <code>(element)</code> nodes nest -within each other: they increment the nesting level and switch to the next -color in the rainbow.</p> -<pre><code class="language-tsq">(element) @rainbow.scope -</code></pre> -<p>But this combination of <code>@rainbow.scope</code> and <code>@rainbow.bracket</code> will not -highlight any nodes. <code><</code>, <code>></code> and <code></</code> are children of the <code>(start_tag)</code> and -<code>(end_tag)</code> nodes. We can't capture <code>(start_tag)</code> and <code>(end_tag)</code> as -<code>@rainbow.scope</code> because they don't nest other elements. We can fix this case -by removing the requirement that <code><</code>, <code>></code> and <code></</code> are direct descendants of -<code>(element)</code> using the <code>rainbow.include-children</code> property.</p> -<pre><code class="language-tsq">((element) @rainbow.scope - (#set! rainbow.include-children)) -</code></pre> -<p>With this property set, <code><</code>, <code>></code>, and <code></</code> will highlight with rainbow colors -even though they aren't direct descendents of the <code>(element)</code> node.</p> -<p><code>rainbow.include-children</code> is not necessary for the vast majority of programming -languages. It is only necessary when the node that increments the nesting level -(changes rainbow color) is not the direct parent of the bracket node.</p> - - </main> - - <nav class="nav-wrapper" aria-label="Page navigation"> - <!-- Mobile navigation buttons --> - <a rel="prev" href="../guides/injection.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> - <i class="fa fa-angle-left"></i> - </a> - - - <div style="clear: both"></div> - </nav> - </div> - </div> - - <nav class="nav-wide-wrapper" aria-label="Page navigation"> - <a rel="prev" href="../guides/injection.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> - <i class="fa fa-angle-left"></i> - </a> - - </nav> - - </div> - - - - - <script> - window.playground_copyable = true; - </script> - - - <script src="../elasticlunr.min.js"></script> - <script src="../mark.min.js"></script> - <script src="../searcher.js"></script> - - <script src="../clipboard.min.js"></script> - <script src="../highlight.js"></script> - <script src="../book.js"></script> - - <!-- Custom JS scripts --> - - - </div> - </body> -</html> diff --git a/master/guides/textobject.html b/master/guides/textobject.html deleted file mode 100644 index d67f0dda..00000000 --- a/master/guides/textobject.html +++ /dev/null @@ -1,270 +0,0 @@ -<!DOCTYPE HTML> -<html lang="en" class="colibri" dir="ltr"> - <head> - <!-- Book generated using mdBook --> - <meta charset="UTF-8"> - <title>Adding textobject queries</title> - - - <!-- Custom HTML head --> - - <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="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 --> - <link rel="stylesheet" href="../custom.css"> - - </head> - <body class="sidebar-visible no-js"> - <div id="body-container"> - <!-- Provide site root to javascript --> - <script> - 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> - 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> - 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('colibri') - html.classList.add(theme); - var body = document.querySelector('body'); - body.classList.remove('no-js') - body.classList.add('js'); - </script> - - <input type="checkbox" id="sidebar-toggle-anchor" class="hidden"> - - <!-- Hide / unhide sidebar before it is displayed --> - <script> - var body = document.querySelector('body'); - var sidebar = null; - var sidebar_toggle = document.getElementById("sidebar-toggle-anchor"); - if (document.body.clientWidth >= 1080) { - try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } - sidebar = sidebar || 'visible'; - } else { - sidebar = 'hidden'; - } - sidebar_toggle.checked = sidebar === 'visible'; - body.classList.remove('sidebar-visible'); - body.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" class="active"><strong aria-hidden="true">5.2.</strong> Adding textobject queries</a></li><li class="chapter-item expanded "><a href="../guides/indent.html"><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><li class="chapter-item expanded "><a href="../guides/rainbow_bracket_queries.html"><strong aria-hidden="true">5.5.</strong> Adding rainbow bracket queries</a></li></ol></li></ol> - </div> - <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div> - </nav> - - <!-- Track and set sidebar scroll position --> - <script> - var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox'); - sidebarScrollbox.addEventListener('click', function(e) { - if (e.target.tagName === 'A') { - sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop); - } - }, { passive: true }); - var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll'); - sessionStorage.removeItem('sidebar-scroll'); - if (sidebarScrollTop) { - // preserve sidebar scroll position when navigating via links within sidebar - sidebarScrollbox.scrollTop = sidebarScrollTop; - } else { - // scroll sidebar to current active section when navigating via "next/previous chapter" buttons - var activeSection = document.querySelector('#sidebar .active'); - if (activeSection) { - activeSection.scrollIntoView({ block: 'center' }); - } - } - </script> - - <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"> - <div class="left-buttons"> - <label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> - <i class="fa fa-bars"></i> - </label> - <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</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> - <a href="https://github.com/helix-editor/helix/edit/master/book/src/guides/textobject.md" title="Suggest an edit" aria-label="Suggest an edit"> - <i id="git-edit-button" class="fa fa-edit"></i> - </a> - - </div> - </div> - - <div id="search-wrapper" class="hidden"> - <form id="searchbar-outer" class="searchbar-outer"> - <input type="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> - 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-textobject-queries"><a class="header" href="#adding-textobject-queries">Adding textobject queries</a></h1> -<p>Helix supports textobjects that are language specific, such as functions, classes, etc. -These textobjects require an accompanying tree-sitter grammar and a <code>textobjects.scm</code> query file -to work properly. Tree-sitter allows us to query the source code syntax tree -and capture specific parts of it. The queries are written in a lisp dialect. -More information on how to write queries can be found in the <a href="https://tree-sitter.github.io/tree-sitter/using-parsers#query-syntax">official tree-sitter -documentation</a>.</p> -<p>Query files should be placed in <code>runtime/queries/{language}/textobjects.scm</code> -when contributing to Helix. Note that to test the query files locally you should put -them under your local runtime directory (<code>~/.config/helix/runtime</code> on Linux -for example).</p> -<p>The following <a href="https://tree-sitter.github.io/tree-sitter/using-parsers#capturing-nodes">captures</a> are recognized:</p> -<div class="table-wrapper"><table><thead><tr><th>Capture Name</th></tr></thead><tbody> -<tr><td><code>function.inside</code></td></tr> -<tr><td><code>function.around</code></td></tr> -<tr><td><code>class.inside</code></td></tr> -<tr><td><code>class.around</code></td></tr> -<tr><td><code>test.inside</code></td></tr> -<tr><td><code>test.around</code></td></tr> -<tr><td><code>parameter.inside</code></td></tr> -<tr><td><code>comment.inside</code></td></tr> -<tr><td><code>comment.around</code></td></tr> -</tbody></table> -</div> -<p><a href="https://github.com/search?q=repo%3Ahelix-editor%2Fhelix+path%3A%2A%2A/textobjects.scm&type=Code&ref=advsearch&l=&l=">Example query files</a> can be found in the helix GitHub repository.</p> -<h2 id="queries-for-textobject-based-navigation"><a class="header" href="#queries-for-textobject-based-navigation">Queries for textobject based navigation</a></h2> -<p>Tree-sitter based navigation in Helix is done using captures in the -following order:</p> -<ul> -<li><code>object.movement</code></li> -<li><code>object.around</code></li> -<li><code>object.inside</code></li> -</ul> -<p>For example if a <code>function.around</code> capture has been already defined for a language -in its <code>textobjects.scm</code> file, function navigation should also work automatically. -<code>function.movement</code> should be defined only if the node captured by <code>function.around</code> -doesn't make sense in a navigation context.</p> - - </main> - - <nav class="nav-wrapper" aria-label="Page navigation"> - <!-- Mobile navigation buttons --> - <a rel="prev" href="../guides/adding_languages.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 prefetch" href="../guides/indent.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/adding_languages.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 prefetch" href="../guides/indent.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> - window.playground_copyable = true; - </script> - - - <script src="../elasticlunr.min.js"></script> - <script src="../mark.min.js"></script> - <script src="../searcher.js"></script> - - <script src="../clipboard.min.js"></script> - <script src="../highlight.js"></script> - <script src="../book.js"></script> - - <!-- Custom JS scripts --> - - - </div> - </body> -</html> |