present 0.2.3

//! `present` is a simple tool that lets you interpolate the standard output of
//! arbitrary scripts that get interpreted by the shell into your markdown
//! documents.
//!
//! With `present`, you can create a `File` struct by pointing it to a path.
//! This will parse all codeblocks with the `present` prefix, and add them as
//! commands to the struct. From there, you can present the file by using the
//! `File::present` function, which will modify the internal content. From
//! there, you can use the `File::print` or `File::save` functions to print the
//! presented document to stdout or save it back to the original file.
//!
//! ```rust
//! use std::path::PathBuf;
//!
//! let mut file = present::File::new(PathBuf::from("README.md")).unwrap();
//! file.present().unwrap();
//! file.save();
//! ```

mod codeblock;
mod command;
mod common;
mod diff;
mod error;
mod file;
mod grapheme;
mod lexer;
mod parser;
mod position;
mod prompt;
mod rope_ext;

// Publicly exposed
pub use crate::{diff::Diff, error::Error, file::File};

// Public only to crate
pub(crate) use crate::{
  codeblock::Codeblock,
  command::Command,
  grapheme::{byte_index_to_grapheme_index, grapheme_index_to_byte_index},
  lexer::Lexer,
  parser::Parser,
  position::Position,
  prompt::prompt,
  rope_ext::RopeExt,
};

/// Present's internal result type
pub type Result<T = (), E = Error> = std::result::Result<T, E>;

// Test README
#[doc = include_str!("../README.md")]
#[cfg(doctest)]
pub struct ReadmeDoctests;