Skip to content

Commit a60c38d

Browse files
committed
Add docs target for eure check
1 parent 23392a6 commit a60c38d

3 files changed

Lines changed: 179 additions & 2 deletions

File tree

Eure.eure

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
// Eure project configuration
22

3+
$schema = "assets/schemas/eure-config.schema.eure"
4+
35
@ targets.adr
46
globs = ["docs/adrs/**/*.eure"]
57
schema = "assets/schemas/eure-adr.schema.eure"
68

9+
@ targets.docs
10+
globs = ["docs/*.eure", "docs/spec/**/*.eure"]
11+
schema = "assets/schemas/eure-docs.schema.eure"
12+
713
@ targets.schemas
814
globs = ["assets/schemas/**/*.eure"]
915
schema = "assets/schemas/eure-schema.schema.eure"
@@ -16,4 +22,4 @@ globs = ["test-suite/cases/**/*.eure"]
1622
schema = "assets/schemas/test-suite-case.schema.eure"
1723

1824
@ cli
19-
default-targets = ["adr", "schemas", "examples", "test-suite-cases"]
25+
default-targets = ["docs", "adr", "schemas", "examples", "test-suite-cases"]

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ test-suite:
3131
@cargo run --quiet --offline -p test-suite -- --quiet
3232

3333
eure-check:
34-
@cargo run --quiet --offline --bin eure -- check --offline schemas adr test-suite-cases --quiet
34+
@cargo run --quiet --offline --bin eure -- check --offline --quiet --all
Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
= `$types.docs-root`
2+
3+
$schema = "eure-schema.schema.eure"
4+
5+
@ $types.docs-root {
6+
$variant: union
7+
$interop.variant-repr = "untagged"
8+
variants.guide = `$types.docs-guide`
9+
variants.nav = `$types.docs-nav`
10+
}
11+
12+
@ $types.alert-kind {
13+
$variant: union
14+
$interop.variant-repr = "untagged"
15+
variants.note = { = "NOTE", $variant => "literal" }
16+
variants.tip = { = "TIP", $variant => "literal" }
17+
variants.important = { = "IMPORTANT", $variant => "literal" }
18+
variants.warning = { = "WARNING", $variant => "literal" }
19+
variants.caution = { = "CAUTION", $variant => "literal" }
20+
}
21+
22+
@ $types.mark-options {
23+
$variant: record
24+
alert = `$types.alert-kind`
25+
alert.$optional = true
26+
"dangerously-inner-html" = `boolean`
27+
"dangerously-inner-html".$optional = true
28+
}
29+
30+
@ $types.docs-text {
31+
$variant: text
32+
$ext-type.mark = `$types.mark-options`
33+
$ext-type.mark.$optional = true
34+
}
35+
36+
@ $types.level1-content {
37+
$variant: union
38+
$interop.variant-repr = "untagged"
39+
variants.text = `$types.docs-text`
40+
variants.nested {
41+
"##" = `text`
42+
$flatten = [`$types.level1-content-map`]
43+
}
44+
variants.toc {
45+
$ext-type.toc = `boolean`
46+
}
47+
}
48+
49+
@ $types.level1-content-map {
50+
$variant: map
51+
key {
52+
$variant: text
53+
pattern = regex`[^#]+.*`
54+
}
55+
value {
56+
$variant: union
57+
$interop.variant-repr = "untagged"
58+
variants.normal = `$types.level2-content`
59+
variants.list = [`$types.level2-content`]
60+
}
61+
}
62+
63+
@ $types.level2-content {
64+
$variant: union
65+
$interop.variant-repr = "untagged"
66+
variants.text = `$types.docs-text`
67+
variants.nested {
68+
"###" = `text`
69+
$unknown-fields = `$types.level3-content-set`
70+
}
71+
}
72+
73+
@ $types.level3-content-set {
74+
$variant: union
75+
$interop.variant-repr = "untagged"
76+
variants.normal = `$types.level3-content`
77+
variants.list = [`$types.level3-content`]
78+
}
79+
80+
@ $types.level3-content {
81+
$variant: union
82+
$interop.variant-repr = "untagged"
83+
variants.text = `$types.docs-text`
84+
variants.nested {
85+
"####" = `text`
86+
$unknown-fields = `$types.level4-content-set`
87+
}
88+
}
89+
90+
@ $types.level4-content-set {
91+
$variant: union
92+
$interop.variant-repr = "untagged"
93+
variants.normal = `$types.level4-content`
94+
variants.list = [`$types.level4-content`]
95+
}
96+
97+
@ $types.level4-content {
98+
$variant: union
99+
$interop.variant-repr = "untagged"
100+
variants.text = `$types.docs-text`
101+
variants.nested {
102+
"#####" = `text`
103+
$unknown-fields = `$types.level5-content-set`
104+
}
105+
}
106+
107+
@ $types.level5-content-set {
108+
$variant: union
109+
$interop.variant-repr = "untagged"
110+
variants.normal = `$types.level5-content`
111+
variants.list = [`$types.level5-content`]
112+
}
113+
114+
@ $types.level5-content {
115+
$variant: union
116+
$interop.variant-repr = "untagged"
117+
variants.text = `$types.docs-text`
118+
variants.nested {
119+
"######" = `text`
120+
$unknown-fields = `$types.level6-content-set`
121+
}
122+
}
123+
124+
@ $types.level6-content-set {
125+
$variant: union
126+
$interop.variant-repr = "untagged"
127+
variants.normal = `$types.docs-text`
128+
variants.list = [`$types.docs-text`]
129+
}
130+
131+
@ $types.docs-nav-entry {
132+
$variant: record
133+
path = `text`
134+
label = `text`
135+
}
136+
137+
@ $types.docs-nav-group {
138+
$variant: record
139+
title = `text`
140+
description = `text`
141+
description.$optional = true
142+
pages = [`$types.docs-nav-entry`]
143+
}
144+
145+
@ $types.docs-nav {
146+
$variant: record
147+
title = `text`
148+
title.$optional = true
149+
groups = [`$types.docs-nav-group`]
150+
}
151+
152+
@ $types.docs-guide {
153+
$variant: record
154+
"#" = `text`
155+
$ext-type.docs {
156+
title = `text`
157+
description = `text`
158+
order = `integer`
159+
order.$optional = true
160+
tags = [`text`]
161+
tags.$optional = true
162+
}
163+
$unknown-fields = `$types.level1-content-set`
164+
}
165+
166+
@ $types.level1-content-set {
167+
$variant: union
168+
$interop.variant-repr = "untagged"
169+
variants.normal = `$types.level1-content`
170+
variants.list = [`$types.level1-content`]
171+
}

0 commit comments

Comments
 (0)