From 969c6ae8aa211ab122526260fbd8d3fd5598b315 Mon Sep 17 00:00:00 2001
From: "Itai Y. Efrat" <itai3397@gmail.com>
Date: Sat, 9 Apr 2022 18:38:04 +0300
Subject: [PATCH] docs(tree-sitter): document +tree-sitter flag in :lang
 readmes

Co-authored-by: Jeetaditya Chatterjee <jeetelongname@gmail.com>
---
 modules/lang/agda/README.org       | 3 +++
 modules/lang/cc/README.org         | 3 +++
 modules/lang/csharp/README.org     | 3 +++
 modules/lang/elixir/README.org     | 3 +++
 modules/lang/elm/README.org        | 3 +++
 modules/lang/go/README.org         | 3 +++
 modules/lang/java/README.org       | 3 +++
 modules/lang/javascript/README.org | 3 +++
 modules/lang/json/README.org       | 3 +++
 modules/lang/julia/README.org      | 3 +++
 modules/lang/nix/README.org        | 4 +++-
 modules/lang/ocaml/README.org      | 3 +++
 modules/lang/php/README.org        | 3 +++
 modules/lang/python/README.org     | 3 +++
 modules/lang/ruby/README.org       | 3 +++
 modules/lang/scala/README.org      | 3 +++
 modules/lang/sh/README.org         | 3 +++
 modules/lang/swift/README.org      | 3 +++
 modules/lang/web/README.org        | 3 +++
 modules/lang/zig/README.org        | 3 +++
 20 files changed, 60 insertions(+), 1 deletion(-)

diff --git a/modules/lang/agda/README.org b/modules/lang/agda/README.org
index 1fecf1d49..50329b980 100644
--- a/modules/lang/agda/README.org
+++ b/modules/lang/agda/README.org
@@ -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]]
diff --git a/modules/lang/cc/README.org b/modules/lang/cc/README.org
index 1ee256e9d..8a122243e 100644
--- a/modules/lang/cc/README.org
+++ b/modules/lang/cc/README.org
@@ -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]]
diff --git a/modules/lang/csharp/README.org b/modules/lang/csharp/README.org
index 947bfbd82..9a0b70987 100644
--- a/modules/lang/csharp/README.org
+++ b/modules/lang/csharp/README.org
@@ -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).
diff --git a/modules/lang/elixir/README.org b/modules/lang/elixir/README.org
index 5c84e1b9e..16e080dca 100644
--- a/modules/lang/elixir/README.org
+++ b/modules/lang/elixir/README.org
@@ -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]]
diff --git a/modules/lang/elm/README.org b/modules/lang/elm/README.org
index 73456d696..4c826a9f0 100644
--- a/modules/lang/elm/README.org
+++ b/modules/lang/elm/README.org
@@ -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]]
diff --git a/modules/lang/go/README.org b/modules/lang/go/README.org
index 154804a83..4a9f68d55 100644
--- a/modules/lang/go/README.org
+++ b/modules/lang/go/README.org
@@ -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)
diff --git a/modules/lang/java/README.org b/modules/lang/java/README.org
index fd17c4aeb..079720be2 100644
--- a/modules/lang/java/README.org
+++ b/modules/lang/java/README.org
@@ -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]]
diff --git a/modules/lang/javascript/README.org b/modules/lang/javascript/README.org
index 777c42877..b8c656f1d 100644
--- a/modules/lang/javascript/README.org
+++ b/modules/lang/javascript/README.org
@@ -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]]
diff --git a/modules/lang/json/README.org b/modules/lang/json/README.org
index 6a6a8c9f8..c948b7b5f 100644
--- a/modules/lang/json/README.org
+++ b/modules/lang/json/README.org
@@ -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]]
diff --git a/modules/lang/julia/README.org b/modules/lang/julia/README.org
index 071c1fbfe..56aa6bbf2 100644
--- a/modules/lang/julia/README.org
+++ b/modules/lang/julia/README.org
@@ -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]]
diff --git a/modules/lang/nix/README.org b/modules/lang/nix/README.org
index 325d45ab1..62301b42c 100644
--- a/modules/lang/nix/README.org
+++ b/modules/lang/nix/README.org
@@ -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]]
diff --git a/modules/lang/ocaml/README.org b/modules/lang/ocaml/README.org
index 9d087d117..33a54d0c1 100644
--- a/modules/lang/ocaml/README.org
+++ b/modules/lang/ocaml/README.org
@@ -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]]
diff --git a/modules/lang/php/README.org b/modules/lang/php/README.org
index fbe416a82..1344fad04 100644
--- a/modules/lang/php/README.org
+++ b/modules/lang/php/README.org
@@ -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]]
diff --git a/modules/lang/python/README.org b/modules/lang/python/README.org
index a070c6fad..28c752015 100644
--- a/modules/lang/python/README.org
+++ b/modules/lang/python/README.org
@@ -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]]
diff --git a/modules/lang/ruby/README.org b/modules/lang/ruby/README.org
index a0ece1f8a..5c584e5f9 100644
--- a/modules/lang/ruby/README.org
+++ b/modules/lang/ruby/README.org
@@ -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]]
diff --git a/modules/lang/scala/README.org b/modules/lang/scala/README.org
index f8aeee108..62e2353a9 100644
--- a/modules/lang/scala/README.org
+++ b/modules/lang/scala/README.org
@@ -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]]
diff --git a/modules/lang/sh/README.org b/modules/lang/sh/README.org
index 0365c11ad..a6508871d 100644
--- a/modules/lang/sh/README.org
+++ b/modules/lang/sh/README.org
@@ -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]]
diff --git a/modules/lang/swift/README.org b/modules/lang/swift/README.org
index 995efdb3d..a3787ff17 100644
--- a/modules/lang/swift/README.org
+++ b/modules/lang/swift/README.org
@@ -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]]
diff --git a/modules/lang/web/README.org b/modules/lang/web/README.org
index a8db45b55..ac77b96c2 100644
--- a/modules/lang/web/README.org
+++ b/modules/lang/web/README.org
@@ -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]]
diff --git a/modules/lang/zig/README.org b/modules/lang/zig/README.org
index e28486b67..d67a71bef 100644
--- a/modules/lang/zig/README.org
+++ b/modules/lang/zig/README.org
@@ -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]]