string_pipeline 0.10.0

A flexible, template-driven string transformation pipeline for Rust.
Documentation

πŸ”— String Pipeline

Crates.io Docs.rs CI License

A powerful string transformation CLI tool and Rust library that makes complex text processing simple. Transform data using intuitive template syntax β€” chain operations like split, join, replace, filter, and 20+ others in a single readable expression.


πŸ“‹ Table of Contents

🌟 Why String Pipeline?

Transform complex text processing into simple, readable templates:

# Traditional approach (multiple commands)
echo "john.doe@email.com,jane.smith@company.org" | \
  tr ',' '\n' | \
  grep -o '@[^,]*' | \
  tr -d '@' | \
  sort | \
  tr '\n' ','

# String Pipeline (single template)
string-pipeline "{split:,:..|map:{regex_extract:@(.+):1}|sort}" "john.doe@email.com,jane.smith@company.org"
# Output: "company.org,email.com"

✨ Key Features

  • πŸ”— Chainable Operations: Pipe operations together naturally
  • 🎯 Precise Control: Python-like ranges with Rust syntax (-2.., 1..=3)
  • πŸ—ΊοΈ Powerful Mapping: Apply sub-pipelines to each list item
  • πŸ” Regex Support: sed-like patterns for complex transformations
  • πŸ› Debug Mode: Step-by-step operation visualization
  • πŸ“₯ Flexible I/O: CLI tool + embeddable Rust library

⚑ Quick Examples

πŸ”₯ Basic Transformations

# Extract middle items from list
string-pipeline "{split:,:1..3}" "a,b,c,d,e"
# Output: "b,c"

# Clean and format names
string-pipeline '{split:,:..|map:{trim|upper|append:!}}' "  john  , jane , bob  "
# Output: "JOHN!,JANE!,BOB!"

# Extract numbers and pad with zeros
string-pipeline '{split:,:..|map:{regex_extract:\d+|pad:3:0:left}}' "item1,thing22,stuff333"
# Output: "001,022,333"

🧠 Advanced Processing

# Filter files, format as list
string-pipeline '{split:,:..|filter:\.py$|sort|map:{prepend:β€’ }|join:\n}' "app.py,readme.md,test.py,data.json"
# Output: "β€’ app.py\nβ€’ test.py"

# Extract domains from URLs
string-pipeline '{split:,:..|map:{regex_extract://([^/]+):1|upper}}' "https://github.com,https://google.com"
# Output: "GITHUB.COM,GOOGLE.COM"

# Debug complex processing
string-pipeline "{!split: :..|filter:^[A-Z]|sort:desc}" "apple Banana cherry Date"
# Shows step-by-step processing + final output: "Date,Banana"
# DEBUG: ═══════════════════════════════════════════════
# DEBUG: PIPELINE START: 3 operations to apply
# DEBUG: Initial input: Str("apple Banana cherry Date")
# DEBUG: ───────────────────────────────────────────────
# DEBUG: STEP 1/3: Applying Split { sep: " ", range: Range(None, None, false) }
# DEBUG: Input: Str("apple Banana cherry Date")
# DEBUG: Result: List(4 items: ["apple", "Banana", "cherry", "Date"])
# DEBUG: Step completed in 425.1Β΅s
# DEBUG: ───────────────────────────────────────────────
# DEBUG: STEP 2/3: Applying Filter { pattern: "^[A-Z]" }
# DEBUG: Input: List(["apple", "Banana", "cherry", "Date"])
# DEBUG: Result: List(2 items: ["Banana", "Date"])
# DEBUG: Step completed in 287.6Β΅s
# DEBUG: ───────────────────────────────────────────────
# DEBUG: STEP 3/3: Applying Sort { direction: Desc }
# DEBUG: Input: List(["Banana", "Date"])
# DEBUG: Result: List(2 items: ["Date", "Banana"])
# DEBUG: Step completed in 156.3Β΅s
# DEBUG: ───────────────────────────────────────────────
# DEBUG: PIPELINE COMPLETE
# DEBUG: Total execution time: 1.2431ms
# DEBUG: ═══════════════════════════════════════════════
# Date Banana

πŸ’‘ Want to see more? Check out the πŸ“š Documentation with 20+ operations and real-world examples!

πŸš€ Installation

πŸ“¦ CLI Tool

