@gitkraken/core-gitlens 0.4.0 → 0.4.101

package/src/git/models/tag.ts

@@ -26,6 +26,11 @@ export class GitTag implements GitTagReference {
 		public readonly message: string,
 		public readonly date: Date | undefined,
 		public readonly commitDate: Date | undefined,
+		/** Whether this is an annotated tag (a tag object with its own metadata) vs a lightweight
+		 *  tag (a plain ref to a commit). Note `message` is the commit subject for lightweight tags,
+		 *  so it can't be used to infer this. Required so any new tag source must decide explicitly
+		 *  rather than silently defaulting (which would skew tag-annotation telemetry). */
+		public readonly annotated: boolean,
 	) {
 		({ name: this._name } = parseRefName(refName));
 
@@ -46,7 +51,7 @@ export class GitTag implements GitTagReference {
 	withRepoPath(repoPath: string): GitTag {
 		if (repoPath === this.repoPath) return this;
 
-		return new GitTag(repoPath, this.refName, this.sha, this.message, this.date, this.commitDate);
+		return new GitTag(repoPath, this.refName, this.sha, this.message, this.date, this.commitDate, this.annotated);
 	}
 
 	static is(tag: unknown): tag is GitTag {

package/src/git/parsers/diffParser.ts

@@ -167,7 +167,7 @@ export function parseGitDiff(data: string, includeRawContent = false): ParsedGit
 			header = `diff --git ${file.substring(0, hunkStartIndex)}`;
 			const content = file.substring(hunkStartIndex + 1);
 			rawContent = includeRawContent ? content : undefined;
-			hunks = parseGitFileDiff(content, includeRawContent)?.hunks || [];
+			hunks = parseGitFileDiff(content, includeRawContent)?.hunks ?? [];
 		}
 
 		parsed.files.push({

package/src/git/providers/branches.ts

@@ -60,7 +60,12 @@ export interface GitBranchesSubProvider {
 	getDefaultBranchName(
 		repoPath: string | undefined,
 		remote?: string,
-		options?: { priority?: GitCommandPriority },
+		/**
+		 * `local`: resolve only from the local `refs/remotes/<remote>/HEAD` symref and never contact the
+		 * remote (no `remote set-head` / `ls-remote`). Returns `undefined` when it isn't resolved locally
+		 * yet. Use on latency-sensitive paths (e.g. the graph) where a network round-trip is unwanted.
+		 */
+		options?: { priority?: GitCommandPriority; local?: boolean },
 		cancellation?: AbortSignal,
 	): Promise<string | undefined>;
 

package/src/git/providers/commits.ts

@@ -6,7 +6,7 @@ import type { GitLog } from '../models/log.js';
 import type { GitReflog } from '../models/reflog.js';
 import type { GitRevisionRange } from '../models/revision.js';
 import type { SearchQuery } from '../models/search.js';
-import type { CommitSignature } from '../models/signature.js';
+import type { CommitSignature, SshSignedCommit } from '../models/signature.js';
 import type { GitUser } from '../models/user.js';
 import type { DiffRange } from './types.js';
 
@@ -154,5 +154,10 @@ export interface GitCommitsSubProvider {
 		cancellation?: AbortSignal,
 	): Promise<GitCommitReachability | undefined>;
 	getCommitSignature?(repoPath: string, sha: string): Promise<CommitSignature | undefined>;
+	/**
+	 * For the given commits that are SSH-signed, extracts the signer's full SSH public key and raw committer identity,
+	 * reading all commit objects in a single batched `git` invocation. Keyed by commit SHA (unsigned commits omitted).
+	 */
+	getCommitsSshSigners?(repoPath: string, shas: string[]): Promise<Map<string, SshSignedCommit>>;
 	isCommitSigned?(repoPath: string, sha: string): Promise<boolean>;
 }

package/src/git/providers/config.ts

@@ -13,6 +13,8 @@ export type GitCoreConfigKeys =
 	| 'gpg.ssh.program'
 	| 'gpg.ssh.allowedSignersFile'
 	| 'init.defaultBranch'
+	/** `pull.rebase` — whether `git pull` rebases instead of merging; also accepts `merges`/`interactive` */
+	| 'pull.rebase'
 	| 'user.email'
 	| 'user.name'
 	| 'user.signingkey';
@@ -22,7 +24,9 @@ export type GitConfigKeys =
 	/** `vscode-merge-base` — value determined by VS Code that is used to determine the merge base for the current branch. Once `gk-merge-base` is determined, we stop using `vscode-merge-base` */
 	| `branch.${string}.vscode-merge-base`
 	/** `github-pr-owner-number` — value determined by VS Code/GitHub PR extension that is used to determine the PR number for the current branch */
-	| `branch.${string}.github-pr-owner-number`;
+	| `branch.${string}.github-pr-owner-number`
+	/** `rebase` — per-branch override of `pull.rebase`; takes precedence over the repository-wide setting */
+	| `branch.${string}.rebase`;
 
 export type GkConfigKeys =
 	/** `gk-merge-base` — the branch that the current branch was created from (the original base at branch creation time) */

package/src/git/providers/graph.ts

@@ -1,17 +1,84 @@
-import type { GitGraph, GraphRowProcessor } from '../models/graph.js';
+import type {
+	GitGraph,
+	GitGraphRowsStats,
+	GraphIncrementalSeed,
+	GraphReachabilityTable,
+	GraphRowProcessor,
+	IncrementalGraphOutcome,
+} from '../models/graph.js';
 import type {
 	GitGraphSearch,
 	GitGraphSearchCursor,
 	GitGraphSearchProgress,
 	GitGraphSearchResults,
 } from '../models/graphSearch.js';
+import type { GitGraphSession, GitGraphSessionSnapshot, GraphSessionRestoreResult } from '../models/graphSession.js';
 import type { SearchQuery } from '../models/search.js';
 
 export interface GitGraphSubProvider {
+	/**
+	 * Opens a stateful {@link GitGraphSession} for `repoPath` — the canonical accumulated graph window and
+	 * the single builder of incremental rebuild seeds. Performs the initial walk (equivalent to a first
+	 * `getGraph` with no seed); subsequent rebuilds go through `session.refresh()`, pagination through
+	 * `session.more()`. Prefer this over `getGraph` for a live, repeatedly-refreshed window; `getGraph`
+	 * remains for one-shot walks (and is what the session is built on).
+	 */
+	openGraphSession(
+		repoPath: string,
+		options?: {
+			rowProcessor?: GraphRowProcessor;
+			rev?: string;
+			limit?: number;
+			include?: { stats?: boolean };
+			/**
+			 * Restart-persistence snapshot to seed the session from (see {@link GitGraphSessionSnapshot}). When
+			 * present and structurally valid, the session reconstructs it as its prior generation WITHOUT any git,
+			 * then immediately refreshes to current truth — so a cold open on an unchanged repo is ≈ deserialize +
+			 * one enumeration. Any validation/parse failure is ignored (a normal initial walk). Never trusted over
+			 * git. Providers without an incremental restore path (e.g. GitHub) ignore it.
+			 */
+			restore?: GitGraphSessionSnapshot;
+			/**
+			 * Reports the restore outcome (validated + refreshed, or discarded with a reason) so the host can log
+			 * a single assertable line. Called at most once, only when `restore` was provided. See
+			 * {@link GraphSessionRestoreResult}.
+			 */
+			onRestore?: (result: GraphSessionRestoreResult) => void;
+		},
+		cancellation?: AbortSignal,
+	): Promise<GitGraphSession>;
 	getGraph(
 		repoPath: string,
 		rev: string | undefined,
-		options?: { include?: { stats?: boolean }; limit?: number; rowProcessor?: GraphRowProcessor },
+		options?: {
+			include?: { stats?: boolean };
+			limit?: number;
+			rowProcessor?: GraphRowProcessor;
+			/**
+			 * Prior generation's reachability table to CONTINUE (same repo rebuilds only). Keeps
+			 * `reachabilityIndex` values stable for unchanged rows, which is what lets the caller ship a
+			 * rows splice-delta instead of the full row set. See `createReachabilityTableBuilder`.
+			 */
+			reachabilitySeed?: GraphReachabilityTable;
+			/**
+			 * Prior generation's per-sha stats to CONTINUE (same-repo rebuilds only). Stats are immutable per
+			 * sha, so the deferred stats query recomputes only shas absent from the seed.
+			 */
+			rowsStatsSeed?: GitGraphRowsStats;
+			/**
+			 * R6b incremental head-walk seed. When present (and the gate holds) the Node provider walks only the
+			 * changed head region, stitches the seed's cached tail, and re-derives flags/reachability in memory
+			 * instead of re-walking every loaded row. Any structural change (ref deletion, non-fast-forward move,
+			 * stash-set change, old-dated interleave, …) degrades to the full walk. See {@link GraphIncrementalSeed}.
+			 */
+			incrementalSeed?: GraphIncrementalSeed;
+			/**
+			 * Observational callback invoked once per seeded call reporting whether the fast path was taken or a
+			 * full fallback occurred (with the reason). Never affects the returned graph. See
+			 * {@link IncrementalGraphOutcome}.
+			 */
+			onIncrementalResult?: (outcome: IncrementalGraphOutcome) => void;
+		},
 		cancellation?: AbortSignal,
 	): Promise<GitGraph>;
 	searchGraph(

package/src/git/providers/status.ts

@@ -14,7 +14,7 @@ export interface GitWorkingChangesState {
 export interface GitStatusSubProvider {
 	getStatus(
 		repoPath: string | undefined,
-		options?: { priority?: GitCommandPriority },
+		options?: { priority?: GitCommandPriority; force?: boolean },
 		cancellation?: AbortSignal,
 	): Promise<GitStatus | undefined>;
 	getStatusForFile?(

package/src/git/providers/worktrees.ts

@@ -31,5 +31,7 @@ export interface GitWorktreesSubProvider {
 	): Promise<GitWorktree | undefined>;
 	getWorktrees(repoPath: string, cancellation?: AbortSignal): Promise<GitWorktree[]>;
 	getWorktreesDefaultUri(repoPath: string): Uri | undefined;
-	deleteWorktree(repoPath: string, path: string | Uri, options?: { force?: boolean }): Promise<void>;
+	/** Pass `force: 'locked'` to also override a locked worktree */
+	deleteWorktree(repoPath: string, path: string | Uri, options?: { force?: boolean | 'locked' }): Promise<void>;
+	unlockWorktree(repoPath: string, path: string | Uri): Promise<void>;
 }

package/src/git/remotes/azure-devops.ts

@@ -18,10 +18,10 @@ const sshPathRegex = /^\/?v\d\//i;
 
 const azureSshUrlRegex = /^(?:[^@]+@)?([^:]+):v\d\//;
 
-const vstsHostnameRegex = /\.visualstudio\.com$/;
+const vstsHostnameSuffix = '.visualstudio.com';
 
 export function isVsts(domain: string): boolean {
-	return vstsHostnameRegex.test(domain);
+	return domain.endsWith(vstsHostnameSuffix);
 }
 
 function getVSTSOwner(url: URL): string {
@@ -53,7 +53,7 @@ export function parseAzureHttpsUrl(url: string): [owner: string, project: string
 export function parseAzureHttpsUrl(urlObj: URL): [owner: string, project: string, repo: string];
 export function parseAzureHttpsUrl(arg: URL | string): [owner: string, project: string, repo: string] {
 	const url = typeof arg === 'string' ? new URL(arg) : arg;
-	if (vstsHostnameRegex.test(url.hostname)) return parseVstsHttpsUrl(url);
+	if (url.hostname.endsWith(vstsHostnameSuffix)) return parseVstsHttpsUrl(url);
 	return parseAzureNewStyleUrl(url);
 }
 
@@ -113,33 +113,31 @@ export class AzureDevOpsRemoteProvider extends RemoteProvider {
 
 	private _autolinks: (AutolinkReference | DynamicAutolinkReference)[] | undefined;
 	override get autolinks(): (AutolinkReference | DynamicAutolinkReference)[] {
-		if (this._autolinks === undefined) {
-			// Strip off any `_git` part from the repo url
-			this._autolinks = [
-				...super.autolinks,
-				{
-					prefix: '#',
-					url: this.issueLinkPattern,
-					alphanumeric: false,
-					ignoreCase: false,
-					title: `Open Work Item #<num> on ${this.name}`,
-
-					type: 'issue',
-					description: `${this.name} Work Item #<num>`,
-				},
-				{
-					// Default Pull request message when merging a PR in ADO. Will not catch commits & pushes following a different pattern.
-					prefix: 'PR ',
-					url: `${this.baseUrl}/pullrequest/<num>`,
-					alphanumeric: false,
-					ignoreCase: false,
-					title: `Open Pull Request #<num> on ${this.name}`,
-
-					type: 'pullrequest',
-					description: `${this.name} Pull Request #<num>`,
-				},
-			];
-		}
+		// Strip off any `_git` part from the repo url
+		this._autolinks ??= [
+			...super.autolinks,
+			{
+				prefix: '#',
+				url: this.issueLinkPattern,
+				alphanumeric: false,
+				ignoreCase: false,
+				title: `Open Work Item #<num> on ${this.name}`,
+
+				type: 'issue',
+				description: `${this.name} Work Item #<num>`,
+			},
+			{
+				// Default Pull request message when merging a PR in ADO. Will not catch commits & pushes following a different pattern.
+				prefix: 'PR ',
+				url: `${this.baseUrl}/pullrequest/<num>`,
+				alphanumeric: false,
+				ignoreCase: false,
+				title: `Open Pull Request #<num> on ${this.name}`,
+
+				type: 'pullrequest',
+				description: `${this.name} Pull Request #<num>`,
+			},
+		];
 		return this._autolinks;
 	}
 
@@ -195,9 +193,7 @@ export class AzureDevOpsRemoteProvider extends RemoteProvider {
 
 	private _displayPath: string | undefined;
 	override get displayPath(): string {
-		if (this._displayPath === undefined) {
-			this._displayPath = this.path.replace(gitRegex, '/').replace(legacyDefaultCollectionRegex, '');
-		}
+		this._displayPath ??= this.path.replace(gitRegex, '/').replace(legacyDefaultCollectionRegex, '');
 		return this._displayPath;
 	}
 

package/src/git/remotes/bitbucket-server.ts

@@ -31,31 +31,29 @@ export class BitbucketServerRemoteProvider extends RemoteProvider {
 
 	private _autolinks: (AutolinkReference | DynamicAutolinkReference)[] | undefined;
 	override get autolinks(): (AutolinkReference | DynamicAutolinkReference)[] {
-		if (this._autolinks === undefined) {
-			this._autolinks = [
-				...super.autolinks,
-				{
-					prefix: 'issue #',
-					url: this.issueLinkPattern,
-					alphanumeric: false,
-					ignoreCase: true,
-					title: `Open Issue #<num> on ${this.name}`,
-
-					type: 'issue',
-					description: `${this.name} Issue #<num>`,
-				},
-				{
-					prefix: 'pull request #',
-					url: `${this.baseUrl}/pull-requests/<num>`,
-					alphanumeric: false,
-					ignoreCase: true,
-					title: `Open Pull Request #<num> on ${this.name}`,
-
-					type: 'pullrequest',
-					description: `${this.name} Pull Request #<num>`,
-				},
-			];
-		}
+		this._autolinks ??= [
+			...super.autolinks,
+			{
+				prefix: 'issue #',
+				url: this.issueLinkPattern,
+				alphanumeric: false,
+				ignoreCase: true,
+				title: `Open Issue #<num> on ${this.name}`,
+
+				type: 'issue',
+				description: `${this.name} Issue #<num>`,
+			},
+			{
+				prefix: 'pull request #',
+				url: `${this.baseUrl}/pull-requests/<num>`,
+				alphanumeric: false,
+				ignoreCase: true,
+				title: `Open Pull Request #<num> on ${this.name}`,
+
+				type: 'pullrequest',
+				description: `${this.name} Pull Request #<num>`,
+			},
+		];
 		return this._autolinks;
 	}
 

package/src/git/remotes/bitbucket.ts

@@ -27,31 +27,29 @@ export class BitbucketRemoteProvider extends RemoteProvider {
 
 	private _autolinks: (AutolinkReference | DynamicAutolinkReference)[] | undefined;
 	override get autolinks(): (AutolinkReference | DynamicAutolinkReference)[] {
-		if (this._autolinks === undefined) {
-			this._autolinks = [
-				...super.autolinks,
-				{
-					prefix: 'issue #',
-					url: this.issueLinkPattern,
-					alphanumeric: false,
-					ignoreCase: true,
-					title: `Open Issue #<num> on ${this.name}`,
-
-					type: 'issue',
-					description: `${this.name} Issue #<num>`,
-				},
-				{
-					prefix: 'pull request #',
-					url: `${this.baseUrl}/pull-requests/<num>`,
-					alphanumeric: false,
-					ignoreCase: true,
-					title: `Open Pull Request #<num> on ${this.name}`,
-
-					type: 'pullrequest',
-					description: `${this.name} Pull Request #<num>`,
-				},
-			];
-		}
+		this._autolinks ??= [
+			...super.autolinks,
+			{
+				prefix: 'issue #',
+				url: this.issueLinkPattern,
+				alphanumeric: false,
+				ignoreCase: true,
+				title: `Open Issue #<num> on ${this.name}`,
+
+				type: 'issue',
+				description: `${this.name} Issue #<num>`,
+			},
+			{
+				prefix: 'pull request #',
+				url: `${this.baseUrl}/pull-requests/<num>`,
+				alphanumeric: false,
+				ignoreCase: true,
+				title: `Open Pull Request #<num> on ${this.name}`,
+
+				type: 'pullrequest',
+				description: `${this.name} Pull Request #<num>`,
+			},
+		];
 		return this._autolinks;
 	}
 

package/src/git/remotes/gerrit.ts

@@ -40,20 +40,18 @@ export class GerritRemoteProvider extends RemoteProvider {
 
 	private _autolinks: (AutolinkReference | DynamicAutolinkReference)[] | undefined;
 	override get autolinks(): (AutolinkReference | DynamicAutolinkReference)[] {
-		if (this._autolinks === undefined) {
-			this._autolinks = [
-				...super.autolinks,
-				{
-					prefix: 'Change-Id: ',
-					url: this.issueLinkPattern,
-					alphanumeric: true,
-					ignoreCase: true,
-					title: `Open Change #<num> on ${this.name}`,
-
-					description: `${this.name} Change #<num>`,
-				},
-			];
-		}
+		this._autolinks ??= [
+			...super.autolinks,
+			{
+				prefix: 'Change-Id: ',
+				url: this.issueLinkPattern,
+				alphanumeric: true,
+				ignoreCase: true,
+				title: `Open Change #<num> on ${this.name}`,
+
+				description: `${this.name} Change #<num>`,
+			},
+		];
 		return this._autolinks;
 	}
 

package/src/git/remotes/gitea.ts

@@ -32,21 +32,19 @@ export class GiteaRemoteProvider extends RemoteProvider {
 
 	private _autolinks: (AutolinkReference | DynamicAutolinkReference)[] | undefined;
 	override get autolinks(): (AutolinkReference | DynamicAutolinkReference)[] {
-		if (this._autolinks === undefined) {
-			this._autolinks = [
-				...super.autolinks,
-				{
-					prefix: '#',
-					url: this.issueLinkPattern,
-					alphanumeric: false,
-					ignoreCase: false,
-					title: `Open Issue #<num> on ${this.name}`,
-
-					type: 'issue',
-					description: `${this.name} Issue #<num>`,
-				},
-			];
-		}
+		this._autolinks ??= [
+			...super.autolinks,
+			{
+				prefix: '#',
+				url: this.issueLinkPattern,
+				alphanumeric: false,
+				ignoreCase: false,
+				title: `Open Issue #<num> on ${this.name}`,
+
+				type: 'issue',
+				description: `${this.name} Issue #<num>`,
+			},
+		];
 		return this._autolinks;
 	}
 

package/src/git/remotes/github.ts

@@ -42,66 +42,64 @@ export class GitHubRemoteProvider extends RemoteProvider<GitHubRepositoryDescrip
 
 	private _autolinks: (AutolinkReference | DynamicAutolinkReference)[] | undefined;
 	override get autolinks(): (AutolinkReference | DynamicAutolinkReference)[] {
-		if (this._autolinks === undefined) {
-			this._autolinks = [
-				...super.autolinks,
-				{
-					prefix: '#',
-					url: this.issueLinkPattern,
-					alphanumeric: false,
-					ignoreCase: false,
-					title: `Open Issue or Pull Request #<num> on ${this.name}`,
-					description: `${this.name} Issue or Pull Request #<num>`,
-				},
-				{
-					prefix: 'gh-',
-					url: this.issueLinkPattern,
-					alphanumeric: false,
-					ignoreCase: true,
-					title: `Open Issue or Pull Request #<num> on ${this.name}`,
-					description: `${this.name} Issue or Pull Request #<num>`,
-				},
-				{
-					descriptors: [
-						{
-							regex: autolinkFullIssuesRegex,
-							url: (repo, num) => `${this.protocol}://${this.domain}/${repo}/issues/${num}`,
-							title: (repo, num) => `Open Issue or Pull Request #${num} from ${repo} on ${this.name}`,
-							label: (repo, num) => `${this.name} Issue or Pull Request ${repo}#${num}`,
-						},
-					],
-					parse: (text: string, autolinks: Map<string, Autolink>) => {
-						let ownerAndRepo: string;
-						let num: string;
-
-						let match;
-						do {
-							match = autolinkFullIssuesRegex.exec(text);
-							if (match == null) break;
-
-							[, ownerAndRepo, num] = match;
-
-							const [owner, repo] = ownerAndRepo.split('/', 2);
-							autolinks.set(num, {
-								provider: this,
-								id: num,
-								prefix: `${ownerAndRepo}#`,
-								url: `${this.protocol}://${this.domain}/${ownerAndRepo}/issues/${num}`,
-								alphanumeric: false,
-								ignoreCase: true,
-								title: `Open Issue or Pull Request #<num> from ${ownerAndRepo} on ${this.name}`,
-								description: `${this.name} Issue or Pull Request ${ownerAndRepo}#${num}`,
-								descriptor: {
-									key: this.remoteKey,
-									owner: owner,
-									name: repo,
-								} satisfies GitHubRepositoryDescriptor,
-							});
-						} while (true);
+		this._autolinks ??= [
+			...super.autolinks,
+			{
+				prefix: '#',
+				url: this.issueLinkPattern,
+				alphanumeric: false,
+				ignoreCase: false,
+				title: `Open Issue or Pull Request #<num> on ${this.name}`,
+				description: `${this.name} Issue or Pull Request #<num>`,
+			},
+			{
+				prefix: 'gh-',
+				url: this.issueLinkPattern,
+				alphanumeric: false,
+				ignoreCase: true,
+				title: `Open Issue or Pull Request #<num> on ${this.name}`,
+				description: `${this.name} Issue or Pull Request #<num>`,
+			},
+			{
+				descriptors: [
+					{
+						regex: autolinkFullIssuesRegex,
+						url: (repo, num) => `${this.protocol}://${this.domain}/${repo}/issues/${num}`,
+						title: (repo, num) => `Open Issue or Pull Request #${num} from ${repo} on ${this.name}`,
+						label: (repo, num) => `${this.name} Issue or Pull Request ${repo}#${num}`,
 					},
+				],
+				parse: (text: string, autolinks: Map<string, Autolink>) => {
+					let ownerAndRepo: string;
+					let num: string;
+
+					let match;
+					do {
+						match = autolinkFullIssuesRegex.exec(text);
+						if (match == null) break;
+
+						[, ownerAndRepo, num] = match;
+
+						const [owner, repo] = ownerAndRepo.split('/', 2);
+						autolinks.set(num, {
+							provider: this,
+							id: num,
+							prefix: `${ownerAndRepo}#`,
+							url: `${this.protocol}://${this.domain}/${ownerAndRepo}/issues/${num}`,
+							alphanumeric: false,
+							ignoreCase: true,
+							title: `Open Issue or Pull Request #<num> from ${ownerAndRepo} on ${this.name}`,
+							description: `${this.name} Issue or Pull Request ${ownerAndRepo}#${num}`,
+							descriptor: {
+								key: this.remoteKey,
+								owner: owner,
+								name: repo,
+							} satisfies GitHubRepositoryDescriptor,
+						});
+					} while (true);
 				},
-			];
-		}
+			},
+		];
 		return this._autolinks;
 	}