TheCloud/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2025-09-18 11:56:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

vdoc: improve vdocignore file handling by walking all .vdocignore sub-paths in IgnoreRules.get, add test (#21521)

Browse Source
This commit is contained in:
Turiiya 2024-05-18 13:30:50 +02:00 committed by GitHub
parent 2a614bd0a8
commit 755cdca249
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 62 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
cmd/tools/vdoc/files.v
View File

@ -14,9 +14,8 @@ mut:
} }
fn get_modules(path string) []string { fn get_modules(path string) []string {
mut ignore_rules := IgnoreRules{}
mut modules := map[string]bool{} mut modules := map[string]bool{}
for p in get_paths(path, mut ignore_rules) { for p in get_paths(path, IgnoreRules.get(path)) {
modules[os.dir(p)] = true modules[os.dir(p)] = true
} }
mut res := modules.keys() mut res := modules.keys()
@ -24,10 +23,9 @@ fn get_modules(path string) []string {
return res return res
} }
fn get_paths(path string, mut ignore_rules IgnoreRules) []string { fn get_paths(path string, ignore_rules IgnoreRules) []string {
mut res := []string{} mut res := []string{}
outer: for p in os.ls(path) or { return [] } { outer: for p in os.ls(path) or { return [] } {
ignore_rules.get(path)
fp := os.join_path(path, p) fp := os.join_path(path, p)
if fp in ignore_rules.paths { if fp in ignore_rules.paths {
continue continue
@ -45,7 +43,7 @@ fn get_paths(path string, mut ignore_rules IgnoreRules) []string {
} }
} }
if is_dir { if is_dir {
res << get_paths(fp, mut ignore_rules) res << get_paths(fp, ignore_rules)
continue continue
} }
if p.ends_with('.v') { if p.ends_with('.v') {
@ -55,30 +53,44 @@ fn get_paths(path string, mut ignore_rules IgnoreRules) []string {
return res return res
} }
fn (mut ignore_rules IgnoreRules) get(path string) { fn IgnoreRules.get(path string) IgnoreRules {
ignore_content := os.read_file(os.join_path(path, '.vdocignore')) or { return } mut res := IgnoreRules{}
if ignore_content.trim_space() == '' { mut vdocignore_paths := []string{}
return mut vdocignore_paths_ref := &vdocignore_paths
} os.walk(path, fn [vdocignore_paths_ref] (p string) {
rules := ignore_content.split_into_lines().map(it.trim_space()) if os.file_name(p) == '.vdocignore' {
for rule in rules { unsafe {
if rule.starts_with('#') { vdocignore_paths_ref << p
}
}
})
for ignore_path in vdocignore_paths {
ignore_content := os.read_file(ignore_path) or { continue }
if ignore_content.trim_space() == '' {
continue continue
} }
if rule.contains('*.') || rule.contains('**') { rules := ignore_content.split_into_lines().map(it.trim_space())
// Skip wildcards that are defined in an ignore file. for rule in rules {
// For now, only add a basic implementation in `get_paths` if rule.starts_with('#') {
// that can handle the default `*_test.v` pattern. continue
eprintln('vdoc: Wildcards in ignore rules are not yet supported.') }
continue if rule.contains('*.') || rule.contains('**') {
} // Skip wildcards that are defined in an ignore file.
if rule.starts_with('/') { // For now, only add a basic implementation in `get_paths`
// Similar to `.gitignore`, a pattern starting with `/` should only ignore // that can handle the default `*_test.v` pattern.
// the pattern relative to the directory of the `.vdocignore` file. eprintln('vdoc: Wildcards in ignore rules are not yet supported.')
// `/a` should ignore `/a` but not `/b/a`. While `a` should ignore `/a` and `/b/a`. continue
ignore_rules.paths[os.join_path(path, rule.trim_left('/'))] = true }
} else { p := os.dir(ignore_path)
ignore_rules.patterns[path] << rule if rule.starts_with('/') {
// Similar to `.gitignore`, a pattern starting with `/` should only ignore
// the pattern relative to the directory of the `.vdocignore` file.
// `/a` should ignore `/a` but not `/b/a`. While `a` should ignore `/a` and `/b/a`.
res.paths[os.join_path(p, rule.trim_left('/'))] = true
} else {
res.patterns[p] << rule
}
} }
} }
return res
} }

32
cmd/tools/vdoc/vdoc_test.v
View File

@ -3,6 +3,19 @@ module main
import os import os
import arrays import arrays
const tpath = os.join_path(os.vtmp_dir(), 'vod_test_module')
fn testsuite_begin() {
os.rmdir_all(tpath) or {}
os.mkdir_all(tpath)!
os.chdir(tpath)!
}
fn testsuite_end() {
os.rmdir_all(tpath) or {}
}
fn test_trim_doc_node_description() { fn test_trim_doc_node_description() {
mod := 'foo' mod := 'foo'
mut readme := '## Description mut readme := '## Description
@ -20,16 +33,17 @@ It also assists with composing and testing baz.'
assert res2 == res assert res2 == res
} }
fn test_ignore_rules() {
os.write_file('.vdocignore', ['pattern1', 'pattern2', '/path1'].join_lines())!
os.mkdir('subdir')!
os.write_file(os.join_path('subdir', '.vdocignore'), ['pattern3', '/path2'].join_lines())!
rules := IgnoreRules.get('.')
assert rules.patterns['.'] == ['pattern1', 'pattern2']
assert rules.patterns['./subdir'] == ['pattern3']
assert rules.paths == {'./path1': true, './subdir/path2': true}
}
fn test_get_module_list() { fn test_get_module_list() {
tpath := os.join_path(os.vtmp_dir(), 'vod_test_module')
os.rmdir_all(tpath) or {}
os.mkdir_all(tpath)!
defer {
os.rmdir_all(tpath) or {}
}
os.chdir(tpath)!
// For information on leading slash rules, refer to the comments in `IgnoreRules.get`. // For information on leading slash rules, refer to the comments in `IgnoreRules.get`.
ignore_rules := ['bravo', '/echo', '/foxtrot/golf', 'hotel.v/', 'india/juliett'] ignore_rules := ['bravo', '/echo', '/foxtrot/golf', 'hotel.v/', 'india/juliett']
os.write_file('.vdocignore', ignore_rules.join_lines())! os.write_file('.vdocignore', ignore_rules.join_lines())!