Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rktjmp/paperplanes.nvim
Neovim :airplane: Pastebins
https://github.com/rktjmp/paperplanes.nvim
fennel lua neovim neovim-plugin pastebin
Last synced: about 2 months ago
JSON representation
Neovim :airplane: Pastebins
- Host: GitHub
- URL: https://github.com/rktjmp/paperplanes.nvim
- Owner: rktjmp
- License: mit
- Created: 2021-08-05T12:38:07.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-13T10:32:40.000Z (7 months ago)
- Last Synced: 2024-01-24T10:40:19.591Z (4 months ago)
- Topics: fennel, lua, neovim, neovim-plugin, pastebin
- Language: Fennel
- Homepage:
- Size: 214 KB
- Stars: 85
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-neovim - rktjmp/paperplanes.nvim - Post selections or buffers to online paste bins. (Utility / Cursorline)
- awesome-stars - rktjmp/paperplanes.nvim - Neovim :airplane: Pastebins (Fennel)
- awesome-stars - rktjmp/paperplanes.nvim - Neovim :airplane: Pastebins (Fennel)
- awesome-stars - paperplanes.nvim
- awesome-stars - rktjmp/paperplanes.nvim - Neovim :airplane: Pastebins (Fennel)
- awesome-neovim - rktjmp/paperplanes.nvim - Post selections or buffers to online paste bins. (Utility / Cursorline)
- awesome-neovim - rktjmp/paperplanes.nvim - Post selections or buffers to online paste bins. (Utility / Cursorline)
README
# _paperplanes_.nvim
Post selections or buffers to online paste bins. Save the URL to a register, or
dont.
## Requirements
- Neovim 0.5+
- A `curl` executable in your `$PATH`
## Install
Use your package manager.
## Configuration & Use
**Setup**
```lua
-- options shown with default values
require("paperplanes").setup({
register = "+",
provider = "0x0.st",
provider_options = {},
notifier = vim.notify or print,
})
```
- `register` - any valid register name or false
- `provider` - See provider list.
- `provider_options` - passed to selected provider, see list of providers below for accepted options
- `notifier` - any function that accepts a string, should show that string in some way.
**Commands**
Post selection or buffer to configured provider, sets configured register and
print's the result.
- `:PP` -> Post current buffer.
- `:[range]PP` -> Post range.
- Vim does not support column aware ranges when using commands. Use
`post_selection` via a map for that behaviour.
**Functions**
See [`:h paperplanes`](doc/paperplanes.txt) for more complete documentation.
Functions are provided in `snake_case` and `kebab-case` (`post_string` and
`post-string`).
All functions accept a `callback` argument which is called with `url, nil` or
`nil, errors`.
`provider-name` and `provider-options` are optional and the default provider
will be used if not given.
Functions to not automatically print the url or set any registers.
- `post_string(content, metadata, callback, provider-name, provider-options)`
- `post_range(buffer, start_pos, end_pos, callback, provider-name, provider-options)`
- `post_selection(callback, provider-name, provider-options)`
- `post_buffer(buffer, callback, provider-name, provider-options)`
## Providers
_paperplanes_ supports the following providers, see sites for TOS and
features.
- https://0x0.st (`provider = "0x0.st"`)
- https://paste.rs (`provider = "paste.rs"`)
- https://paste.sr.ht (`provider = "sr.ht"`)
- `command`: `"curl"` (default) or `"hut"`.
- `token`: PAT token string, or function returning token string, required if `command = "curl" | nil`.
- https://gist.github.com (`provider = "gist"`)
- `command`: `"curl"` (default) or `"gh"`.
- `token`: PAT token string or function returning token string, required if `command = "curl" | nil`.
- https://dpaste.org (`provider = "dpaste.org"`)
- https://ray.so (`provider = "ray.so"`)
- https://mystb.in (`provider = "mystb.in"`)
- http://ix.io (`provider = "ix.io"`)
- **Endpoint is HTTP only**, requires `insecure = true` explicit opt in.
- http://sprunge.us (`provider = "sprunge.us"`)
- **Endpoint is HTTP only**, requires `insecure = true` explicit opt in.
To create a new provider, see [`:h paperplanes`](doc/paperplanes.txt) and
`fnl/paperplanes/providers/*.fnl`.
_paperplanes_ is not affiliated with any provider in any manner.
## Building
Building _paperplanes_ requires [hotpot.nvim](https://github.com/rktjmp/hotpot.nvim) v0.9.7+.
The relevant `lua|` files should be build when saving any file inside `fnl/`.
## Changelog
See `CHANGELOG.md`.