Skip to main content

OutputFormat

Enum OutputFormat 

Source
pub enum OutputFormat {
Show 13 variants Human, Json, Sarif, Compact, Markdown, CodeClimate, PrCommentGithub, PrCommentGitlab, ReviewGithub, ReviewGitlab, Badge, GithubAnnotations, GithubSummary,
}
Expand description

Output format for fallow results.

This is command-line and integration metadata, not stored in config files. Keeping it in fallow-types lets config, output, CLI, MCP, and API layers agree on the same contract without creating a config-to-output dependency.

Variants§

§

Human

Human-readable terminal output with source context.

§

Json

Machine-readable JSON.

§

Sarif

SARIF format for GitHub Code Scanning.

§

Compact

One issue per line (grep-friendly).

§

Markdown

Markdown for PR comments.

§

CodeClimate

CodeClimate JSON for GitLab Code Quality.

CLI aliases: codeclimate, gitlab-codequality, gitlab-code-quality.

§

PrCommentGithub

GitHub-flavored sticky PR comment markdown.

§

PrCommentGitlab

GitLab-flavored sticky MR comment markdown.

§

ReviewGithub

GitHub PR review JSON envelope.

§

ReviewGitlab

GitLab MR review JSON envelope.

§

Badge

Shields.io-compatible SVG badge (health command only).

§

GithubAnnotations

GitHub Actions workflow-command annotations (::error / ::warning / ::notice lines). Provider-prefixed name because workflow-command annotations are a GitHub-only concept with no GitLab twin.

§

GithubSummary

GitHub Actions job-summary markdown (for >> $GITHUB_STEP_SUMMARY). Provider-prefixed for the same reason as GithubAnnotations.

Implementations§

Source§

impl OutputFormat

Source

pub const fn flag_label(self) -> &'static str

The --format spelling of this variant.

Notes that name the format a run degraded on have to name it the way the user would pass it, so the sentence doubles as the fix. codeclimate is the canonical spelling of the aliased GitLab Code Quality format.

Trait Implementations§

Source§

impl Clone for OutputFormat

Source§

fn clone(&self) -> OutputFormat

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for OutputFormat

Source§

impl Debug for OutputFormat

Source§

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

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

impl Default for OutputFormat

Source§

fn default() -> OutputFormat

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'a, T> FromIn<'a, T> for T

Source§

fn from_in(t: T, _: &'a Allocator) -> T

Converts to this type from the input type within the given allocator.
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<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

Source§

fn into_in(self, allocator: &'a Allocator) -> U

Converts this type into the (usually inferred) input type within the given allocator.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
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