coc-git 2.7.10 → 2.7.12

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/Readme.md

@@ -152,6 +152,8 @@ In your vim/neovim, run command:
 
 - `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"]`
@@ -279,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.
@@ -351,6 +354,21 @@ 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

package/history.md

@@ -1,3 +1,12 @@
+## 2.7.12
+
+- fix: address audited git workflow issues (eb6ee85)
+
+## 2.7.11
+
+- add AGENTS.md (34ea156)
+- feat: add git status tree view (4bc3f6e)
+
 ## 2.7.10
 
 - docs: add MIT license (172bdca)
@@ -5,7 +14,6 @@
 
 ## 2.7.9
 
-- add a read-only TreeView for files changed by a commit
 - 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)