Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Apeiros-46B/qalc.nvim
A Neovim frontend for Qalculate
https://github.com/Apeiros-46B/qalc.nvim
calculator neovim neovim-plugin qalculate
Last synced: 3 months ago
JSON representation
A Neovim frontend for Qalculate
- Host: GitHub
- URL: https://github.com/Apeiros-46B/qalc.nvim
- Owner: Apeiros-46B
- License: gpl-3.0
- Created: 2022-12-23T04:44:53.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-07T18:02:37.000Z (4 months ago)
- Last Synced: 2024-07-07T19:24:37.926Z (4 months ago)
- Topics: calculator, neovim, neovim-plugin, qalculate
- Language: Lua
- Homepage:
- Size: 123 KB
- Stars: 24
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# qalc.nvim
*inspired by [quickmath.nvim](https://github.com/jbyuki/quickmath.nvim)*
A Neovim frontend for the [the `qalc` CLI program](https://github.com/Qalculate/libqalculate)
## Features
- Evaluates `qalc` commands in a Neovim buffer and updates results in virtual text on buffer content change
- Shows warnings and errors from commands as Neovim diagnostics
## Installation
Requires the `qalc` binary executable and in `PATH`.
Install using your preferred plugin manager:
- [vim-plug](https://github.com/junegunn/vim-plug)
```vim
Plug "Apeiros-46B/qalc.nvim"
```
- [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use 'Apeiros-46B/qalc.nvim'
```
## Usage
Edit a file with extension `.qalc` or use the `:Qalc` command.
The `:Qalc` command optionally accepts one argument; the name of the newly created buffer.
Alternatively, you can attach to an existing buffer using `:QalcAttach`.
You can yank the result on the current line with `:QalcYank`, which takes an optional register (see `:h setreg()`). The default register can be configured (see below).
All commands accepted in the buffer are `qalc` commands.
## Configuration
To configure, call the `setup` function.
```lua
require('qalc').setup({
-- your config goes here
})
```
Keep in mind that this plugin is still under development so configuration keys may change or be removed at any time.
Default configuration
```lua
local config = {
-- extra command arguments for Qalculate
-- do NOT use the option `-t`/`--terse`; it will break the plugin
-- example: { '--set', 'angle deg' } to use degrees as the default angle unit
cmd_args = {}, -- table
-- default name of a newly opened buffer
-- set to '' to open an unnamed buffer
bufname = '', -- string
-- the plugin will set all attached buffers to have this filetype
-- set to '' to disable setting the filetype
-- the default is provided for basic syntax highlighting
set_ft = 'config', -- string
-- file extension to automatically attach qalc to
-- set to '' to disable automatic attaching
attach_extension = '*.qalc', -- string
-- default register to yank results to
-- default register = '@'
-- clipboard = '+'
-- X11 selection = '*'
-- other registers not listed are also supported
-- see `:h setreg()`
yank_default_register = '@', -- string
-- sign shown before result
sign = '=', -- string
-- whether or not to show a sign before the result
show_sign = true, -- boolean
-- whether or not to right align virtual text
right_align = false, -- boolean
-- highlight groups
highlights = {
sign = '@conceal', -- sign before result
result = '@string', -- result in virtual text
},
-- diagnostic options
-- set to nil to respect the options in your neovim configuration
-- (see `:h vim.diagnostic.config()`)
diagnostics = { -- table?
underline = true,
virtual_text = false,
signs = true,
update_in_insert = true,
severity_sort = true,
},
-- use pty for job communication (MS Windows w/o WSL do not support pty)
use_pty = not ((vim.fn.has('win32') == 1) and (vim.fn.has('wsl') == 0)),
-- End-Of-File character (MS Windows uses ^Z (EOF), others use ^D (EOT))
eof = string.char(((vim.fn.has('win32') == 1) and (vim.fn.has('wsl') == 0)) and 26 or 4)
}
```
## Planned Changes
The following is a list of things I will most likely change/implement in the near future (when I have enough free time).
Items are ordered by priority.
- (fix) Preventing commands that output nothing or more than 1 line from breaking subsequent results display
- (perf) Keeping the `qalc` process alive instead of calling it on every buffer update
- (perf) Only recalculating what is necessary instead of recalculating the whole buffer on every update
- (feat) Adding custom syntax highlighting (long-term)
- (feat) Adding [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) integration for completion of variables, functions, and units (long-term)