Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Gnarus-G/mynd
A todo app, in the terminal, or with a GUI. Simple and Frictionless.
https://github.com/Gnarus-G/mynd
cli language-server-protocol neovim rust svelte tauri todolist
Last synced: 3 months ago
JSON representation
A todo app, in the terminal, or with a GUI. Simple and Frictionless.
- Host: GitHub
- URL: https://github.com/Gnarus-G/mynd
- Owner: Gnarus-G
- License: gpl-2.0
- Created: 2023-07-03T01:17:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-03T02:25:51.000Z (4 months ago)
- Last Synced: 2024-07-04T22:12:38.245Z (4 months ago)
- Topics: cli, language-server-protocol, neovim, rust, svelte, tauri, todolist
- Language: Rust
- Homepage:
- Size: 738 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tauri - mynd - Quick and very simple todo-list management app for developers that live mostly in the terminal. (Applications / Productivity)
README
# mynd
_Yet another todo app_.
A [very] simple todo list management cli tool for developers, with an optional gui. The fastest way I've found to go from needing to write something quickly (i.e during a meeting)
to having it written down.
## Edit in the terminal
## Edit in an editor (e.g Neovim with language server)
## Edit in the GUI
## Features
- [x] Simple GUI
- [x] CLI for efficiency
- [x] Local Persistence Option
- [x] Soft Delete Done Items
- [x] Permanent Deletion (Drap-n-drop to trash bin)
- [x] Todo Language & LSP
- [ ] Remind Command: /r (Desktop Notifications)
- [ ] Remote Persistence Option
## Install (Linux only)
### Recommended Option
```sh
curl -fsSL https://raw.githubusercontent.com/Gnarus-G/mynd/main/install.sh | sh
```
This depends on you having installed [bun](https://bun.sh/) and [rust](https://doc.rust-lang.org/cargo/getting-started/installation.html); `git` as well, but you
probably already have that.
### Other Options
Find the executables in the [releases](https://github.com/Gnarus-G/mynd/releases).
## Usage
### CLI
At any point you can pull up your terminal and add a todo item like so.
```sh
todo "todo message"
```
or, to launch your default editor [$EDITOR].
```sh
todo
```
Note: This option [editor] is only viable with the lsp integration.
### GUI
Start up the GUI.
```sh
todo gui
```
Or just call `mynd` directly, which is what `todo gui` does.
Very convenient when your manager is rapping requirements at you during a meeting.
```
Usage: todo [MESSAGE] [COMMAND]
Commands:
done Mark one or more todo items as done
rm Delete a todo item, regardless of if it's done or not
ls List all todos that aren't done
gui Launch the GUI (mynd). Assuming it's in the path
import Read and save todos from a given file
edit Edit the todo list in your default editor ($EDITOR) [default]
dump Dump all todos as json
config Manage global configuration values
lsp Start the language server
help Print this message or the help of the given subcommand(s)
Arguments:
[MESSAGE] What to do
Options:
-h, --help Print help
-V, --version Print version
```
## Syntax Highlighting (Neovim)
There is a treesitter grammar for the `todo` syntax.
To setup syntax Highlighting in Neovim, see [tree-sitter-todolang](https://github.com/Gnarus-G/tree-sitter-todolang)
## Lsp setup
I doubt this language server will ever land into `neovim/nvim-lspconfig`, so here's an example
of my lsp config setup.
```lua
local nvim_lsp = require("lspconfig");
local configs = require 'lspconfig.configs'
if not configs.todols then
configs.todols = {
default_config = {
cmd = { "todo", "lsp" },
filetypes = { "todolang" },
},
}
end
nvim_lsp.todols.setup({
on_attach = on_attach, --[[your on_attach function goes here]]
single_file_support = true,
--[[ capabilities = ... -- your capabilities here ]]
})
```
For codelens support in Neovim; Set it up so the codelenses refresh often, and have a convenient
shortcut for running codelenses.
```lua
local codelens_augroup = vim.api.nvim_create_augroup("todols:codeLenses", { clear = true })
vim.api.nvim_create_autocmd('LspAttach', {
desc = 'Sets up todols codelens autocommands',
pattern = { "*.td", "*.todo" },
group = codelens_augroup,
callback = function(event)
vim.api.nvim_create_autocmd({ 'CursorHold', 'BufEnter', 'InsertLeave' }, {
group = codelens_augroup,
buffer = event.buf,
callback = function()
vim.lsp.codelens.refresh({ bufnr = event.buf })
end
})
vim.api.nvim_create_autocmd('LspDetach', {
group = codelens_augroup,
buffer = event.buf,
callback = function(e)
vim.lsp.codelens.clear(e.data.client_id, e.buf)
end
})
-- If this action (codelens.run) is not already bound to a key.
-- i.e you don't already a keymap for running codelenses
vim.keymap.set('n', 'lr', vim.lsp.codelens.run, { buffer = event.buf, remap = false })
end
})
```
## Dev References
https://github.com/tauri-apps/tauri-docs/blob/8cdc0505ffb9e78be768a0216bd91980306206a5/docs/guides/distribution/sign-android.md
https://github.com/neovim/neovim/pull/13165
https://github.com/ray-x/navigator.lua/blob/master/lua/navigator/lspwrapper.lua#L122