Struct DiffRenderer 

pub struct DiffRenderer { /* private fields */ }

Renders diffs with appropriate formatting and colors.

Examples

use sublime_cli_tools::output::diff::{DiffRenderer, VersionDiff};

let renderer = DiffRenderer::new(false);
let diff = VersionDiff::new("my-package", "1.0.0", "2.0.0");
let output = renderer.render_version_diff(&diff);
println!("{}", output);

Implementations

impl DiffRenderer

pub fn new(no_color: bool) -> Self

Creates a new diff renderer.

Arguments

• no_color - Whether to disable color output

Examples

use sublime_cli_tools::output::diff::DiffRenderer;

let renderer = DiffRenderer::new(false);

pub fn with_line_numbers(self, show: bool) -> Self

Sets whether to show line numbers.

Arguments

• show - Whether to show line numbers

Examples

use sublime_cli_tools::output::diff::DiffRenderer;

let renderer = DiffRenderer::new(false)
    .with_line_numbers(true);

pub fn with_context_lines(self, count: usize) -> Self

Sets the number of context lines to show.

Arguments

• count - Number of context lines

Examples

use sublime_cli_tools::output::diff::DiffRenderer;

let renderer = DiffRenderer::new(false)
    .with_context_lines(5);

pub fn render_version_diff(&self, diff: &VersionDiff) -> String

Renders a version diff.

Arguments

• diff - The version diff to render

Examples

use sublime_cli_tools::output::diff::{DiffRenderer, VersionDiff};

let renderer = DiffRenderer::new(false);
let diff = VersionDiff::new("pkg", "1.0.0", "2.0.0");
let output = renderer.render_version_diff(&diff);

pub fn render_file_diff(&self, diff: &FileDiff) -> String

Renders a file diff.

Arguments

• diff - The file diff to render

Examples

use sublime_cli_tools::output::diff::{DiffRenderer, FileDiff, DiffType};

let renderer = DiffRenderer::new(false);
let diff = FileDiff::new("file.txt", DiffType::Modified)
    .add_line_removed("old")
    .add_line_added("new");
let output = renderer.render_file_diff(&diff);

pub fn render_dependency_diff(&self, diff: &DependencyDiff) -> String

Renders a dependency diff.

Arguments

• diff - The dependency diff to render

Examples

use sublime_cli_tools::output::diff::{DiffRenderer, DependencyDiff};

let renderer = DiffRenderer::new(false);
let diff = DependencyDiff::new("lodash", "^4.0.0", "^5.0.0");
let output = renderer.render_dependency_diff(&diff);

pub fn render_version_summary(&self, diffs: &[VersionDiff]) -> String

Renders multiple version diffs as a summary.

Arguments

• diffs - The version diffs to render

Examples

use sublime_cli_tools::output::diff::{DiffRenderer, VersionDiff};

let renderer = DiffRenderer::new(false);
let diffs = vec![
    VersionDiff::new("pkg1", "1.0.0", "2.0.0"),
    VersionDiff::new("pkg2", "3.0.0", "3.1.0"),
];
let output = renderer.render_version_summary(&diffs);

Trait Implementations

impl Clone for DiffRenderer

fn clone(&self) -> DiffRenderer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiffRenderer

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

Formats the value using the given formatter.

impl Default for DiffRenderer

fn default() -> Self

Returns the “default value” for a type.