GitHookContext class

Context for git-related hooks (HookType.onGitOperation).

Inheritance

Constructors

GitHookContext({required HookType hookType, required DateTime timestamp, String? sessionId, Map<String, dynamic> metadata = const {}, List<HookResult> previousResults = const [], int? turnIndex, required GitOperation operation, String? branch, String? targetBranch, List<String> files = const [], String? remote, String? commitMessage, bool force = false})
const

Properties

branch → String?
Current branch name.
final
commitMessage → String?
Commit message (for commit operations).
final
files → List<String>
Files involved in the operation.
final
force → bool
Whether the operation is forced (e.g., force push).
final
hashCode → int
The hash code for this object.
no setterinherited
hookType → HookType
The type of hook being executed.
finalinherited
metadata → Map<String, dynamic>
Arbitrary metadata that hooks can read and contribute to.
finalinherited
operation → GitOperation
Git operation being performed.
final
previousResults → List<HookResult>
Results from previously executed hooks in the same chain.
finalinherited
remote → String?
Remote name (for push, pull, fetch).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sessionId → String?
The active session ID, if any.
finalinherited
targetBranch → String?
Target branch (for merge, rebase, checkout).
final
timestamp → DateTime
When this hook execution was initiated.
finalinherited
turnIndex → int?
The current conversation turn index, if applicable.
finalinherited

Methods

copyWith({HookType? hookType, DateTime? timestamp, String? sessionId, Map<String, dynamic>? metadata, List<HookResult>? previousResults, int? turnIndex}) → HookContext
Create a copy with updated fields.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited