https://github.com/mfussenegger/nvim-snippasta
Paste code as snippets
https://github.com/mfussenegger/nvim-snippasta
neovim-plugin snippets
Last synced: 3 months ago
JSON representation
Paste code as snippets
- Host: GitHub
- URL: https://github.com/mfussenegger/nvim-snippasta
- Owner: mfussenegger
- Created: 2024-05-27T16:57:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-28T16:25:57.000Z (over 1 year ago)
- Last Synced: 2024-11-23T07:33:34.946Z (11 months ago)
- Topics: neovim-plugin, snippets
- Language: Lua
- Homepage:
- Size: 4.88 KB
- Stars: 15
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `snippasta`
A plugin that allows you to paste code as snippet, based on [treesitter queries][treesitter-queries]
which identify parts of the code that should be replaced with tabstops.
[See demo](https://social.fussenegger.pro/system/media_attachments/files/112/500/794/132/998/267/original/872f1784ca082a69.mp4)
## Installation
Requires nvim-0.10+
```bash
git clone \
https://github.com/mfussenegger/nvim-snippasta.git \
~/.config/nvim/pack/plugins/start/nvim-snippasta
```
## Usage
The plugin exposes a single function which you can call via `keymap`:
```lua
keymap.set({"n"}, "p", function() require("snippasta").paste() end)
```
The function tries to translate the text present in the `v:register` `register`
into a snippet by replacing parts of it with tabstops and expand it using
`vim.snippet.expand`.
To identify which parts of the text are converted to tabstops it uses
tree-sitter queries containing `@tabstop` captures.
The queries themselves are _not_ part of the plugin. You have to add them yourself.
They're likely opinionated and I don't have the bandwidth to maintain a
collection of them for each language.
To add the queries, create query files named `tabstop.scm` in the query folder.
(`~/.config/nvim/queries/`). Read `:help treesitter-query` for more
information.
There is a fallback to use a `highlights.scm` in case you have no `tabstop.scm`
file for a given language. In this case it will use the `@string`, `@number`,
`@boolean` and `@variable.parameter` captures as potential tabstop.
## Query examples
Here are a few examples to give you some inspiration.
You can use `:InspectTree` and `:EditQuery` to help you write your own queries.
### lua
```query
(variable_declaration
(assignment_statement
(variable_list
name: (identifier) @tabstop)
))
(table_constructor
(field
name: _
value: _ @tabstop))
(function_call
name: _
arguments: (arguments (_) @tabstop))
```
### python
```query
(assignment
left: (identifier) @tabstop)
(call
arguments: (argument_list [
(keyword_argument
value: (_) @tabstop)
(string) @tabstop
(integer) @tabstop
(true) @tabstop
(false) @tabstop
]))
```
### xml
```query
(content
(CharData) @tabstop)
```
[treesitter-queries]: https://tree-sitter.github.io/tree-sitter/using-parsers#query-syntax