emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/indent-bars 93a268799d 307/431: Update README.md


From: ELPA Syncer
Subject: [elpa] externals/indent-bars 93a268799d 307/431: Update README.md
Date: Mon, 16 Sep 2024 12:59:44 -0400 (EDT)

branch: externals/indent-bars
commit 93a268799dbbca4910a804ef9ab5ec8134cee560
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: GitHub <noreply@github.com>

    Update README.md
---
 README.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index d4a93f3c04..6826f736b8 100644
--- a/README.md
+++ b/README.md
@@ -228,9 +228,11 @@ Experiment with these to see what you prefer.
 
 ### Configuring tree-sitter
 
-Simply configure `indent-bars-treesit-scope` with the node types for which 
"local scope" highlighting is of interest.  This must be done for each language 
you use.  This scope could be as granular as classes and functions, or 
including detailed block statements.   `indent-bars-treesit-wrap` can be 
configured in a similar manner, if desired.  I recommend starting with the 
minimal possible set of node types, adding as needed.
+Simply configure `indent-bars-treesit-scope` with the node types for which 
"local scope" highlighting nodes are of interest.  This must be done for each 
tree-sitter language you use.  This scope could be as granular as classes and 
functions, or includ detailed block statements.  You can disable scoping for 
"short blocks" using `indent-bars-treesit-scope-min-lines`, so that, e.g., a 
quick `if` statement does not capture scope. I recommend starting with the 
minimal possible set of node typ [...]
 
-The easiest way to discover the node types of interest (in a buffer with 
working treesit support) is to `M-x treesit-explore-mode`. Then simply 
highlight the beginning of a line of interest, and look in the `treesitter 
explorer` buffer which pops up for the names of obvious nodes in the tree.  Add 
these types to `indent-bars-treesit-scope/wrap` for the language of interest, 
then `M-x indent-bars-reset` and see how you did.  You can do something similar 
for `indent-bars-treesit-ignore-bla [...]
+indent-bars-treesit-wrap` can be configured in a similar manner, if desired, 
although the default of `indent-bars-no-descend-list` may be sufficient for 
your uses.
+
+The easiest way to discover node types of interest (in a buffer with working 
treesit support) is to `M-x treesit-explore-mode`. Then simply highlight the 
beginning of a line of interest, and look in the `treesitter explorer` buffer 
which pops up for the names of obvious nodes in the tree.  Add these types to 
`indent-bars-treesit-scope/wrap` for the language of interest, then `M-x 
indent-bars-reset` and see how you did.  You can do something similar for 
`indent-bars-treesit-ignore-blank-l [...]
 
 Please document good tree-sitter settings for other languages in the 
[Wiki](https://github.com/jdtsmith/indent-bars/wiki/indent%E2%80%90bars-config-Wiki#tree-sitter-config).
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]