coc-git 2.7.9 → 2.7.11

package/AGENTS.md

@@ -0,0 +1,61 @@
+# 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/LICENCE

@@ -0,0 +1,19 @@
+Copyright 2026 chemzqm@gmail.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/Readme.md

@@ -26,6 +26,7 @@ In your vim/neovim, run command:
 - Always refresh on TextChange.
 - Powerful list support.
 - Semantic commit and github issues completion support.
+- Undo, stage & unstage change chunk under current cursor.
 
 ## Features
 
@@ -39,6 +40,7 @@ In your vim/neovim, run command:
 - Keymaps & commands for git conflicts.
 - Completion support for semantic commit.
 - Completion support for GitHub/GitLab issues.
+- Browse files changed by any commit in a read-only `Commit Files` TreeView.
 
 **Note** for GitHub issues completion support:
 
@@ -148,6 +150,10 @@ In your vim/neovim, run command:
 
 - `git.showCommitInFloating`: Show commit in floating or popup window, default: `false`
 
+- `git.commitFiles.splitCommand`: Command used to open the changed-files TreeView for a commit, default: `"belowright 40vs"`
+
+- `git.statusTree.splitCommand`: Command used to open the Git status TreeView, default: `"belowright 40vs"`
+
 - `git.floatConfig`: Configure style of float window/popup, extends from floatFactory.floatConfig, default: `{}`.
 
 - `git.gitlab.hosts`: Custom GitLab hosts, default: `["gitlab.com"]`
@@ -275,6 +281,7 @@ 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.statusTree` Open files reported by Git status in a TreeView. File nodes show staged and unstaged status; opening a file jumps to its first changed line when Git can determine one.
 - `:CocCommand git.nextChunk` Navigate to the next chunk.
 - `:CocCommand git.prevChunk` Navigate to the previous chunk.
 - `:CocCommand git.chunkInfo` Show chunk info under cursor.
@@ -287,6 +294,7 @@ related commands.
 - `: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.showCommitTree` Open the commit associated with the current tracked line in the `Commit Files` TreeView, show the historical file, and jump to its blamed line.
 - `: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.
@@ -311,6 +319,56 @@ To move up&down on insertmode, use `<C-j>` and `<C-k>`
 
 To run a action, press `<tab>` and select the action.
 
+#### Commit Files TreeView
+
+The `commits` and `bcommits` lists provide a `changes` action that opens the
+selected commit in the `Commit Files` TreeView. The existing `files` action
+continues to open the complete file snapshot through the `gfiles` list.
+
+The tree compares an ordinary commit with its parent and an initial commit with
+the empty tree. Merge commits use the first parent by default; choose
+`Select parent…` from the root node actions to compare another parent. The root
+node starts expanded, and pressing `<CR>` on it runs `Show commit`. Pressing
+`<CR>` on a directory toggles it, while pressing `<CR>` on a file runs
+`Show code`.
+
+`Show code`, `Open before version`, `Open after version`, and
+`Open working tree file` open in the editor window that was active before the
+TreeView. For a text file, `Show code` opens a read-only
+`coc-git://<commit>/<path>` buffer with `buftype=nofile` and detects the
+filetype from its path. Added lines use the `DiffAdd` background, and deleted
+lines are rendered as virtual text using `DiffDelete`. Deleted files open their
+complete parent version; binary and non-blob entries show object metadata
+instead of text decorations.
+
+Use `<Plug>(coc-git-nextchunk)`, `<Plug>(coc-git-prevchunk)`, `git.nextChunk`,
+or `git.prevChunk` to navigate changed blocks in a `coc-git://` buffer. The
+navigation wraps when Vim's `wrapscan` option is enabled.
+
+When the buffer that opened the TreeView is one of the changed files, its
+parent directories are expanded and the file is focused. `git.showCommitTree`
+also opens that file's historical code automatically and places the cursor on
+the original line reported by `git blame`. The command reports the existing
+untracked or uncommitted-line warning when Git cannot associate the current
+line with a commit.
+
+Use `git.commitFiles.splitCommand` to configure how the TreeView split opens.
+
+#### Git Status TreeView
+
+Use `:CocCommand git.statusTree` to display staged, unstaged, conflicted, and
+untracked files grouped by directory. Each file shows Git's two-column status
+and a readable staged/unstaged description. Press `<CR>` on a file to open its
+working-tree version in the previous editor window. For tracked files, the
+cursor moves to the first changed line when Git provides a diff location;
+otherwise it opens at line 1. Files deleted from the working tree open the
+read-only `HEAD` version through the `coc-git:` scheme. The root node refreshes
+the status snapshot. File actions follow each file's status: `Add` stages
+unstaged or untracked files, `Restore staged changes` unstages a file, and
+`Restore working tree changes` discards its tracked working-tree changes.
+
+Use `git.statusTree.splitCommand` to configure how the TreeView split opens.
+
 For more advance usage, checkout `:h coc-list`.
 
 ### Issue autocomplete from multiple GitHub repositories
@@ -324,19 +382,6 @@ An issue repository specifier looks like this: `github/neoclide/coc-git`.
 
 Multiple repositories can be specified using comma separation, like this: `github/neoclide/coc-git,github/neoclide/coc.nvim`
 
-## F.A.Q
-
-Q: Virtual text not working.
-
-A: Make sure your neovim/vim support virtual text by command `:echo has('nvim-0.5.0') || has('patch-9.0.0067')`.
-
-## Supporting
-
-If you like my extension, consider supporting me on Patreon or PayPal:
-
-<a href="https://www.patreon.com/chemzqm"><img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Patreon donate button" /> </a>
-<a href="https://www.paypal.com/paypalme/chezqm"><img src="https://werwolv.net/assets/paypal_banner.png" alt="PayPal donate button" /> </a>
-
 ## License
 
 MIT

package/history.md

@@ -1,12 +1,24 @@
+## 2.7.11
+
+- add AGENTS.md (34ea156)
+- feat: add git status tree view (4bc3f6e)
+
+## 2.7.10
+
+- docs: add MIT license (172bdca)
+- feat: add commit files TreeView (189d331)
+
 ## 2.7.9
 
+- show complete commit files as decorated coc-git virtual documents with chunk navigation
 - docs: add coc-git logo (992064f)
 - feat: show staged git gutters and navigate chunks (9410092)
 - jump to the current code (641396b)
 - fix typo in warning (#222) (9317050)
 
 ## 2.7.8
-
+- add git.showCommitTree for the commit associated with the current line
+- fix historical code cursor positioning after virtual document loading
 - use node24 for CI (eacd2a2)
 - fix uuid, use commonjs version (8ab1a44)
 - fix: narrow vim call results (b72ad90)