Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ms-jpq/coq.thirdparty
Module lua sources for `coq.nvim`, first & third party
https://github.com/ms-jpq/coq.thirdparty
Last synced: 4 days ago
JSON representation
Module lua sources for `coq.nvim`, first & third party
- Host: GitHub
- URL: https://github.com/ms-jpq/coq.thirdparty
- Owner: ms-jpq
- Created: 2021-09-12T22:19:35.000Z (about 3 years ago)
- Default Branch: 3p
- Last Pushed: 2024-08-26T05:27:27.000Z (3 months ago)
- Last Synced: 2024-10-26T20:39:29.412Z (18 days ago)
- Language: Lua
- Homepage:
- Size: 439 KB
- Stars: 61
- Watchers: 4
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# coq.nvim (first & third) party sources
**PR welcome**
---
**First party lua sources** & _third party integration_ for [`coq.nvim`](https://github.com/ms-jpq/coq_nvim)
See [`:COQhelp custom_sources`](https://github.com/ms-jpq/coq_nvim/tree/coq/docs/CUSTOM_SOURCES.md)
## How to use
Install the repo the normal way, and then:
```lua
require("coq_3p") {
{ src = "nvimlua", short_name = "nLUA" },
{ src = "vimtex", short_name = "vTEX" },
{ src = "copilot", short_name = "COP", accept_key = "" },
{ src = "codeium", short_name = "COD" },
...
{ src = "demo" },
}
```
`require("coq_3p")` takes a list of `{ src = ..., short_name = ..., ... }` objects.
`src` is required
If `short_name` is not specified, it is uppercase `src`.
The rest of object are specific to each individual source.
## First party
### Included VimScripts
These sources comes with vim / nvim's [default runtime](https://github.com/neovim/neovim/tree/master/runtime/autoload).
Warning: Using these sources might run quite a bit of vimscript code.
```lua
{
{ src = "builtin/ada" },
{ src = "builtin/c" },
{ src = "builtin/clojure" },
{ src = "builtin/css" },
{ src = "builtin/haskell" },
{ src = "builtin/html" },
{ src = "builtin/js" },
{ src = "builtin/php" },
{ src = "builtin/syntax" },
{ src = "builtin/xml" },
}
```
### Shell REPL
```lua
{
src = "repl",
sh = "zsh",
shell = { p = "perl", n = "node", ... },
max_lines = 99,
deadline = 500,
unsafe = { "rm", "poweroff", "mv", ... }
}
```
Evaluates `...`:
```text
`!...`
```
Where `` can be a combination of zero or more of:
- `#` :: comment output
- `-` :: prevent indent
Note: `coq.nvim` has _very short_ deadlines by default for auto completions, manual `` might be required if `$SHELL` is slow.
- sh :: Maybe str :: default repl shell, default to `$SHELL` fallback to `cmd.exe` under NT and `sh` under POSIX
- shell :: Maybe Map 'str, 'str :: For the first word `w` after "\`!", if `w ∈ key of shell`, set `sh = shell[w]`
- max_lines :: int :: max lines to return
- deadline :: int :: max ms to wait for execution
- unsafe :: Seq 'str :: do not start repl with these executables, ie. `rm`, `sudo`, `mv`, etc
### Nvim Lua API
`{ src = "nvimlua", short_name = "nLUA", conf_only = true }`
- conf_only :: Maybe bool :: only return results if current document is relative to `$NVIM_HOME`, default yes
### Scientific calculator
`{ src = "bc", short_name = "MATH", precision = 6 }`
- precision :: Maybe int
requires - [`bc`](https://linux.die.net/man/1/bc)
### Moo
`{ src = "cow", trigger = "!cow" }`
Use **`trigger = "!cow"`** to only show cowsay when you end a line with `!cow`
requires - [`cowsay`](https://linux.die.net/man/1/cowsay)
### Comment Banner
`{ src = "figlet", short_name = "BIG" }`
Use **`trigger = "!big"`** to only show figlet when you end a line with `!big`
Use **`fonts = {"/usr/share/figlet/fonts/standard.flf"}`** specify the list of fonts to choose from
requires - [`figlet`](https://linux.die.net/man/6/figlet)
## Third parties
### [Copilot](https://github.com/github/copilot.vim)
`{ src = "copilot", short_name = "COP", accept_key = "" }`
Hitting `tmp_accept_key` will accept the suggestions once they are shown.
**This is just a quick workaround**, if its at all possible i'd like to remove `tmp_accept_key`, and include copilot suggestions right in the completion popup.
### [Codeium](https://github.com/Exafunction/codeium.vim)
`{ src = "codeium", short_name = "COD" }`
**Can be used at the same time as copilot**
```lua
-- Can't both show ghost texts though
vim.g.codeium_render = false
```
### [Tabby](https://github.com/TabbyML/vim-tabby)
`{ src = "tabby", short_name = "TAB" }`
**Can be used at the same time as copilot and Codeium**
```lua
-- Can't both show ghost texts though
vim.g.codeium_render = false
```
### [VimTex](https://github.com/lervag/vimtex)
`{ src = "vimtex", short_name = "vTEX" }`
### [Orgmode.nvim](https://github.com/kristijanhusak/orgmode.nvim)
`{ src = "orgmode", short_name = "ORG" }`
### [vim-dadbod-completion](https://github.com/kristijanhusak/vim-dadbod-completion)
`{ src = "vim_dadbod_completion", short_name = "DB"}`
### [nvim-dap](https://github.com/mfussenegger/nvim-dap)
`{ src = "dap" }`
Thanks [@davidatbu](https://github.com/davidatbu) <3
---
## FYI
None of the code under `require('coq_3p')` is public API.
From the users' prespective, any change I make should be transparent, ie. I will try to not break their stuff.
For other plugin developers, if you want to re-use my code. Make a COPY, do not just `require "blah"` from this repo.
I reserve the ability to fearlessly re-factor.