coc-git 2.7.6 → 2.7.8

package/AGENTS.md

@@ -0,0 +1,60 @@
+# AGENTS.md
+
+## Repository purpose
+
+`coc-git` is the Git integration extension for `coc.nvim`. Its runtime entry point is `src/index.ts`; the published entry point is the bundled `lib/index.js`. The extension owns Git-backed buffer state, gutters and blame text, conflict actions, Coc lists, GitHub/GitLab issue completion, and the commands/keymaps declared in `package.json`.
+
+## Code map
+
+- `src/index.ts` is the activation and registration layer. Register new Coc commands, `<Plug>` keymaps, lists, completion providers, and disposables here.
+- `src/manager.ts` coordinates editor events, live `GitBuffer` instances, configuration, and user-facing operations.
+- `src/model/git.ts` is the low-level child-process wrapper around the configured Git executable.
+- `src/model/repo.ts` implements repository-scoped Git operations; put Git command construction and output parsing there rather than in the activation layer.
+- `src/model/resolver.ts` resolves documents and working directories to repositories and relative paths.
+- `src/model/buffer.ts` owns per-buffer diffs, signs, blame, folds, and conflict state.
+- `src/model/service.ts` owns resolver/repository lifetimes and constructs `GitBuffer` instances.
+- `src/lists/` contains Coc list implementations (`gstatus`, `gfiles`, `gchanges`, `gchunks`, `branches`, `commits`, and `bcommits`). List-specific actions and rendering belong in the corresponding list class.
+- `src/source.ts` implements GitHub/GitLab issue loading plus the `issues` list/completion source.
+- `src/types.ts` is the shared contract for diffs, conflicts, and the configuration object passed into buffer/model code.
+- `package.json` is also the Coc extension manifest: command names, activation, and all user-visible configuration schemas live there.
+- `Readme.md` documents the public commands, keymaps, lists, environment variables, and settings.
+
+## Public-contract synchronization
+
+When changing a user-facing feature, update every surface that represents the same contract:
+
+- A new `git.*` command needs a `commands.registerCommand` registration in `src/index.ts` and an entry under `contributes.commands` in `package.json`. Add it to `Readme.md` when it is intended for direct use.
+- A new `<Plug>(coc-git-...)` mapping needs a `workspace.registerKeymap` registration in `src/index.ts` and matching usage documentation in `Readme.md`.
+- A new `git.*` setting needs a schema entry under `contributes.configuration.properties` in `package.json`, a typed field in `src/types.ts` when consumed beyond the registration layer, and loading/default logic in `DocumentManager.loadConfiguration()` in `src/manager.ts`. Keep defaults identical across those locations and `Readme.md`.
+- A new list must be implemented under `src/lists/`, registered through `listManager` in `src/index.ts`, and added to the documented list names.
+- Preserve the exported `ExtensionApi` shape in `src/index.ts` unless the API change is intentional; other Coc extensions can consume `git`, `resolver`, and `manager` from activation.
+
+## Git and editor behavior
+
+- Use the configured executable discovered from `git.command`; do not hard-code an executable path. Model-layer Git execution should flow through `Git`, `GitRepo`, or the existing command helpers.
+- Keep Git work asynchronous. Do not introduce synchronous child-process calls into buffer refresh, cursor movement, completion, or list loading paths.
+- Pass arguments as arrays to `Git.exec`, `Git.stream`, or `spawnCommand` when filenames or revisions are involved. The repository already supports paths containing spaces; avoid building an unescaped shell string unless the operation specifically requires an interactive terminal command.
+- Preserve cancellation and disposal behavior around spawned processes and Coc event listeners. Anything registered during activation or manager construction must be owned by the existing `subscriptions`/`disposables` lifecycle.
+- Buffer refreshes are event-driven (`TextChange`, writes when realtime gutters are disabled, `FocusGained`, and `BufEnter`). Changes to diff or blame behavior must account for stale async results and for buffers disposed while repository resolution is still running.
+- Keep Vim and Neovim compatibility. Virtual text, floating windows, namespaces, terminal operations, and popup behavior must retain the existing capability checks or Coc abstractions; do not use a Neovim-only API on an unconditional path.
+- Git output is normalized under `LC_ALL`/`LANG=en_US.UTF-8` and decoded through `iconv-lite`. Parsing code must not depend on the user's localized Git messages.
+- GitHub issue access uses `GITHUB_API_TOKEN`; GitLab access uses `GITLAB_PRIVATE_TOKEN` and `git.gitlab.hosts`. Do not log tokens or put them into rendered list/completion items.
+
+## Generated output and dependencies
+
+- Do not edit or commit `lib/index.js`; `lib/` is generated and ignored. Change TypeScript under `src/` and rebuild it with `npm run build`.
+- `esbuild.js` must continue to bundle `src/index.ts` for Node while leaving `coc.nvim` external. The bundle target is `node10.12`; avoid emitting runtime syntax or APIs that violate that target unless the target is deliberately raised.
+- Use npm for dependency and lockfile changes. CI installs with `npm ci`, so `package.json` and `package-lock.json` must stay synchronized.
+- `npm run lint` is TypeScript checking (`tsc -p tsconfig.json`), not an ESLint formatting pass. The project enables `noUnusedLocals` and emits nothing during this check.
+
+## Verification
+
+Run checks according to the affected subsystem:
+
+- Type/config/registration changes: `npm run lint` and `npm run build`.
+- Git parsing, repository, buffer, manager, list, source, command, or keymap behavior: `npm test`.
+- Vim-specific behavior: `npm run test:integration:vim`.
+- Neovim-specific behavior: `npm run test:integration:nvim`.
+- Changes intended to pass CI must succeed in both editor variants. The GitHub Actions matrix uses Node 22 and runs typechecking plus the Vim and Neovim integration suites.
+
+For manual editor verification, load the rebuilt extension through Coc and exercise the exact public surface changed: the relevant `:CocCommand git.*`, `<Plug>(coc-git-*)` mapping, `:CocList` list, gutter/blame update, conflict action, or issue completion flow. Use a temporary Git repository containing the required staged, unstaged, untracked, renamed, conflicted, or non-UTF-8-path state rather than testing against this checkout's working tree.

