docs(tree-sitter): document +tree-sitter flag in :lang readmes

Co-authored-by: Jeetaditya Chatterjee <jeetelongname@gmail.com>
This commit is contained in:
Itai Y. Efrat 2022-04-09 18:38:04 +03:00 committed by Henrik Lissner
parent b21de24311
commit 969c6ae8aa
20 changed files with 60 additions and 1 deletions

View file

@ -15,6 +15,9 @@ exists directly in the agda repository, but not in melpa.
** Module flags
- +local ::
Use the =agda-mode= executable that comes with your local =agda= install.
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- unless [[doom-module:][+local]]

View file

@ -26,6 +26,9 @@ This module adds support for the C-family of languages: C, C++, and Objective-C.
Enable LSP support for ~c-mode~, ~c++-mode~, and ~objc-mode~. Requires [[doom-module:][:tools
lsp]] and a langserver (supports ccls, clangd, and cquery). Replaces irony &
rtags.
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][cmake-mode]]

View file

@ -18,6 +18,9 @@ LSP).
- +lsp ::
Enable LSP support for ~csharp-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports =omnisharp-roslyn=).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
- +unity ::
Enable special support for the [[https://unity.com/][Unity game engine]] (particularly, support for
HLSL shaders).

View file

@ -16,6 +16,9 @@ This module provides support for [[https://elixir-lang.org/][Elixir programming
- +lsp ::
Enable LSP support for ~elixir-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports [[https://github.com/elixir-lsp/elixir-ls/][elixir-ls]]).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][alchemist]]

View file

@ -15,6 +15,9 @@ This module adds [[https://elm-lang.org/][Elm]] support to Doom Emacs.
- +lsp ::
Enable LSP support for ~elm-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports [[https://github.com/elm-tooling/elm-language-server][elm-language-server]]).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][elm-mode]]

View file

@ -29,6 +29,9 @@ This module adds [[https://golang.org][Go]] support, with optional (but recommen
Enable LSP support for ~go-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports gopls). Highly recommended, as the non-LSP experience is deprecated
(and poor).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][company-go]] if [[doom-module:][:completion company]] (DEPRECATED)

View file

@ -18,6 +18,9 @@ This module adds [[https://www.java.com][Java]] support to Doom Emacs, including
(supports eclipse.jdt.ls). *Incompatible with [[doom-module:][+meghanada]].*
- +meghanada ::
Enable [[doom-package:][meghanada-mode]]. *Incompatible with [[doom-module:][+lsp]].*
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][android-mode]]

View file

@ -26,6 +26,9 @@ This module adds [[https://www.javascript.com/][JavaScript]] and [[https://www.t
Enable LSP support for ~js2-mode~, ~rjsx-mode~, JS in ~web-mode~, and
~typescript-mode~. Requires [[doom-module:][:tools lsp]] and a langserver (supports ts-ls and
deno-ls).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][js2-refactor]]

View file

@ -15,6 +15,9 @@ This module adds [[https://www.json.org/json-en.html][JSON]] support to Doom Ema
- +lsp ::
Enable LSP support for ~json-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports [[https://github.com/vscode-langservers/vscode-json-languageserver][vscode-json-languageserver]]).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][counsel-jq]] if [[doom-module:][:completion ivy]]

View file

@ -19,6 +19,9 @@ This module adds support for [[https://julialang.org/][the Julia language]] to D
- +lsp ::
Enable LSP support for ~julia-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports LanguageServer.jl).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][julia-mode]]

View file

@ -21,7 +21,9 @@ Includes:
[[doom-contrib-maintainer:][Become a maintainer?]]
** Module flags
/This module has no flags./
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][company-nixos-options]] if [[doom-module:][:completion company]]

View file

@ -24,6 +24,9 @@ This module adds [[https://ocaml.org/][OCaml]] support to Doom Emacs, powered by
- +lsp ::
Enable LSP support for ~tuareg-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports [[https://github.com/freebroccolo/ocaml-language-server][ocaml-language-server]]).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][dune]]

View file

@ -36,6 +36,9 @@ This module adds support for PHP 5.3+ (including PHP7) to Doom Emacs.
- +lsp ::
Enable LSP support for ~php-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports [[https://phpactor.readthedocs.io/en/develop/usage/standalone.html][phpactor]] and intelephense).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][async]]

View file

@ -34,6 +34,9 @@ This module adds [[https://www.python.org/][Python]] support to Doom Emacs.
Enable Python virtual environment support via [[https://github.com/pyenv/pyenv][pyenv]]
- +pyright ::
Use the pyright LSP server instead of mspyls or pyls (requires [[doom-module:][+lsp]]).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][anaconda-mode]]

View file

@ -31,6 +31,9 @@ This module add Ruby and optional Ruby on Rails support to Emacs.
Enable rbenv integration.
- +rvm ::
Enable RVM (Ruby Version Manager) integration.
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][bundler]]

View file

@ -30,6 +30,9 @@ Through the power of [[https://scalameta.org/metals/docs/editors/overview.html][
- +lsp ::
Enable LSP support for ~scala-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports metals).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][sbt-mode]]

View file

@ -25,6 +25,9 @@ Fish script) to Doom Emacs.
(supports bash-language-server).
- +powershell ::
Add syntax highlighting for Powershell script files (=.ps1= and =.psm1=).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][company-shell]] if [[doom-module:][:completion company]]

View file

@ -15,6 +15,9 @@ This module adds support for the [[https://developer.apple.com/swift/][Swift pro
- +lsp ::
Enable LSP support for ~swift-mode~. Requires [[doom-module:][:tools lsp]] and a langserver
(supports sourcekit).
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][swift-mode]]

View file

@ -19,6 +19,9 @@ ReactJS, Wordpress, Jekyll, Phaser, AngularJS, Djano, and more.
- +lsp ::
Enable LSP support for ~web-mode~ and ~css-mode~. Requires [[doom-module:][:tools lsp]] and a
langserver.
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][company-web]] if [[doom-module:][:completion company]]

View file

@ -22,6 +22,9 @@ This module adds [[https://ziglang.org/][Zig]] support, with optional (but recom
- +lsp ::
Enables integration for the zls LSP server. It is highly recommended you use
this.
- +tree-sitter ::
Leverages tree-sitter for better syntax highlighting and structural text
editing. Requires [[doom-module:][:tools tree-sitter]].
** Packages
- [[doom-package:][zig-mode]]