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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
//! Command line tool for [mantra](https://github.com/mhatzl/mantra).
//! See the [requirements section](https://github.com/mhatzl/mantra/wiki/5-Requirements)
//! in the [wiki](https://github.com/mhatzl/mantra/wiki) for more info on how to manage requirements with *mantra*.
//!
//! **Available commands:**
//!
//! - `check`
//!
//! ```text
//! Checks wiki structure and references in the project.
//!
//! [req:check]
//!
//! Usage: mantra check [OPTIONS] <REQ_FOLDER> [PROJ_FOLDER]
//!
//! Arguments:
//! <REQ_FOLDER>
//! The folder that is searched recursively for defined requirements.
//!
//! [req:wiki]
//!
//! [PROJ_FOLDER]
//! The folder that is searched recursively for requirement references. If not set, the current folder is used
//!
//! [default: ./]
//!
//! Options:
//! --branch-name <BRANCH_NAME>
//! The name of the branch project references should be validated against in the wiki. If not set, 'main' is used as default branch.
//!
//! [req:wiki.ref_list]
//!
//! [default: main]
//!
//! --repo-name <REPO_NAME>
//! Optional repository name in case multiple repositories point to the same wiki.
//!
//! [req:wiki.ref_list.repo]
//!
//! -h, --help
//! Print help (see a summary with '-h')
//! ```
//!
//! - `release`
//!
//! ```text
//! Creates a release report.
//!
//! [req:release]
//!
//! Usage: mantra release [OPTIONS] --release-tag <RELEASE_TAG> <REQ_FOLDER>
//!
//! Arguments:
//! <REQ_FOLDER>
//! The folder that is searched recursively for defined requirements.
//!
//! [req:wiki]
//!
//! Options:
//! --branch <BRANCH>
//! The branch name to create the overview for. Is used as first branch for comparisons
//!
//! [default: main]
//!
//! --release-tag <RELEASE_TAG>
//! The tag/version for this release
//!
//! --wiki-url-prefix <WIKI_URL_PREFIX>
//! An optional URL prefix for links to the wiki. This options must be set if links to the wiki should be added in the report.
//!
//! [req:release]
//!
//! --report-file <REPORT_FILE>
//! An optional filepath for the report. If this option is not set, the report is printed to stdout.
//!
//! **Note:** The report will be a markdown file, so the given extension is ignored.
//!
//! --checklist
//! Set this flag to turn this report into a checklist for requirements tagged with *manual*.
//!
//! [req:release.checklist]
//!
//! --repo-name <REPO_NAME>
//! Optional repository name in case multiple repositories point to the same wiki.
//!
//! [req:wiki.ref_list.repo]
//!
//! -h, --help
//! Print help (see a summary with '-h')
//! ```
//!
//! - `status`
//!
//! ```text
//! Creates status overview of the wiki.
//!
//! [req:status]
//!
//! Usage: mantra status [OPTIONS] <REQ_FOLDER>
//!
//! Arguments:
//! <REQ_FOLDER>
//! The folder that is searched recursively for defined requirements.
//!
//! [req:wiki]
//!
//! Options:
//! --branch <BRANCH>
//! The branch name to create the overview for. Is used as first branch for comparisons.
//!
//! [req:status.branch], [req:status.cmp]
//!
//! [default: main]
//!
//! --repo-name <REPO_NAME>
//! Optional repository name for the `branch` option in case multiple repositories point to the same wiki.
//!
//! [req:wiki.ref_list.repo]
//!
//! --cmp-branch <CMP_BRANCH>
//! An optional branch to compare against the branch set with `--branch`.
//!
//! [req:status.cmp]
//!
//! --cmp-repo-name <CMP_REPO_NAME>
//! Optional repository name for the `cmp-branch` option in case multiple repositories point to the same wiki.
//!
//! [req:wiki.ref_list.repo]
//!
//! --detail-ready
//! Flag to output detailed information about *ready* requirements.
//!
//! [req:status.branch]
//!
//! --detail-active
//! Flag to output detailed information about *active* requirements.
//!
//! [req:status.branch]
//!
//! --detail-deprecated
//! Flag to output detailed information about *deprecated* requirements.
//!
//! [req:status.branch]
//!
//! --detail-manual
//! Flag to output detailed information about requirements flagged to require *manual* verification.
//!
//! [req:status.branch]
//!
//! -h, --help
//! Print help (see a summary with '-h')
//! ```
//!
//! - `sync`
//!
//! ```text
//! Synchronizes references between wiki and project.
//!
//! [req:sync]
//!
//! Usage: mantra.exe sync [OPTIONS] <REQ_FOLDER> [PROJ_FOLDER]
//!
//! Arguments:
//! <REQ_FOLDER>
//! The folder that is searched recursively for defined requirements.
//!
//! [req:wiki]
//!
//! [PROJ_FOLDER]
//! The folder that is searched recursively for requirement references. If not set, the current folder is used
//!
//! [default: ./]
//!
//! Options:
//! --branch-name <BRANCH_NAME>
//! The name of the branch project references should be synchronized to in the wiki. If not set, 'main' is used as default branch.
//!
//! [req:wiki.ref_list]
//!
//! [default: main]
//!
//! --branch-link <BRANCH_LINK>
//! Optional link to the branch.
//!
//! [req:wiki.ref_list.branch_link]
//!
//! --repo-name <REPO_NAME>
//! Optional repository name in case multiple repositories point to the same wiki.
//!
//! [req:wiki.ref_list.repo]
//!
//! -h, --help
//! Print help (see a summary with '-h')
//! ```
use crateCli;
use Parser;
use ;