Providing a Language Server (LSP)

[mickael-menu]

zk can provide a basic integration with any LSP-compatible text editor by shipping a Language Server.

PR #21 implements a proof of concept server showing promising results, but there's more to come:

• Links

  • [x] Auto-complete internal Markdown links with [[
  • [x] Auto-complete the path portion of a Markdown link with [custom title]((
  • [x] User configuration to specify the link format using a template
  • [x] Open a note from an inline Markdown link or WikiLink (document link when supported and go to definition as an alternative)
  • [x] Open a website from an inline external Markdown link (with textDocument/documentLink)
  • [x] Open a reference link
  • [ ] Move the caret to the next link in the note with a code action, for quick navigation (with window.showDocument)
  • [x] Preview the content of a linked note with a hover
  • [x] Diagnostic (error) to show dead links
  • [x] Diagnostic (hint) to show the title of a linked note next to the link
  • [x] Browse backlinks with find references
  • [ ] Browse backlinks / outbound links with a tree-like call hierarchy (client support is still lacking)
  • [ ] Highlight WikiLinks using semantic tokens (client support is still lacking)
  • [ ] (Maybe?) Report DocumentLink for unlinked mentions, using aliases metadata

• Tags

  • [x] Auto-complete tags with # and : trigger characters
  • [ ] Rename a tag with a refactor code action
  • [ ] Highlight tags using semantic tokens (client support is still lacking)
  • [ ] View the list of all the notes for a particular tag when running the References action.

• Notes

  • [x] Code action to create (and link) a new note using the current selection as its title
  • [ ] Code action to create (and link) a new note using the current selection as its content (refactor.extract?)
  • [ ] Code action to rename the note title
  • [ ] User configuration to declare dynamic code actions to generate notes with custom group / template
  • [ ] Snippet support using zk templates

• Expose zk commands as LSP commands, for easy client-side consumption

  • [ ] zk.init to create a new notebook
  • [x] zk.index to index a notebook manually
  • [x] zk.new to create a new note
  • [x] zk.list to search for notes (returning a JSON)
  • [x] zk.tag.list to return the list of tags
  • [ ] zk.info to provide detailed JSON metadata about a notebook (list of groups, templates, dirs, etc.)

• Other

  • [ ] Optimizations for large (10k+) notebooks (esp. completion)

Feel free to share more ideas!

[WhiskeyJack96]

Any thoughts on adding TODO support for autocomplete and code actions for switching TODO to DONE? I'd be happy to put up a pr giving it a shot if you'd be interested!

[mickael-menu]

@WhiskeyJack96 IMO this is out of scope for zk. It would be more suited for a task manager plugin.

This discussion could be relevant: https://github.com/mickael-menu/zk-nvim/discussions/88

[WhiskeyJack96]

@mickael-menu yeah I can see that, is there any plan for or existing/method to extend zk? my workflow currently revolves around using logseq for and then editting my journal notes with Helix in the terminal during work (but helix doesnt currently support plugins or multiple lsps per filetype).

[mickael-menu]

@WhiskeyJack96 I don't think zk will have a plugin system for arbitrary code actions. Sounds like an issue with Helix, that it doesn't support plugins.

However, if you're willing to put in the work, you could just fork zk. Another alternative would be to create your own "composite" LSP server with custom actions and delegating the rest to the zk LSP server. zk is using https://github.com/tliron/glsp under the hood.

[pr4th4m]

Any plans to support textDocument/documentSymbol ?

[dotrosedotnet]

I'm getting

Error executing vim.schedule lua callback: ...w/Cellar/neovim/0.9.5/share/nvim/runtime/lua/vim/lsp.l
ua:1308: RPC[Error] code_name = InvalidParams, message = "Invalid params"
stack traceback:
        [C]: in function 'assert'
        ...w/Cellar/neovim/0.9.5/share/nvim/runtime/lua/vim/lsp.lua:1308: in function ''
        vim/_editor.lua: in function <vim/_editor.lua:0>

nvim --version gives me:

NVIM v0.9.5
Build type: Release
LuaJIT 2.1.1710088188

   system vimrc file: "$VIM/sysinit.vim"
  fall-back for $VIM: "/opt/homebrew/Cellar/neovim/0.9.5/share/nvim"

I installed via homebrew on an m3. Any ideas?

EDIT:

I think this was due to me using the markdown_oxide lsp server, which not only seemed buggy, but would try to run a bunch of html for a russian website in nvim, so...

I'm using marksman now as my lsp server, and everything seems alright.

[WhyNotHugo]

Highlight tags using semantic tokens (client support is still lacking)

Neovim has client support for this and it would be pretty useful.