misalcedo / literate-rs Goto Github PK

Implement a simple CLI and library that extracts code blocks matching a pattern and returns the output concatenated into a rope (list of strings appearing as one string).

See https://crates.io/crates/pulldown-cmark

• Add instructions to the README on how to install
• Add doc comments for the public interface of the library.
• Add tests for the public interface of the library.
• Create example of how to integrate the library, for example how we plan to use it for Tortuga
• Document all features

Extract shared arg into a struct for the extract and walk commands.

Add an optional feature to walk a directory tree, filter files, apply extraction, and write to a new file.

The library needs a new function to walk the dir tree that takes a file matcher, input path, language matcher, and file renamed.

The output path is determined by the file renamed to allow for changing the tree structure during the walk.

The library needs to provide a default file filter for a file extension of choice that is .ext.md and a file renamed that maintains the input structure but strips off the .md extension.

Finally add this to the cli as a new command and leave the old functionality as the default / no command.

Rust println and write fail when used with head with a BrokenPipe. Need to catch this error in the CLI so that extract can work with head, tail, more, and less

Integrate literate's walk functionality with Cargo by adding it to a build.rs file.

Add CLI arguments to pass in files instead of stdin and stdout.