Sourcer (α)

Source code is the best documentation; source-dive right from within your editor.

Requirements

• Neovim >= 0.10.0
• Git
• Github's CLI (gh)
• Plenary.nvim
• Telescope.nvim
• Fidget.nvim

Note

Most of these requirements will be shaved off in the future.

Installation

Install the plugin with your preferred package manager (feel free to PR more package managers):

Lazy.nvim (folke/lazy.nvim)

{
  'joaomendoncaa/sourcer.nvim',

  opts = {
    -- You can choose the prefix for the main command
    prefix = 'Sourcer', -- default

    -- You can choose multiple methods on how the source code is opened. 
    -- There's several options: 
    -- {'split', 'vsplit', 'tab', 'floating', 'tmux-window', 'tmux-session'}
    method = 'tmux-window', -- default
    -- With [switch] you can define if the method you chose is launched 
    -- in a detached manner, or you automatically jump to it
    switch = true,

    -- Provide a custom directory for the source code to be stored,
    -- or leave `nil` to use the system's temporary directory
    dir = nil,
}

Roadmap

• View source locally
  • Tmux window
  • Tmux session
  • Floating
  • New tab
  • Splits
• Search by repositories
• Search by code
• Search by commits
• User space support for custom previewers rendering with things like render-markdown.nvim
• Gradually kill dependencies
  • Neovim >= 0.10.0
  • Github's cli
    • explore using github's API + git access token
    • implement it
  • Plenary.nvim
    • Port all async and process spawning to vim's APIs
  • Telescope.nvim
    • think of an adapter design to easily plug into any display mechanism
    • implement it
  • Fidget.nvim
    • wrapper that falls back to vim.notify