Skip to content

Commit dfe067e

Browse files
authored
Add bacon config (#721)
Adds a bacon config which is useful when writing rustdoc. `bacon doc-internal-open` will re-build the doc on changes.
1 parent 21ad6b2 commit dfe067e

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

bacon.toml

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# This is a configuration file for the bacon tool
2+
#
3+
# Bacon repository: https://github.com/Canop/bacon
4+
# Complete help on configuration: https://dystroy.org/bacon/config/
5+
# You can also check bacon's own bacon.toml file
6+
# as an example: https://github.com/Canop/bacon/blob/main/bacon.toml
7+
8+
default_job = "check"
9+
10+
[jobs.check]
11+
command = ["cargo", "check", "--color", "always"]
12+
need_stdout = false
13+
14+
[jobs.check-all]
15+
command = ["cargo", "check", "--all-targets", "--color", "always"]
16+
need_stdout = false
17+
18+
[jobs.clippy]
19+
command = ["cargo", "clippy", "--all-targets", "--color", "always"]
20+
need_stdout = false
21+
22+
[jobs.test]
23+
command = [
24+
"cargo",
25+
"test",
26+
"--all-features",
27+
"--color",
28+
"always",
29+
"--",
30+
"--color",
31+
"always", # see https://github.com/Canop/bacon/issues/124
32+
]
33+
need_stdout = true
34+
35+
[jobs.doc]
36+
command = ["cargo", "doc", "--color", "always", "--no-deps"]
37+
need_stdout = false
38+
39+
# If the doc compiles, then it opens in your browser and bacon switches
40+
# to the previous job
41+
[jobs.doc-open]
42+
command = ["cargo", "doc", "--color", "always", "--no-deps", "--open"]
43+
need_stdout = false
44+
on_success = "back" # so that we don't open the browser at each change
45+
46+
[jobs.doc-internal]
47+
command = [
48+
"cargo",
49+
"doc",
50+
"--color",
51+
"always",
52+
"--no-deps",
53+
"--all-features",
54+
"--document-private-items",
55+
]
56+
need_stdout = false
57+
58+
[jobs.doc-internal-open]
59+
command = [
60+
"cargo",
61+
"doc",
62+
"--color",
63+
"always",
64+
"--no-deps",
65+
"--all-features",
66+
"--document-private-items",
67+
"--open",
68+
]
69+
need_stdout = false
70+
on_success = "back"
71+
72+
# You may define here keybindings that would be specific to
73+
# a project, for example a shortcut to launch a specific job.
74+
# Shortcuts to internal functions (scrolling, toggling, etc.)
75+
# should go in your personal global prefs.toml file instead.
76+
[keybindings]
77+
# alt-m = "job:my-job"

0 commit comments

Comments
 (0)