include-file 0.1.0

Include sections of files into Rust source code
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# Macros for including file content

[![releases](https://img.shields.io/github/v/release/heaths/include-file.svg?logo=github)](https://github.com/heaths/include-file/releases/latest)
[![docs](https://img.shields.io/docsrs/include-file?logo=rust)](https://docs.rs/include-file)
[![ci](https://github.com/heaths/include-file/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/heaths/include-file/actions/workflows/ci.yml)

Macros like `include_code!("../README.md", "example")` allow you to include incomplete code from markdown code fences.
Though Rust doc tests let you hide setup code from being rendered, you cannot do the same when rendering markdown.
You can demonstrate just the code you want in markdown while maintaining the benefit of compiling it in tests.

## Examples

The `include_code!()` macro, like Rust's built-in `include_str!()`, resolves a file path relative to the current source file.

Consider a crate `README.md` with the following content:

````markdown
The `example()` function returns a model that implements `Debug` so you can easily print it:

```rust example
let m = example()?;
assert_eq!(format!("{m:?}"), r#"Model { name: "example" }"#);
```
````

We didn't define the `example()` function nor the type of `x`. In Rust doc tests you could do so with lines prefaced with `#` e.g.:

```rust
/// ```
/// # #[derive(Debug)] struct Model { name: String }
/// # fn example() -> Result<Model, Box<dyn std::error::Error>> { Ok(Model { name: "example".into() }) }
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let m = example()?;
/// println!("{m:#?}");
/// # Ok(()) }
/// ```
```

All those lines would render in a markdown file. Instead, we could use `include_code!("../README.md", "example")` to include the example content from `README.md` above in a test to make sure it compiles and even runs.

```rust
#[derive(Debug)]
struct Model {
    name: String,
}

fn example() -> Result<Model, Box<dyn std::error::Error>> {
    Ok(Model {
        name: "example".into(),
    })
}

#[test]
fn test_example() -> Result<(), Box<dyn std::error::Error>> {
    include_code!("../README.md", "example");
    Ok(())
}
```

## License

Licensed under the [MIT](LICENSE.txt) license.