snipdoc 0.1.12

Code Documentation Made Simple
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

Expected to inject `readme` from the code and strip the prefix `//!`
<!-- <snip id="readme" inject_from="code" strip_prefix="//!"> -->

 # Snipdoc: Code Documentation Made Simple
 readme after title
<!-- </snip> -->


Expected to inject `title` from the code and strip the prefix `//!`
<!-- <snip id="title" inject_from="code" strip_prefix="//!"> --> # Snipdoc: Code Documentation Made Simple
<!-- </snip> -->

Expected to inject `rust-print` from the code 
```rust
<!-- <snip id="rust-print" inject_from="code"> -->
fn main() {
    println!("Welcome to Snipdoc")
}
<!-- </snip> -->
```

# Usage commands
Expected to inject `create-db` from the code 
<!-- <snip id="create-db" inject_from="code"> -->
  ```sh
    snipdoc create-db
  ```
<!-- </snip> -->

Expected to skip injection as the content of the snippet is the same
<!-- <snip id="inject-snippets" inject_from="code"> -->
  ```sh
    snipdoc run
  ```
<!-- </snip> -->

Expected to ignore this section since the `not-found-snippet-to-inject` snippet id does not exist
<!-- <snip id="not-found-snippet-to-inject" inject_from="code"> -->
<!-- </snip> -->


Expected to inject only `inject-from-yaml` snippet id from the YAML snippets configuration
<!-- <snip id="inject-from-yaml" inject_from="yaml"> -->
Inject from YAML file
<!-- </snip> -->

Expected to skip injections since `inject_from` is configured to inject from the code and not from the YAML
<!-- <snip id="inject-from-yaml" inject_from="code"> -->
<!-- </snip> -->


Expected to inject only `inject-from-yaml` snippet id from the YAML. the `inject_from` value is `any` which means if snippet id found in one of the data source it injected
<!-- <snip id="inject-from-yaml" inject_from="any"> -->
Inject from YAML file
<!-- </snip> -->

Expected to skip inject, see in `snipdoc-config.yml` file that the path of this snippet is excluded from the run
<!-- <snip id="should-ignore" inject_from="code"> -->

<!-- </snip> -->


Expected to inject the content of the snippet with the given template
<!-- <snip id="config-template" inject_from="code" template="```yaml /n {snippet} /n ```"> -->
```yaml 
 snippets:
  inject-from-yaml:
    content: |-
      Inject from YAML file
    path: main.rs 
 ```
<!-- </snip> -->

Expected to inject the content of the snippet with the pre-defined template
<!-- <snip id="config-template" inject_from="code" template="yaml"> -->
```yaml
snippets:
  inject-from-yaml:
    content: |-
      Inject from YAML file
    path: main.rs
```
<!-- </snip> -->


<!-- <snip id="rust-print" inject_from="code" template="wrap_impl"> -->
```rust
impl test {
    fn main() {
        println!("Welcome to Snipdoc")
    }
}
```
<!-- </snip> -->

Expected to inject the content of the snippet with the given template with a different comment tag
# <snip id="config-template" inject_from="code" template="```yaml /n {snippet} /n ```"> ```yaml 
 snippets:
  inject-from-yaml:
    content: |-
      Inject from YAML file
    path: main.rs 
 ```
# </snip>