[{"result":{"data":[{"id":"47b881d7-a4cf-4e12-92f5-ad0785dc5ad6","title":"feat!: remove config.keymaps","text":"feat!: remove config.keymaps","type":"breaking-change","createdAt":"2023-06-22T22:40:02.088Z","breakingChange":{"id":1,"postId":"47b881d7-a4cf-4e12-92f5-ad0785dc5ad6","pluginId":424,"externalUrl":"https://github.com/lewis6991/gitsigns.nvim/commit/256569c2fe697a3003dbd49ff474e5935af9066c","sha":"256569c2fe697a3003dbd49ff474e5935af9066c","plugin":{"id":424,"owner":"lewis6991","name":"gitsigns.nvim","type":"github","source":"awesome-neovim","category":"git","link":"https://github.com/lewis6991/gitsigns.nvim","shortDescription":"Git integration for buffers","createdAt":"2023-03-22T19:35:21.644Z","readme":"# gitsigns.nvim\n\n[![CI](https://github.com/lewis6991/gitsigns.nvim/workflows/CI/badge.svg?branch=main)](https://github.com/lewis6991/gitsigns.nvim/actions?query=workflow%3ACI)\n[![Version](https://img.shields.io/github/v/release/lewis6991/gitsigns.nvim)](https://github.com/lewis6991/gitsigns.nvim/releases)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Gitter](https://badges.gitter.im/gitsigns-nvim/community.svg)](https://gitter.im/gitsigns-nvim/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)\n\nSuper fast git decorations implemented purely in Lua.\n\n## Preview\n\n| Hunk Actions | Line Blame |\n| --- | ----------- |\n|

|\n\n## Features\n\n- Signs for added, removed, and changed lines\n- Asynchronous using [luv]\n- Navigation between hunks\n- Stage hunks (with undo)\n- Preview diffs of hunks (with word diff)\n- Customizable (signs, highlights, mappings, etc)\n- Status bar integration\n- Git blame a specific line using virtual text.\n- Hunk text object\n- Automatically follow files moved in the index.\n- Live intra-line word diff\n- Ability to display deleted/changed lines via virtual lines.\n- Support for [yadm]\n- Support for detached working trees.\n\n## Requirements\n\n- Neovim >= 0.8.0\n\n **Note:** If your version of Neovim is too old, then you can use a past [release].\n\n **Note:** If you are running a development version of Neovim (aka `master`), then breakage may occur if your build is behind latest.\n\n- Newish version of git. Older versions may not work with some features.\n\n## Installation & Usage\n\nInstall using your package manager of choice.\n\nFor recommended setup with all batteries included:\n```lua\nrequire('gitsigns').setup()\n```\n\nConfiguration can be passed to the setup function. Here is an example with most of\nthe default settings:\n\n```lua\nrequire('gitsigns').setup {\n signs = {\n add = { text = '│' },\n change = { text = '│' },\n delete = { text = '_' },\n topdelete = { text = '‾' },\n changedelete = { text = '~' },\n untracked = { text = '┆' },\n },\n signcolumn = true, -- Toggle with `:Gitsigns toggle_signs`\n numhl = false, -- Toggle with `:Gitsigns toggle_numhl`\n linehl = false, -- Toggle with `:Gitsigns toggle_linehl`\n word_diff = false, -- Toggle with `:Gitsigns toggle_word_diff`\n watch_gitdir = {\n follow_files = true\n },\n attach_to_untracked = true,\n current_line_blame = false, -- Toggle with `:Gitsigns toggle_current_line_blame`\n current_line_blame_opts = {\n virt_text = true,\n virt_text_pos = 'eol', -- 'eol' | 'overlay' | 'right_align'\n delay = 1000,\n ignore_whitespace = false,\n },\n current_line_blame_formatter = ', -

',\n sign_priority = 6,\n update_debounce = 100,\n status_formatter = nil, -- Use default\n max_file_length = 40000, -- Disable if file is longer than this (in lines)\n preview_config = {\n -- Options passed to nvim_open_win\n border = 'single',\n style = 'minimal',\n relative = 'cursor',\n row = 0,\n col = 1\n },\n yadm = {\n enable = false\n },\n}\n```\n\nFor information on configuring Neovim via lua please see [nvim-lua-guide].\n\n### Keymaps\n\nGitsigns provides an `on_attach` callback which can be used to setup buffer mappings.\n\nHere is a suggested example:\n\n```lua\nrequire('gitsigns').setup{\n ...\n on_attach = function(bufnr)\n local gs = package.loaded.gitsigns\n\n local function map(mode, l, r, opts)\n opts = opts or {}\n opts.buffer = bufnr\n vim.keymap.set(mode, l, r, opts)\n end\n\n -- Navigation\n map('n', ']c', function()\n if vim.wo.diff then return ']c' end\n vim.schedule(function() gs.next_hunk() end)\n return ''\n end, {expr=true})\n\n map('n', '[c', function()\n if vim.wo.diff then return '[c' end\n vim.schedule(function() gs.prev_hunk() end)\n return ''\n end, {expr=true})\n\n -- Actions\n map('n', 'hs', gs.stage_hunk)\n map('n', 'hr', gs.reset_hunk)\n map('v', 'hs', function() gs.stage_hunk {vim.fn.line('.'), vim.fn.line('v')} end)\n map('v', 'hr', function() gs.reset_hunk {vim.fn.line('.'), vim.fn.line('v')} end)\n map('n', 'hS', gs.stage_buffer)\n map('n', 'hu', gs.undo_stage_hunk)\n map('n', 'hR', gs.reset_buffer)\n map('n', 'hp', gs.preview_hunk)\n map('n', 'hb', function() gs.blame_line{full=true} end)\n map('n', 'tb', gs.toggle_current_line_blame)\n map('n', 'hd', gs.diffthis)\n map('n', 'hD', function() gs.diffthis('~') end)\n map('n', 'td', gs.toggle_deleted)\n\n -- Text object\n map({'o', 'x'}, 'ih', ':Gitsigns select_hunk')\n end\n}\n```\n\nNote this requires Neovim v0.7 which introduces `vim.keymap.set`. If you are using Neovim with version prior to v0.7 then use the following:\n

Click to expand

\n\n```lua\nrequire('gitsigns').setup {\n ...\n on_attach = function(bufnr)\n local function map(mode, lhs, rhs, opts)\n opts = vim.tbl_extend('force', {noremap = true, silent = true}, opts or {})\n vim.api.nvim_buf_set_keymap(bufnr, mode, lhs, rhs, opts)\n end\n\n -- Navigation\n map('n', ']c', \"&diff ? ']c' : 'Gitsigns next_hunk'\", {expr=true})\n map('n', '[c', \"&diff ? '[c' : 'Gitsigns prev_hunk'\", {expr=true})\n\n -- Actions\n map('n', 'hs', ':Gitsigns stage_hunk')\n map('v', 'hs', ':Gitsigns stage_hunk')\n map('n', 'hr', ':Gitsigns reset_hunk')\n map('v', 'hr', ':Gitsigns reset_hunk')\n map('n', 'hS', 'Gitsigns stage_buffer')\n map('n', 'hu', 'Gitsigns undo_stage_hunk')\n map('n', 'hR', 'Gitsigns reset_buffer')\n map('n', 'hp', 'Gitsigns preview_hunk')\n map('n', 'hb', 'lua require\"gitsigns\".blame_line{full=true}')\n map('n', 'tb', 'Gitsigns toggle_current_line_blame')\n map('n', 'hd', 'Gitsigns diffthis')\n map('n', 'hD', 'lua require\"gitsigns\".diffthis(\"~\")')\n map('n', 'td', 'Gitsigns toggle_deleted')\n\n -- Text object\n map('o', 'ih', ':Gitsigns select_hunk')\n map('x', 'ih', ':Gitsigns select_hunk')\n end\n}\n```\n\n

\n\n## Non-Goals\n\n### Implement every feature in [vim-fugitive]\n\nThis plugin is actively developed and by one of the most well regarded vim plugin developers.\nGitsigns will only implement features of this plugin if: it is simple, or, the technologies leveraged by Gitsigns (LuaJIT, Libuv, Neovim's API, etc) can provide a better experience.\n\n### Support for other VCS\n\nThere aren't any active developers of this plugin who use other kinds of VCS, so adding support for them isn't feasible.\nHowever a well written PR with a commitment of future support could change this.\n\n## Status Line\n\nUse `b:gitsigns_status` or `b:gitsigns_status_dict`. `b:gitsigns_status` is\nformatted using `config.status_formatter`. `b:gitsigns_status_dict` is a\ndictionary with the keys `added`, `removed`, `changed` and `head`.\n\nExample:\n```viml\nset statusline+=%{get(b:,'gitsigns_status','')}\n```\n\nFor the current branch use the variable `b:gitsigns_head`.\n\n## Comparison with [vim-gitgutter]\n\nFeature | gitsigns.nvim | vim-gitgutter | Note\n---------------------------------------------------------|----------------------|-----------------------------------------------|--------\nShows signs for added, modified, and removed lines | :white_check_mark: | :white_check_mark: |\nAsynchronous | :white_check_mark: | :white_check_mark: |\nRuns diffs in-process (no IO or pipes) | :white_check_mark: * | | * Via [lua](https://github.com/neovim/neovim/pull/14536) or FFI.\nSupports Nvim's diff-linematch | :white_check_mark: * | | * Via [diff-linematch]\nOnly adds signs for drawn lines | :white_check_mark: * | | * Via Neovims decoration API\nUpdates immediately | :white_check_mark: | * | * Triggered on CursorHold\nEnsures signs are always up to date | :white_check_mark: * | | * Watches the git dir to do so\nNever saves the buffer | :white_check_mark: | :white_check_mark: :heavy_exclamation_mark: * | * Writes [buffer](https://github.com/airblade/vim-gitgutter/blob/0f98634b92da9a35580b618c11a6d2adc42d9f90/autoload/gitgutter/diff.vim#L106) (and index) to short lived temp files\nQuick jumping between hunks | :white_check_mark: | :white_check_mark: |\nStage/reset/preview individual hunks | :white_check_mark: | :white_check_mark: |\nPreview hunks directly in the buffer (inline) | :white_check_mark: * | | * Via `preview_hunk_inline`\nStage/reset hunks in range/selection | :white_check_mark: | :white_check_mark: :heavy_exclamation_mark: * | * Only stage\nStage/reset all hunks in buffer | :white_check_mark: | |\nUndo staged hunks | :white_check_mark: | |\nWord diff in buffer | :white_check_mark: | |\nWord diff in hunk preview | :white_check_mark: | :white_check_mark: |\nShow deleted/changes lines directly in buffer | :white_check_mark: * | | * Via [virtual lines]\nStage partial hunks | :white_check_mark: | |\nHunk text object | :white_check_mark: | :white_check_mark: |\nDiff against index or any commit | :white_check_mark: | :white_check_mark: |\nFolding of unchanged text | | :white_check_mark: |\nFold text showing whether folded lines have been changed | | :white_check_mark: |\nLoad hunk locations into the quickfix or location list | :white_check_mark: | :white_check_mark: |\nOptional line highlighting | :white_check_mark: | :white_check_mark: |\nOptional line number highlighting | :white_check_mark: | :white_check_mark: |\nOptional counts on signs | :white_check_mark: | |\nCustomizable signs and mappings | :white_check_mark: | :white_check_mark: |\nCustomizable extra diff arguments | :white_check_mark: | :white_check_mark: |\nCan be toggled globally or per buffer | :white_check_mark: * | :white_check_mark: | * Through the detach/attach functions\nStatusline integration | :white_check_mark: | :white_check_mark: |\nWorks with [yadm] | :white_check_mark: | |\nLive blame in buffer (using virtual text) | :white_check_mark: | |\nBlame preview | :white_check_mark: | |\nAutomatically follows open files moved with `git mv` | :white_check_mark: | |\nCLI with completion | :white_check_mark: | * | * Provides individual commands for some actions\nOpen diffview with any revision/commit | :white_check_mark: | |\n\nAs of 2022-09-01\n\n## Integrations\n\n### [vim-fugitive]\n\nWhen viewing revisions of a file (via `:0Gclog` for example), Gitsigns will attach to the fugitive buffer with the base set to the commit immediately before the commit of that revision.\nThis means the signs placed in the buffer reflect the changes introduced by that revision of the file.\n\n### [trouble.nvim]\n\nIf installed and enabled (via `config.trouble`; defaults to true if installed), `:Gitsigns setqflist` or `:Gitsigns seqloclist` will open Trouble instead of Neovim's built-in quickfix or location list windows.\n\n### [lspsaga.nvim]\n\nIf you are using lspsaga.nvim you can config `code_action.extend_gitsigns` (default is true) to show the gitsigns action in lspsaga codeaction.\n\n## Similar plugins\n\n- [coc-git]\n- [vim-gitgutter]\n- [vim-signify]\n\n\n[coc-git]: https://github.com/neoclide/coc-git\n[diff-linematch]: https://github.com/neovim/neovim/pull/14537\n[luv]: https://github.com/luvit/luv/blob/master/docs.md\n[nvim-lua-guide]: https://github.com/nanotee/nvim-lua-guide\n[release]: https://github.com/lewis6991/gitsigns.nvim/releases\n[trouble.nvim]: https://github.com/folke/trouble.nvim\n[vim-fugitive]: https://github.com/tpope/vim-fugitive\n[vim-gitgutter]: https://github.com/airblade/vim-gitgutter\n[vim-signify]: https://github.com/mhinz/vim-signify\n[virtual lines]: https://github.com/neovim/neovim/pull/15351\n[yadm]: https://yadm.io\n[lspsaga.nvim]: https://github.com/glepnir/lspsaga.nvim\n","dotfyleShieldAddedAt":null,"stars":3535,"lastSyncedAt":"2023-09-26T02:13:51.573Z","addedLastWeek":2}}}]}}]