mdbook-yapp 2.0.2

mdBook preprocessor for simple text replacements
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
105
106

version: '3'

silent: true

tasks:

  build:
    desc: Builds in debug mode
    cmds:
      - cmd: cargo +stable build

  clean:
    desc: Cleans all targets
    cmds:
      - cmd: cargo +stable clean

  clippy:
    desc: Runs clippy for all targets
    cmds:
      - cmd: cargo +stable clippy --all-targets

  cov-data:
    desc: Generates code coverage data
    cmds:
      - cmd: cargo +stable llvm-cov clean
      - cmd: cargo +stable llvm-cov --no-cfg-coverage --no-report

  cov:
    desc: Generates code coverage report in text format
    cmds:
      - task: cov-data
      - cmd: cargo +stable llvm-cov report

  cov-html:
    desc: Generates code coverage report in HTML format
    cmds:
      - task: cov-data
      - cmd: cargo +stable llvm-cov report --html

  cov-html-open:
    desc: Generates code coverage report in HTML format and opens in browser
    cmds:
      - task: cov-data
      - cmd: cargo +stable llvm-cov report --html --open

  cov-badge:
    desc: Generates the detailed code coverage badge
    cmds:
      - task: cov-data
      - cmd: cargo +stable llvm-cov report --json --summary-only | coverio -l coverage -c --tag cov-badge

  doc:
    desc: Generates documentation
    cmds:
      - cmd: cargo +stable doc --no-deps

  doc-open:
    desc: Generates documentation and opens in browser
    cmds:
      - cmd: cargo +stable doc --no-deps --open

  doc-priv:
    desc: Generates documentation
    cmds:
      - cmd: cargo +stable doc --no-deps --document-private-items

  doc-priv-open:
    desc: Generates documentation and opens in browser
    cmds:
      - cmd: cargo +stable doc --no-deps --document-private-items --open

  fmt:
    desc: Runs code formatter
    cmds:
      - cmd: cargo +nightly fmt

  install:
    desc: Installs preprocessor locally
    cmds:
      - cmd: cargo +stable install mdbook-yapp --path . --force

  readme:
    desc: Regenerates README.md file
    cmds:
      - cmd: magg readme docs/README.md
      - task: cov-badge

  release:
    desc: Builds in release mode
    cmds:
      - cmd: cargo +stable build --release

  test:
    desc: Tests in debug mode
    cmds:
      - cmd: cargo +stable test

  testn:
    desc: Tests in debug mode using nextest
    cmds:
      - cmd: cargo +stable nextest run

  uninstall:
    desc: Uninstalls preprocessor
    cmds:
      - cmd: cargo uninstall mdbook-yapp