rice

rice is a Rust library and CLI tool for "splicing" external files into a target file using special comment directives. It's designed to make it easy to manage components or dependencies within files, especially useful for AI agent context or project configuration.

Features

• Directives: Use @path/to/file to include a file's content.
• In-place updates: Re-running rice updates the content between [[begin path]] and [[end]] markers.
• Extensible API: Use the Rust library to implement custom resolution logic (e.g., fetching from URLs or databases).
• Comment-aware: Markers can be wrapped in any comment style to match your file type.

Installation

Binary

cargo install --path .

Library

Add rice to your Cargo.toml:

[dependencies]
rice = { git = "https://github.com/portal-co/rice.git" }

CLI Usage

Process a file in-place:

rice path/to/file.ext

How it works

If you have a file main.py:

# @utils.py

And utils.py:

def add(a, b):
    return a + b

Running rice main.py will transform it into:

# @utils.py
[[begin utils.py]]
def add(a, b):
    return a + b
[[end]]

If you modify utils.py and run rice main.py again, the content between the [[begin]] and [[end]] markers will be updated.

Library Usage

Basic Splicing

use std::io::Cursor;

let input = "@hello.txt";
let mut output = Vec::new();

// Uses the default FileResolver
rice::splice(input, &mut output).unwrap();

Custom Resolver

You can implement the Resolver trait to handle custom paths (e.g., virtual file systems or remote URLs).

use rice::{Resolver, splice_with};
use std::io::Write;

struct MyResolver;

impl Resolver for MyResolver {
    fn resolve(&mut self, path: &str, out: &mut (dyn Write + '_)) -> std::io::Result<()> {
        if path == "virtual:hello" {
            write!(out, "Hello from the resolver!")?;
        }
        Ok(())
    }
}

let mut output = Vec::new();
splice_with("@virtual:hello", &mut output, MyResolver).unwrap();

Future Prospects

• File sections: Splice specific marked sections from files rather than entire files, using similar marker syntax.
• Remote resources: Resolve and splice content from URLs, databases, or other remote sources via custom resolvers.

---

AI assisted