Struct IgnoreFile 

pub struct IgnoreFile { /* private fields */ }

A single ignore file configuration.

Example

use cuenv_ignore::IgnoreFile;

let file = IgnoreFile::new("git")
    .pattern("node_modules/")
    .pattern(".env")
    .header("Generated by my-tool");

assert_eq!(file.output_filename(), ".gitignore");

Implementations

impl IgnoreFile

pub fn new(tool: impl Into<String>) -> Self

Create a new ignore file configuration for a tool.

The tool name is used to generate the default filename as .{tool}ignore.

Example

use cuenv_ignore::IgnoreFile;

let file = IgnoreFile::new("git");
assert_eq!(file.output_filename(), ".gitignore");

let file = IgnoreFile::new("docker");
assert_eq!(file.output_filename(), ".dockerignore");

pub fn pattern(self, pattern: impl Into<String>) -> Self

Add a single pattern to the ignore file.

pub fn patterns( self, patterns: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Add multiple patterns to the ignore file.

pub fn filename(self, filename: impl Into<String>) -> Self

Set a custom filename for the ignore file.

If not set, defaults to .{tool}ignore.

pub fn filename_opt(self, filename: Option<impl Into<String>>) -> Self

Optionally set a custom filename for the ignore file.

pub fn header(self, header: impl Into<String>) -> Self

Set a header comment for the ignore file.

The header will be added at the top of the file with # prefixes. Each line of the header will be prefixed with # .

pub fn output_filename(&self) -> String

Get the output filename for this ignore file.

Returns the custom filename if set, otherwise .{tool}ignore.

pub fn tool(&self) -> &str

Get the tool name.

pub fn patterns_list(&self) -> &[String]

Get the patterns.

pub fn generate(&self) -> String

Generate the file content.

Example

use cuenv_ignore::IgnoreFile;

let file = IgnoreFile::new("git")
    .pattern("node_modules/")
    .header("My header");

let content = file.generate();
assert!(content.contains("# My header"));
assert!(content.contains("node_modules/"));

Trait Implementations

impl Clone for IgnoreFile

fn clone(&self) -> IgnoreFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IgnoreFile

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

Formats the value using the given formatter.

impl PartialEq for IgnoreFile

fn eq(&self, other: &IgnoreFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for IgnoreFile

impl StructuralPartialEq for IgnoreFile