[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).
- [elpa] externals/indent-bars d06e6e10da 268/431: Overhaul scope structure and logic, (continued)
- [elpa] externals/indent-bars d06e6e10da 268/431: Overhaul scope structure and logic, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars bfcc3fac50 271/431: assign update-depth-function in :success clause, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars d883507335 270/431: docs: improve update-scope1 docstring, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 10ce56b4e0 255/431: Improve stipple docstring and comment, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars d7b56cf13f 284/431: Tweak PPSS logic, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars d7c1bd96e4 287/431: use idle-timer for highlighted bar update too, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars e3ebe0d389 289/431: Remove window-state-change-functions hook on teardown, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars e12b91fe3f 295/431: doc: custom tweak, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 8855d462da 297/431: Add unspecified choice to simple custom vars too, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars dd4f7bd3ee 296/431: update-scope: consider no node or scope match as full-file, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 93a268799d 307/431: Update README.md,
ELPA Syncer <=
- [elpa] externals/indent-bars a78445ef7d 299/431: update copyrights, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars d962712541 302/431: Update-name and relocate delay vars, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars def1e3e395 303/431: README: document v0.5 release, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 6a68c5e7ff 301/431: Bump version, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars c4d05c62c0 306/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars f34bd21940 310/431: Tweak default bar style: slimmer bar, longer "dash:, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 2b6d25a083 316/431: update current indentation only if depth decreases, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars f6e96b01d2 312/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 449b49f6a1 331/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars dd197c931a 334/431: Update README.md, ELPA Syncer, 2024/09/16