https://github.com/meain/tree-surgeon

Code manipulation utilities for Emacs using tree-sitter
https://github.com/meain/tree-surgeon

emacs tree-sitter

Last synced: about 2 months ago
JSON representation

Code manipulation utilities for Emacs using tree-sitter

• Host: GitHub
• URL: https://github.com/meain/tree-surgeon
• Owner: meain
• Created: 2023-08-04T05:12:27.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-07T09:37:39.000Z (about 2 months ago)
• Last Synced: 2024-12-07T10:23:34.004Z (about 2 months ago)
• Topics: emacs, tree-sitter
• Language: Emacs Lisp
• Homepage:
• Size: 4.88 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# tree-surgeon

A collection of code manipulation utils using tree-sitter.

```emacs-lisp

;; Example configuration

(use-package tree-surgeon

  :straight (tree-surgeon :type git :host github :repo "meain/tree-surgeon")

  :config (evil-leader/set-key "H j" 'tree-surgeon-split-join))

```

## Features

_I am still porting over things from elisp-tree-sitter(in my personal

config) to builtin treesit module. As of now, we just have split-join

and go-errors but should have more here soon._

### Split join

Split and join arguments and parameters in function calls and definitions.

![](https://user-images.githubusercontent.com/14259816/258302386-d479cd0d-aa3e-4a2f-8f89-2959041a08c8.webm)

```emacs-lisp

M-x tree-surgeon-split-join

```

##### Customization

You can add or modify the language specific settings by modifying `tree-surgeon-split-join-settings`.

### Go errors

Automatically generate go return statements for errors. Call

`tree-surgeon-go-errors` to generate the return statements with an `if

err != nil` check.

```emacs-lisp

M-x tree-surgeon-go-errors

```

### Imenu utils

You can use tree-surgeon to provide queries for blocks and keys within

them to create imenu entries.

```emacs-lisp

;; Add the following for yaml

(add-hook 'yaml-ts-mode-hook

          (lambda ()

            (setq imenu-create-index-function

                  (tree-surgeon-kv-imenu-index-function 'yaml

                                                        "(block_mapping_pair key: (flow_node)) @body"

                                                        "key: (flow_node) @key"))))

;; Add the following for json

(add-hook 'json-ts-mode-hook

          (lambda ()

            (setq imenu-create-index-function

                  (tree-surgeon-kv-imenu-index-function 'json

                                                        "(pair key: (string)) @body"

                                                        "key: (string (string_content) @key)"))))

```