Skip to main content

AnnotateCommitArgs

Struct AnnotateCommitArgs 

Source
pub struct AnnotateCommitArgs {
    pub sha: Option<String>,
    pub write: bool,
    pub author: Option<String>,
    pub task_description: Option<String>,
    pub ctx_task: Option<String>,
    pub ctx_plan: Option<String>,
    pub quiet: bool,
    pub debug_clusters: bool,
}

Fields§

§sha: Option<String>

Git commit SHA to annotate (default: HEAD).

§write: bool

Write derived entries to the ASD ledger. Without this flag the command is a dry-run and only prints suggestions.

§author: Option<String>

Author id written into ledger entries (default: git user.name).

§task_description: Option<String>

Additional context from the active CTX task (its title or description). Appended to the commit message body when deriving annotations.

§ctx_task: Option<String>

CTX task ID — written as a ctx:task:<id> provenance tag on every entry. Also accepts CTXONE_TASK env var.

§ctx_plan: Option<String>

CTX plan ID — written as a ctx:plan:<id> provenance tag. Also accepts CTXONE_PLAN env var.

§quiet: bool

Suppress informational stderr output.

§debug_clusters: bool

Print per-doc cluster selection reasoning: terms extracted, top-5 candidates with kind bonus and match score, and why the winner was selected. Only active for docs-only commits.

Trait Implementations§

Source§

impl Args for AnnotateCommitArgs

Source§

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments
Source§

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut Read more
Source§

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut Read more
Source§

impl Debug for AnnotateCommitArgs

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl FromArgMatches for AnnotateCommitArgs

Source§

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed. Read more
Source§

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.
Source§

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.