Skip to content

A Neovim plugin that leverages Telescope to display files from `git status`, providing a quick view of your current working files.

License

Notifications You must be signed in to change notification settings

victorvf/simple-git-status.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Simple Git Status

A Neovim plugin that leverages Telescope to display files from git status, providing a quick view of your current working files.

Image

Installation

Requirements

Using packer.nvim:

use {
  'victorvf/simple-git-status.nvim',
  requires = {'nvim-telescope/telescope.nvim'}
}

Using lazy.nvim:

{
  'victorvf/simple-git-status.nvim',
  dependencies = {'nvim-telescope/telescope.nvim'},
  config = function()
    require('git_files').setup()
  end
}

Using vim-plug:

Plug 'nvim-telescope/telescope.nvim'
Plug 'vicorvf/simple-git-status.nvim'

Usage

By default, the plugin maps:

  • <leader>gs - Opens the Telescope picker with Git Status files

Select any file to open it, or use Telescope's standard features to preview, filter, and navigate through files.

Configuration

The plugin works right out of the box, but you can customize it:

require('git_files').setup({
  -- Change default mappings
  mappings = {
    git_status = "<leader>gf", -- Change from <leader>gs to what you prefer
  },
  
  -- Completely disable default mappings
  setup_mappings = false, -- To set your own mappings
})

Setting up mappings manually

If you've disabled default mappings, you can set your own:

-- First disable default mappings
require('git_files').setup({
  setup_mappings = false
})

-- Then define your own mappings
vim.api.nvim_set_keymap('n', '<leader>gs', "<cmd>lua require('git_files').git_status()<CR>", { noremap = true })

-- Or
nnoremap <leader>gs <cmd>lua require('git_files').git_status()<CR>

Contributing

Contributions are welcome! Feel free to open issues or pull requests to improve the plugin.

License

MIT

About

A Neovim plugin that leverages Telescope to display files from `git status`, providing a quick view of your current working files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published