package/Readme.md

@@ -1,5 +1,7 @@
 # coc-git
 
+[![CI](https://github.com/neoclide/coc-git/actions/workflows/ci.yaml/badge.svg)](https://github.com/neoclide/coc-git/actions/workflows/ci.yaml)
+
 Git integration of [coc.nvim](https://github.com/neoclide/coc.nvim).
 
 **Note:** many useful features not implemented, it's recommended to
@@ -27,7 +29,7 @@ In your vim/neovim, run command:
 - Git status of current project, by `g:coc_git_status`.
 - Git status of current buffer, by`b:coc_git_status`.
 - Git status of current line, by`b:coc_git_blame` for statusline, and `addGBlameToVirtualText` for inline blames.
-- Git related lists, including `issues`, `gfiles`, `gstatus`, `commits`, `branches` & `bcommits`
+- Git related lists, including `issues`, `gfiles`, `gstatus`, `gchanges`, `gchunks`, `commits`, `branches` & `bcommits`
 - Keymaps for git chunks, including `<Plug>(coc-git-chunkinfo)` `<Plug>(coc-git-nextchunk)` & `<Plug>(coc-git-prevchunk)` ,
 - Commands for chunks, including `git.chunkInfo` `git.chunkStage` `git.chunkUndo` and more.
 - Keymaps & commands for git conflicts.
@@ -60,14 +62,20 @@ In your vim/neovim, run command:
 
 - `git.urlFix`: a object to configure the url style of copyUrl and browserOpen, make this two command support other git services like gitlab and gitea. default: `{}`
 
+- `git.diffRevision`: Revision used as the gutter diff base, default: `""` (the current index).
+
 - `git.issueFormat`: Formatting string for issue completion. Supported interpolation variables: %i - issue id. %r - repository name. %o - organization/owner name. %t - issue title. %b - issue body. %c - issue created at. %a - issue author. %u - issue url., default: `"#%i"`
 
 - `git.virtualTextPrefix`: Prefix of git blame infomation to virtual text, require virtual text feature of neovim., default: `" "`
 
+- `git.blameFormat`: Format of git blame virtual text. Supported placeholders: `%a` author, `%t` time, `%s` summary, `%S` short sha, `%%` literal percent., default: `"(%a %t) %s"`
+
 - `git.addGBlameToVirtualText`: Add git blame information to virtual text, require virtual text feature of neovim., default: `false`
 
 - `git.addGBlameToBufferVar`: Add git blame information to b:coc_git_blame., default: `false`
 
+- `git.blameUseRealTime`: Use an absolute local timestamp in blame information, default: `false`.
+
 - `git.branchCharacter`: Branch character used with g:coc_git_status, default: `""`
 
 - `git.changedDecorator`: Git changed decorator used with g:coc_git_status, default: `"*"`
@@ -86,6 +94,8 @@ In your vim/neovim, run command:
 
 - `git.signPriority`: Priority of sign gutters, default to `10`.
 
+- `git.pushArguments`: Additional arguments passed to `git push`, default: `[]`.
+
 - `git.changedSign.text`: Text of changed sign., default: `"~"`
 
 - `git.changedSign.hlGroup`: Highlight group for changed sign., default: `"DiffChange"`
@@ -114,7 +124,7 @@ In your vim/neovim, run command:
 
 - `git.showCommitInFloating`: Show commit in floating or popup window, default: `false`
 
-- `git.floatConfig`: Configure style of float window/popup, extends from floatFactory.floatConfig
+- `git.floatConfig`: Configure style of float window/popup, extends from floatFactory.floatConfig, default: `{}`.
 
 - `git.gitlab.hosts`: Custom GitLab hosts, default: `["gitlab.com"]`
 
@@ -124,6 +134,20 @@ In your vim/neovim, run command:
 
 - `git.conflict.incoming.hlGroup`: Highlight group for the incoming version of a merge conflict., default: `"DiffAdd"`
 
+- `git.conflict.common.hlGroup`: Highlight group for diff3 common-ancestor sections, default: `"DiffText"`.
+
+- `git.gstatus.saveBeforeOpen`: Save open buffers before loading the `gstatus` list, default: `false`.
+
+- `coc.source.issues.enable`: Enable issue completion, default: `true`.
+
+- `coc.source.issues.triggerCharacters`: Trigger characters for issue completion, default: `["#"]`.
+
+- `coc.source.issues.priority`: Issue completion priority, default: `99`.
+
+- `coc.source.issues.shortcut`: Issue completion menu shortcut, default: `"[I]"`.
+
+- `coc.source.issues.filetypes`: Filetypes where issue completion is active, default: `["gitcommit", "gina-commit"]`.
+
 more information, see [package.json](https://github.com/neoclide/coc-git/blob/master/package.json)
 
 **Note** for user from [vim-gitgutter](https://github.com/airblade/vim-gitgutter),
@@ -202,10 +226,16 @@ nmap ]g <Plug>(coc-git-nextchunk)
 " navigate conflicts of current buffer
 nmap [c <Plug>(coc-git-prevconflict)
 nmap ]c <Plug>(coc-git-nextconflict)
+" resolve the conflict under the cursor
+nmap <leader>cc <Plug>(coc-git-keepcurrent)
+nmap <leader>ci <Plug>(coc-git-keepincoming)
+nmap <leader>cb <Plug>(coc-git-keepboth)
 " show chunk diff at current position
 nmap gs <Plug>(coc-git-chunkinfo)
 " show commit contains current position
 nmap gc <Plug>(coc-git-commit)
+" show blame details for the current line
+nmap gb <Plug>(coc-git-showblamedoc)
 " create text object for git chunks
 omap ig <Plug>(coc-git-chunk-inner)
 xmap ig <Plug>(coc-git-chunk-inner)
@@ -219,14 +249,21 @@ Use command `:CocCommand` to open commands and type `git.` to get all git
 related commands.
 
 - `:CocCommand git.copyUrl` Copy url of current line to clipboard.
+- `:CocCommand git.copyPermalink` Copy a permalink for the current line to clipboard.
+- `:CocCommand git.refresh` Refresh Git information for all buffers.
 - `:CocCommand git.nextChunk` Navigate to the next chunk.
 - `:CocCommand git.prevChunk` Navigate to the previous chunk.
 - `:CocCommand git.chunkInfo` Show chunk info under cursor.
+- `:CocCommand git.allChunkInfo` Return all changed chunks in the current buffer.
+- `:CocCommand git.keepCurrent` Keep the current part of the conflict under the cursor.
+- `:CocCommand git.keepIncoming` Keep the incoming part of the conflict under the cursor.
+- `:CocCommand git.keepBoth` Keep both parts of the conflict under the cursor.
 - `:CocCommand git.chunkUndo` Undo current chunk.
 - `:CocCommand git.chunkStage` Stage current chunk.
 - `:CocCommand git.chunkUnstage` Unstage chunk that contains current line.
 - `:CocCommand git.diffCached` Show cached diff in preview window.
 - `:CocCommand git.showCommit` Show commit of current chunk.
+- `:CocCommand git.showBlameDoc` Show blame details for the current line.
 - `:CocCommand git.browserOpen` Open current line in browser
 - `:CocCommand git.foldUnchanged` Fold unchanged lines of current buffer.
 - `:CocCommand git.toggleGutters` Toggle git gutters in sign column.

package/history.md

@@ -0,0 +1,12 @@
+## 2.7.8
+
+- use node24 for CI (eacd2a2)
+- fix uuid, use commonjs version (8ab1a44)
+- fix: narrow vim call results (b72ad90)
+- fix package.json (45b1873)
+- add release.yml (3e68338)
+- fix: address audit findings (e767896)
+- feat: add git.allChunkInfo command for all chunk info (fixes #204) (43469d2)
+- feat: support configurable git blame format (fixes #127) (31e369b)
+- chore: add coc-test integration tests and upgrade toolchain (b10f485)
+- fix: correct warning message typo (PR #222) (f66c361)