# Install from crates.io
cargo install string_pipeline

# Or build from source
git clone https://github.com/lalvarezt/string_pipeline.git
cd string_pipeline
cargo install --path .

πŸ“š Rust Library

Add to your Cargo.toml:

[dependencies]
string_pipeline = "0.10.0"

πŸƒ Quick Start

πŸ’» CLI Usage

# With argument
string-pipeline '{template}' "input string"

# With stdin
echo "input" | string-pipeline '{template}'

# Debug mode (shows each step)
string-pipeline '{!split:,:..|map:{upper}}' "a,b,c"
# DEBUG: ═══════════════════════════════════════════════
# DEBUG: PIPELINE START: 2 operations to apply
# DEBUG: Initial input: Str("a,b,c")
# DEBUG: ───────────────────────────────────────────────
# DEBUG: STEP 1/2: Applying Split { sep: ",", range: Range(None, None, false) }
# DEBUG: Input: Str("a,b,c")
# DEBUG: Result: List(3 items: ["a", "b", "c"])
# DEBUG: Step completed in 342.7Β΅s
# DEBUG: ───────────────────────────────────────────────
# DEBUG: STEP 2/2: Applying Map { operations: [Upper] }
# DEBUG: Input: List(["a", "b", "c"])
# DEBUG: MAP OPERATION: Processing 3 items
# DEBUG: β”Œβ”€ Processing item 1 of 3 ─────────────
# DEBUG: β”‚  Input: "a" β†’ Output: "A"
# DEBUG: └────────────────────────────────────────────
# DEBUG: β”Œβ”€ Processing item 2 of 3 ─────────────
# DEBUG: β”‚  Input: "b" β†’ Output: "B"
# DEBUG: └────────────────────────────────────────────
# DEBUG: β”Œβ”€ Processing item 3 of 3 ─────────────
# DEBUG: β”‚  Input: "c" β†’ Output: "C"
# DEBUG: └────────────────────────────────────────────
# DEBUG: MAP COMPLETED: 3 β†’ 3 items
# DEBUG: Result: List(3 items: ["A", "B", "C"])
# DEBUG: Step completed in 15.2841ms
# DEBUG: ───────────────────────────────────────────────
# DEBUG: PIPELINE COMPLETE
# DEBUG: Total execution time: 18.7456ms
# DEBUG: ═══════════════════════════════════════════════
# A,B,C

πŸ¦€ Library Usage

use string_pipeline::Template;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let template = Template::parse("{split:,:..|map:{upper}|join:-}")?;
    let result = template.format("hello,world,rust")?;
    println!("{}", result); // "HELLO-WORLD-RUST"
    Ok(())
}

πŸ“š Documentation

🎯 πŸ“– Template System

πŸ”— βš™οΈ CLI Options & Usage

πŸ› πŸ” Comprehensive Debug System Guide

Everything you need to master String Pipeline:

  • πŸ—οΈ Template Syntax - Structure, chaining, escaping rules
  • πŸ“Š Operations Reference - 20+ operations with examples
    • πŸ”ͺ Split & Join - Parse and reassemble text
    • βœ‚οΈ Slice & Range - Extract with Python-like indices
    • 🎨 Transform - Case, trim, pad, append/prepend
    • πŸ” Regex - Pattern matching and replacement
    • πŸ—‚οΈ List Ops - Filter, sort, unique, reverse
    • πŸ—ΊοΈ Map - Apply operations to each item
  • 🎯 Range Specifications - Negative indexing, edge cases
  • πŸ›‘οΈ Escaping Rules - When and how to escape characters
  • πŸ› Debug Mode - Visual operation debugging
  • πŸ’‘ Real-world Examples - Data processing, log analysis, formatting
  • ⚠️ Troubleshooting - Common errors and best practices

πŸ§ͺ Testing

# Run all tests
cargo test

# Run with output
cargo test -- --nocapture

# Run benchmarks
cargo bench

🀝 Contributing

We welcome contributions! πŸŽ‰

  • πŸ› Report bugs via GitHub Issues
  • πŸ’‘ Suggest features or improvements
  • πŸ”§ Submit pull requests

πŸ“– Please see our comprehensive documentation for syntax details and examples.

πŸ“„ License

This project is licensed under the MIT License. See LICENSE for details.


⚑ Fast, composable string transformations made simple!