Struct Options 

pub struct Options {

    pub execution_id: Option<String>,
    pub config: Option<PathBuf>,
    pub paths: Vec<PathBuf>,
    pub pattern: String,
    pub ignore: Vec<String>,
    pub reporters: Vec<String>,
    pub listeners: Vec<String>,
    pub reporters_options: Map<String, Value>,
    pub output: PathBuf,
    pub output_is_bare: bool,
    pub formats: Option<HashSet<String>>,
    pub format_order: Option<Vec<String>>,
    pub formats_exts: FormatMappings,
    pub formats_names: FormatMappings,
    pub ignore_pattern: Vec<Regex>,
    pub min_lines: usize,
    pub min_tokens: usize,
    pub max_lines: usize,
    pub max_size_bytes: u64,
    pub threshold: Option<f64>,
    pub mode: Mode,
    pub store: Option<String>,
    pub store_path: Option<PathBuf>,
    pub blame: bool,
    pub cache: bool,
    pub silent: bool,
    pub absolute: bool,
    pub no_symlinks: bool,
    pub ignore_case: bool,
    pub gitignore: bool,
    pub debug: bool,
    pub verbose: bool,
    pub skip_local: bool,
    pub exit_code: ExitCode,
    pub no_tips: bool,
    pub tokens_to_skip: Vec<String>,
}

Normalized detector options shared by the CLI, server, and Rust API.

Values are usually created with get_default_options, get_options_from_args, or the jscpd binary. Fields are public so native integrations can construct focused option sets without going through CLI parsing.

Fields

execution_id: Option<String>

Upstream-style execution identifier used in reports.

config: Option<PathBuf>

Loaded configuration file path, when one was used.

paths: Vec<PathBuf>

Paths to scan.

pattern: String

Glob pattern used during discovery.

ignore: Vec<String>

Explicit ignore globs.

reporters: Vec<String>

Reporter names to run.

listeners: Vec<String>

Listener names preserved for option-surface compatibility.

reporters_options: Map<String, Value>

Reporter-specific option map from config.

output: PathBuf

Report output directory.

output_is_bare: bool

True when --output was passed without a value.

formats: Option<HashSet<String>>

Optional allowlist of source formats.

format_order: Option<Vec<String>>

User-provided format order for debug/report compatibility.

formats_exts: FormatMappings

Custom extension-to-format mappings.

formats_names: FormatMappings

Custom filename-to-format mappings.

ignore_pattern: Vec<Regex>

Regular expressions for skipping matched code blocks.

min_lines: usize

Minimum duplicated fragment size in lines.

min_tokens: usize

Minimum duplicated fragment size in detection tokens.

max_lines: usize

Maximum source line count to scan.

max_size_bytes: u64

Maximum source byte size to scan.

threshold: Option<f64>

Duplicated-line percentage threshold.

mode: Mode

Token filtering mode.

store: Option<String>

Optional external store name, currently preserved for compatibility.

store_path: Option<PathBuf>

Optional external store path, currently preserved for compatibility.

blame: bool

Populate duplicate fragments with git blame -w metadata.

cache: bool

Cache option preserved for upstream option-surface compatibility.

silent: bool

Suppress reporter output where upstream does.

absolute: bool

Write absolute source paths in reports.

no_symlinks: bool

Do not follow symlinks during discovery.

ignore_case: bool

Detect duplicates case-insensitively.

gitignore: bool

Respect Git ignore files during discovery.

debug: bool

Print debug discovery/config output and skip detection.

verbose: bool

Print verbose detector events and skip reasons.

skip_local: bool

Skip clones local to the same configured scan root.

exit_code: ExitCode

Exit code to use when duplicates are found.

no_tips: bool

Suppress post-run tips.

tokens_to_skip: Vec<String>

Token names preserved for upstream option-surface compatibility.

Implementations

impl Options

pub fn from_args<I, T>(args: I) -> Result<Self>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse upstream-style command-line arguments into normalized options.

The first argument should be the binary name.

pub fn from_cli(cli: Cli) -> Result<Self>

Convert the raw clap parser output into normalized detector options.

Prefer Options::from_args or crate::get_options_from_args unless you already have a Cli value.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.