Skip to main content

LintCommand

Struct LintCommand 

Source
pub struct LintCommand {
    pub commit_range: Option<String>,
    pub context_dir: Option<PathBuf>,
    pub guidelines: Option<PathBuf>,
    pub output: OutputFormat,
    pub strict: bool,
    pub quiet: bool,
    pub verbose: bool,
    pub show_passing: bool,
    pub stdin: bool,
    pub suggest: bool,
    pub fix: bool,
    pub allow_pushed: bool,
}
Expand description

Lint command options - deterministically validates commit messages against guidelines (no AI, no network).

Fields§

§commit_range: Option<String>

Commit range to lint (e.g., HEAD~3..HEAD, abc123..def456). Defaults to commits ahead of the default base branch (origin/main, origin/master, main, or master).

§context_dir: Option<PathBuf>

Path to custom context directory (defaults to .omni-dev/).

§guidelines: Option<PathBuf>

Accepted for CLI parity with check; unused by lint (there is no AI prose guidelines file to load — deterministic rules come from .omni-dev/commit-rules.yaml and .omni-dev/scopes.yaml instead).

§output: OutputFormat

Output format.

§strict: bool

Exits with error code if any issues found (including warnings).

§quiet: bool

Only shows errors/warnings, suppresses info-level output.

§verbose: bool

Shows the resolved rules/scopes configuration sources.

§show_passing: bool

Includes passing commits in output (hidden by default).

§stdin: bool

Reads a single commit message from standard input instead of a commit range (for a commit-msg git hook call site).

§suggest: bool

Populates a deterministic corrected-scope suggestion for each commit with an unknown-scope/missing-scope issue, resolved from the commit’s changed files against .omni-dev/scopes.yaml + ecosystem defaults — no AI, no network. Report-only; use --fix to apply. Requires a commit range (incompatible with --stdin, which has no changed-files list to resolve a scope from).

§fix: bool

Applies --suggest’s deterministic scope corrections directly to the repository, via the same AmendmentHandler path git commit message amend uses. No AI, no confirmation prompt — only ever touches a commit with a resolvable unknown-scope/missing-scope issue. Implies --suggest. Requires a commit range (incompatible with --stdin).

§allow_pushed: bool

Permits --fix to amend commits already present in a detected remote main branch (rewrites published history). Mirrors git commit message amend --allow-pushed / twiddle --allow-pushed. Ignored without --fix.

Implementations§

Source§

impl LintCommand

Source

pub async fn execute(self, repo: Option<&Path>) -> Result<()>

Executes the lint command, validating commit messages against deterministic rules.

Trait Implementations§

Source§

impl Args for LintCommand

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 CommandFactory for LintCommand

Source§

fn command<'b>() -> Command

Build a Command that can instantiate Self. Read more
Source§

fn command_for_update<'b>() -> Command

Build a Command that can update self. Read more
Source§

impl FromArgMatches for LintCommand

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.
Source§

impl Parser for LintCommand

Source§

fn parse() -> Self

Parse from std::env::args_os(), exit on error.
Source§

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.
Source§

fn parse_from<I, T>(itr: I) -> Self
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.
Source§

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.
Source§

fn update_from<I, T>(&mut self, itr: I)
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error. Read more
Source§

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>
where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more