[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/indent-bars fd5a01d38e 155/431: Update README.md
From: |
ELPA Syncer |
Subject: |
[elpa] externals/indent-bars fd5a01d38e 155/431: Update README.md |
Date: |
Mon, 16 Sep 2024 12:59:23 -0400 (EDT) |
branch: externals/indent-bars
commit fd5a01d38eef9bd6550b3fc05c5a1a8745a24c24
Author: JD Smith <93749+jdtsmith@users.noreply.github.com>
Commit: GitHub <noreply@github.com>
Update README.md
---
README.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5064e4d6fd..0cd6278604 100644
--- a/README.md
+++ b/README.md
@@ -147,7 +147,13 @@ into this:
**Note**: This requires Emacs 29 built with tree-sitter support, and the
appropriate tree-sitter grammars installed for languages of interest.
-The easiest way to discover the node types of interest is to `M-x
treesit-explore-mode`, highlight the beginning a line with too many bars, and
look up in the tree for the names of obvious nodes. Add these to
`indent-bars-treesit-wrap` for the language of interest.
+### Configuring tree-sitter
+
+The main thing to do is configure `indent-bars-treesit-wrap` with the node
types that lead to unwanted additional bars do their wrapping indentation
behavior. I recommend starting with the minimal possible set.
+
+The easiest way to discover the node types of interest is to `M-x
treesit-explore-mode`, then highlight the beginning of a line with too many
bars, 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-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-lines-types` (which, please note, are
configur [...]
+
+Please document good tree-sitter settings for other langauges in the
[Wiki](https://github.com/jdtsmith/indent-bars/wiki/indent%E2%80%90bars-config-Wiki#tree-sitter-config).
## Display
- [elpa] externals/indent-bars 4dc2b9e329 057/431: Update README.md, (continued)
- [elpa] externals/indent-bars 4dc2b9e329 057/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 44d7d633fc 123/431: Small doc, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars ea53a29562 127/431: Fix unwanted extra bars on over-sufficient blank lines, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 80ca1daeef 134/431: Remove reference to vestigial skip-leftmost-column, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 55852b3cee 128/431: Minor doc improvements, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 9de7111faf 125/431: Initial tab support, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 95f2bac5d9 136/431: blank-string: fix width trailing space calculation for one bar case, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 98784d79e7 169/431: Document no-stipple-char-font-weight, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 37239a3acb 148/431: save point more locally in draw-line, and highlight-current-depth, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 2350f4dd24 144/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars fd5a01d38e 155/431: Update README.md,
ELPA Syncer <=
- [elpa] externals/indent-bars 88a995668a 161/431: ts-node-query: restore use of ts-parser to indicate top level node, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 6500da0171 154/431: Update README.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars e3e9b72b8d 158/431: Update examples.md, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars c2e409e804 133/431: Bump version, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 27bcefda4b 132/431: increase highlight depth when line starts right on a bar, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 7cca87cf40 143/431: Document treesitter, tab-support, etc., ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 571522bd88 139/431: Add support for go-ts-mode, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars af3472b347 137/431: reorganize font-lock and treesitter sections, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars 3b32ee179b 140/431: Formatting, ELPA Syncer, 2024/09/16
- [elpa] externals/indent-bars edb7bce062 149/431: README improvements, ELPA Syncer, 2024/09/16