vieter-v
/
v
2
0
Fork 0
Code Issues Pull Requests Releases Activity

ci: fix undoc pub fn diff output (#13389)

pull/13404/head
Larpon 2022-02-07 12:18:10 +01:00 committed by GitHub
parent 10dcb2e0d9
commit 5df83812a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/workflows/docs_ci.yml vendored
View File

@ -33,8 +33,8 @@ jobs:
- name: Check against parent commit - name: Check against parent commit
run: | run: |
./v run cmd/tools/missdoc.v vlib/ | sed -n 's@^.*/vlib/@vlib/@p' | sort > /tmp/n_v.txt ./v run cmd/tools/missdoc.v --no-line-numbers vlib/ | sed -n 's@^.*/vlib/@vlib/@p' | sort > /tmp/n_v.txt
./v run cmd/tools/missdoc.v pv/vlib/ | sed -n 's@^.*/vlib/@vlib/@p' | sort > /tmp/o_v.txt ./v run cmd/tools/missdoc.v --no-line-numbers pv/vlib/ | sed -n 's@^.*/vlib/@vlib/@p' | sort > /tmp/o_v.txt
count_new=$(cat /tmp/n_v.txt | wc -l) count_new=$(cat /tmp/n_v.txt | wc -l)
count_old=$(cat /tmp/o_v.txt | wc -l) count_old=$(cat /tmp/o_v.txt | wc -l)
echo "new pubs: $count_new | old pubs: $count_old" echo "new pubs: $count_new | old pubs: $count_old"

20
cmd/tools/missdoc.v
View File

@ -17,11 +17,12 @@ struct UndocumentedFN {
} }
struct Options { struct Options {
show_help bool show_help bool
collect_tags bool collect_tags bool
deprecated bool deprecated bool
private bool private bool
js bool js bool
no_line_numbers bool
} }
fn collect(path string, mut l []string, f fn (string, mut []string)) { fn collect(path string, mut l []string, f fn (string, mut []string)) {
@ -94,16 +95,20 @@ fn report_undocumented_functions_in_file(opt Options, file string) {
} }
if info.len > 0 { if info.len > 0 {
for undocumented_fn in info { for undocumented_fn in info {
mut line_numbers := '$undocumented_fn.line:0:'
if opt.no_line_numbers {
line_numbers = ''
}
tags_str := if opt.collect_tags && undocumented_fn.tags.len > 0 { tags_str := if opt.collect_tags && undocumented_fn.tags.len > 0 {
'$undocumented_fn.tags' '$undocumented_fn.tags'
} else { } else {
'' ''
} }
if opt.deprecated { if opt.deprecated {
println('$file:$undocumented_fn.line:0:$undocumented_fn.signature $tags_str') println('$file:$line_numbers$undocumented_fn.signature $tags_str')
} else { } else {
if 'deprecated' !in undocumented_fn.tags { if 'deprecated' !in undocumented_fn.tags {
println('$file:$undocumented_fn.line:0:$undocumented_fn.signature $tags_str') println('$file:$line_numbers$undocumented_fn.signature $tags_str')
} }
} }
} }
@ -132,6 +137,7 @@ fn main() {
deprecated: fp.bool('deprecated', `d`, false, 'Include deprecated functions in output.') deprecated: fp.bool('deprecated', `d`, false, 'Include deprecated functions in output.')
private: fp.bool('private', `p`, false, 'Include private functions in output.') private: fp.bool('private', `p`, false, 'Include private functions in output.')
js: fp.bool('js', 0, false, 'Include JavaScript functions in output.') js: fp.bool('js', 0, false, 'Include JavaScript functions in output.')
no_line_numbers: fp.bool('no-line-numbers', 0, false, 'Exclude line numbers in output.')
collect_tags: fp.bool('tags', `t`, false, 'Also print function tags if any is found.') collect_tags: fp.bool('tags', `t`, false, 'Also print function tags if any is found.')
} }
if opt.show_help { if opt.show_help {