Skip to content

Commit 51aedba

Browse files
committed
Small tweaks to readme
1 parent 4b268cd commit 51aedba

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
<img alt="Neovim" style="height: 20px;" src="https://img.shields.io/badge/NeoVim-%2357A143.svg?&amp;style=for-the-badge&amp;logo=neovim&amp;logoColor=white">
1212
</a>
1313
<img alt="100% Lua" src="https://img.shields.io/badge/100%25_lua-purple" height="20px">
14+
<span>&nbsp;</span>
1415
<img src="https://github.com/aaronik/treewalker.nvim/actions/workflows/test.yml/badge.svg" alt="build status">
1516
<img src="https://img.shields.io/github/issues/aaronik/treewalker.nvim/bug?label=bugs" alt="GitHub issues by-label">
1617
<img src="https://img.shields.io/github/issues-pr/aaronik/treewalker.nvim" alt="GitHub Pull Requests">
@@ -25,7 +26,10 @@
2526
<div align="center">
2627
<h2>Move around your code in a syntax tree aware manner.</h2>
2728
<p>
28-
Treewalker uses neovim's native <a href="https://github.com/tree-sitter/tree-sitter">Treesitter</a> under the hood for syntax tree awareness.
29+
Treewalker uses neovim's native <a href="https://github.com/tree-sitter/tree-sitter">Treesitter</a>
30+
under the hood to enable movement around and swapping of code objects like
31+
functions, blocks, and statements.
32+
<br/>
2933
Design goals include stability, ergonomics, and simplicity.
3034
</p>
3135
</div>
@@ -176,8 +180,8 @@ vim.keymap.set('n', '<C-S-l>', '<cmd>Treewalker SwapRight<cr>', { silent = true
176180

177181
* [syntax-tree-surfer](https://github.com/ziontee113/syntax-tree-surfer)
178182
is publicly archived and I could not get it to work :/
179-
`Treewalker` has a robust test suite, makes use of the type system, has CI
180-
(automated testing), and has organized code. So the plugin should be pretty
183+
`Treewalker` has a robust test suite, is well typed, and has CI
184+
(automated testing), in the hope that the plugin is pretty
181185
stable. I believe `Treewalker` usage is a little bit simpler and more intuitive.
182186
`Treewalker` is missing the visual selection swap feature that syntax-tree-surfer
183187
has, though. (See [#32](https://github.com/aaronik/treewalker.nvim/issues/32))
@@ -200,15 +204,15 @@ offers a programmatic interface for swapping nodes. It doesn't suffer from node
200204
type awareness, and works mostly the same as `Treewalker` under the hood. Some
201205
of `Treewalker`'s left/right swapping code is inspired by `ts_utils`.
202206
`Treewalker` operates a little differently under the hood, picking the highest
203-
startwise coinciding node over the lowest. But mostly it does the work of
204-
finding the next relevant node and packaging it all up into a nice interface.
207+
startwise coinciding node over the lowest. But mostly `Treewalker` does the work of
208+
finding the next relevant node and packaging it all up into a nice user experience.
205209

206210
* [tree-climber.nvim](https://github.com/drybalka/tree-climber.nvim)
207211
i discovered long after having made `Treewalker`. It seems to be the most
208-
similar of all of these. It works mostly the same, but with a little bit less
209-
refinement, including getting stuck on certain nodes, and navigating to nodes
210-
that don't necessarily seem helpful to go to. In my usage, it seems like
211-
`tree-climber` gives you more fine grained access to each individual node,
212-
whereas `Treewalker` takes a more linewise approach which allows you to make
213-
larger movements more easily. For movement inside of a single line, `Treewalker`
214-
doesn't help much, whereas `tree-climber` does.
212+
similar of all of these. It works mostly the same, but sometimes gets stuck on
213+
certain nodes, and navigates to nodes that don't necessarily seem helpful to
214+
go to. In my usage, it seems like `tree-climber` gives you more fine grained
215+
access to each individual node, and works better than `Treewalker` for
216+
navigating the literal syntax tree. Whereas `Treewalker` selects nodes on a
217+
more linewise approach, which enables larger, more intuitive movements.
218+

0 commit comments

Comments
 (0)