ddoc 0.16.0

doc site generator
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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

#:schema https://dystroy.org/bacon/.bacon.schema.json

# This is a configuration file for the bacon tool
#
# Complete help on configuration: https://dystroy.org/bacon/config/
#
# You may check the current default at
#   https://github.com/Canop/bacon/blob/main/defaults/default-bacon.toml

default_job = "check"
env.CARGO_TERM_COLOR = "always"
env.DDOC_LOG = "debug"

ignore = [
    "examples/columns/site",
    "examples/columns/site/*"
]

[jobs.check]
command = ["cargo", "check"]
need_stdout = false

[jobs.check-all]
command = ["cargo", "check", "--all-targets"]
need_stdout = false

# Run clippy on the default target
[jobs.clippy]
command = ["cargo", "clippy"]
need_stdout = false

[jobs.clippy-all]
command = [
    "cargo", "clippy",
    "--all-targets",
    "--",
    "-A", "clippy::bool_to_int_with_if",
    "-A", "clippy::collapsible_if",
    "-A", "clippy::collapsible_else_if",
    "-A", "clippy::derive_partial_eq_without_eq",
]
need_stdout = false

# Run clippy in pedantic mode
# The 'dismiss' feature may come handy
[jobs.pedantic]
command = [
	"cargo", "clippy",
	"--",
	"-W", "clippy::pedantic",
    "-A", "clippy::needless_raw_string_hashes",
    "-A", "clippy::struct_excessive_bools",
    "-A", "clippy::wildcard_imports",
    "-A", "clippy::must_use_candidate",
    "-A", "clippy::map_unwrap_or",
    "-A", "clippy::uninlined_format_args",
    "-A", "clippy::match_same_arms",
    "-A", "clippy::redundant-else",
    "-A", "clippy::unnecessary_debug_formatting",
    "-A", "clippy::return-self-not-must-use",
]
need_stdout = false

# This job lets you run
# - all tests: bacon test
# - a specific test: bacon test -- config::test_default_files
# - the tests of a package: bacon test -- -- -p config
[jobs.test]
command = ["cargo", "test"]
need_stdout = true

[jobs.nextest]
command = [
    "cargo", "nextest", "run",
    "--hide-progress-bar", "--failure-output", "final"
]
need_stdout = true
analyzer = "nextest"

[jobs.doc]
command = ["cargo", "doc", "--no-deps"]
need_stdout = false

# If the doc compiles, then it opens in your browser and bacon switches
# to the previous job
[jobs.doc-open]
command = ["cargo", "doc", "--no-deps", "--open"]
need_stdout = false
on_success = "back" # so that we don't open the browser at each change

# Run on the bacon directory
[jobs.run]
command = [
    "cargo", "run",
    "--",
    "/home/dys/dev/bacon/ddoc",
]
need_stdout = true
allow_warnings = true
background = true

[jobs.serve]
command = [
    "cargo", "run",
    "--",
    "--serve",
    "website"
]
watch = ["resources"]
need_stdout = true
need_stderr = true
allow_warnings = true
background = false
on_change_strategy = "kill_then_restart"

[jobs.example]
command = [
    "cargo", "run",
    "--",
    "--serve",
    "examples/columns"
]
watch = ["resources"]
need_stdout = true
need_stderr = true
allow_warnings = true
background = false
on_change_strategy = "kill_then_restart"

# You may define here keybindings that would be specific to
# a project, for example a shortcut to launch a specific job.
# Shortcuts to internal functions (scrolling, toggling, etc.)
# should go in your personal global prefs.toml file instead.
[keybindings]
c = "job:clippy-all" # comment this to have 'c' run clippy on only the default target
p = "job:pedantic" 
s = "job:serve"
e = "job:example"