Struct TransformConfig 

pub struct TransformConfig {
    pub mode: Mode,
    pub preserve_comments: bool,
    pub cache_enabled: bool,
    pub max_lines: Option<usize>,
    pub last_lines: Option<usize>,
    pub line_numbers: bool,
}

Configuration for transformation

ARCHITECTURE: This is injected into transform functions (no global state).

Fields

mode: Mode

Transformation mode

preserve_comments: bool

Whether to preserve structural comments

If true, keeps comments that describe structure (e.g., JSDoc, docstrings). If false, strips all comments.

cache_enabled: bool

Whether to use caching

NOTE: This field is reserved for future library users who want to implement their own caching. The CLI (rskim binary) implements caching separately and ignores this field. See: crates/rskim/src/cache.rs

max_lines: Option<usize>

Maximum output lines (AST-aware truncation)

When set, truncates output to at most N lines using priority-based selection that preserves AST node boundaries. Types and signatures are kept over imports, which are kept over function bodies. Omission markers are inserted between gaps.

When None, no truncation is applied (full output).

last_lines: Option<usize>

Last N lines truncation

When set, keeps only the last N lines of output, prepending a language-appropriate truncation marker. Mutually exclusive with max_lines (enforced at CLI level).

When None, no last-lines truncation is applied.

line_numbers: bool

Annotate output with source line numbers.

ARCHITECTURE: Line number formatting is applied at the CLI layer (rskim binary), not in the core library. This field is part of TransformConfig so it can be included in the public API for transform_with_line_map(), but the core library does NOT apply formatting — it only computes and returns the source line map.

When true, transform_with_line_map() returns a Some(Vec<usize>) source line map alongside the transformed text. The CLI applies {line}\t{content} formatting.

When false (default), the source line map is None and no line number computation is performed.

Implementations

impl TransformConfig

pub fn with_mode(mode: Mode) -> Self

Create config with specific mode

pub fn preserve_comments(self, preserve: bool) -> Self

Builder: Set comment preservation

pub fn with_cache(self, enabled: bool) -> Self

Builder: Enable caching

pub fn with_max_lines(self, n: usize) -> Self

Builder: Set maximum output lines (AST-aware truncation)

When set, output is truncated to at most n lines using priority-based selection that preserves AST node boundaries.

pub fn with_last_lines(self, n: usize) -> Self

Builder: Set last-N-lines truncation

When set, keeps only the last n lines of output, prepending a language-appropriate truncation marker.

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

Builder: Enable source line number annotation.

When enabled, transform_with_line_map() returns a source line map alongside the transformed text. The CLI applies {line}\t{content} formatting.

Trait Implementations

impl Clone for TransformConfig

fn clone(&self) -> TransformConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransformConfig

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

Formats the value using the given formatter.

impl Default for TransformConfig

fn default() -> Self

Returns the “default value” for a type.