shrub.nvim 🌱

Collection of Treesitter powered utilities for common JavaScript/TypeScript source code edits and refactors

📚 Features

• convert between implicit and explicit arrow function return statements
• add/remove braces from conditional statements
• convert between arrow and function declaration

📦 Installation

This Plugin assumes you have nvim-treesitter and the following parsers installed:

• JavaScript
• TypeScript

lazy.nvim

The following plugin spec will initialize the plugin with the default configuration.

return {
  "ianjkaplan/shrub.nvim",
  config = true
  dependencies = { "nvim-treesitter/nvim-treesitter", "nvim-lua/plenary.nvim", "stevearc/conform.nvim" },
}

you can provide custom key bindings by passing your own keys to the keys field

⚙️ Configuration

Default Key Binding	Lua	Description
<leader>jer	lua require("shrub").statement_block_surround	When the cursor in the body of a function or conditional that doesnt have a wrapping {} will add a surrounding statement block
<leader>jir	lua require("shrub").statement_block_remove	If the cursor is in the body of an arrow function, will remove surrounding {} and will move everything following the return statement to an implicit return (e.g const myFn => "result"). If the cursor is in a conditional everything will produce a one line early return e.g if (true) return "result"
<leader>jfa	lua require("shrub").fun_declaration_to_arrow	converts a named function declaraton to an arrow function assigning the function name to a const declaration
<leader>jaf	lua require("shrub").arrow_fun_to_declaration	converts an arrow function to a function declaration

shrub.nvim only provides a few key bindings to perform common text manipulations. It uses conform.nvim to run whatever formatter to ensure that the code is formatted after the edit is made. This means that you can use any formatter you want with shrub.nvim as long as it is supported by conform.nvim. Prettier is recommended.

Development

🚧 Under Construction

If you experience any issues, see some improvement you think would be amazing, or just have some feedback or advice, make an issue!

Running the tests

This project uses plenary.nvim to run tests. To run the tests, run the following command:

nvim --headless -c 'PlenaryBustedDirectory tests'

Make sure that the javascript and typescript parsers are installed and in the runtime path for the test neovim instance