TheCloud/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2025-09-14 01:47:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

v.util: polish off diff utils after recent updates and fixes, add doc comments to pub fns (#21275)

Browse Source
This commit is contained in:
Turiiya 2024-04-14 07:58:53 +02:00 committed by GitHub
parent 39600564a9
commit ae5421e76e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 22 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
vlib/v/util/diff.v
View File

@ -2,16 +2,17 @@ module util
import v.util.diff import v.util.diff
// iterates through a list of known diff cli commands // find_working_diff_command returns the first available command from a list of known diff cli tools.
// and returns it with basic options
pub fn find_working_diff_command() !string { pub fn find_working_diff_command() !string {
return diff.find_working_diff_command() return diff.find_working_diff_command()
} }
pub fn color_compare_files(diff_cmd string, file1 string, file2 string) string { // color_compare_files returns a colored diff between two files.
return diff.color_compare_files(diff_cmd, file1, file2) pub fn color_compare_files(diff_cmd string, path1 string, path2 string) string {
return diff.color_compare_files(diff_cmd, path1, path2)
} }
// color_compare_strings returns a colored diff between two strings.
pub fn color_compare_strings(diff_cmd string, unique_prefix string, expected string, found string) string { pub fn color_compare_strings(diff_cmd string, unique_prefix string, expected string, found string) string {
return diff.color_compare_strings(diff_cmd, unique_prefix, expected, found) return diff.color_compare_strings(diff_cmd, unique_prefix, expected, found)
} }

42
vlib/v/util/diff/diff.v
View File

@ -3,8 +3,7 @@ module diff
import os import os
import time import time
// iterates through a list of known diff cli commands // find_working_diff_command returns the first available command from a list of known diff cli tools.
// and returns it with basic options
pub fn find_working_diff_command() !string { pub fn find_working_diff_command() !string {
env_difftool := os.getenv('VDIFF_TOOL') env_difftool := os.getenv('VDIFF_TOOL')
env_diffopts := os.getenv('VDIFF_OPTIONS') env_diffopts := os.getenv('VDIFF_OPTIONS')
@ -16,32 +15,24 @@ pub fn find_working_diff_command() !string {
} }
known_diff_tools := ['colordiff', 'gdiff', 'diff', 'colordiff.exe', 'diff.exe', 'opendiff', known_diff_tools := ['colordiff', 'gdiff', 'diff', 'colordiff.exe', 'diff.exe', 'opendiff',
'code', 'code.cmd'] // NOTE: code.cmd is the Windows variant of the `code` cli tool 'code', 'code.cmd'] // NOTE: code.cmd is the Windows variant of the `code` cli tool
for diffcmd in known_diff_tools { mut diff_cmd := ''
if diffcmd == 'opendiff' { for cmd in known_diff_tools {
os.find_abs_path_of_executable('opendiff') or { continue } os.find_abs_path_of_executable(cmd) or { continue }
return diffcmd diff_cmd = cmd
} break
$if freebsd || openbsd {
if diffcmd == 'diff' { // FreeBSD/OpenBSD diff have no `--version` option
return if env_diffopts != '' { '${diffcmd} ${env_diffopts}' } else { diffcmd }
}
}
p := os.execute('${diffcmd} --version')
if p.exit_code < 0 {
continue
}
if p.exit_code == 0 { // success
if diffcmd in ['code', 'code.cmd'] {
// Make sure the diff flag `-d` is included in any case.
return '${diffcmd} ${env_diffopts} -d'
}
// Don't add spaces to the cmd if there are no `env_diffopts`.
return if env_diffopts != '' { '${diffcmd} ${env_diffopts}' } else { diffcmd }
}
} }
return error('No working "diff" command found') if diff_cmd == '' {
return error('No working "diff" command found')
}
if diff_cmd in ['code', 'code.cmd'] {
// Make sure the diff flag `-d` is included in any case.
return '${diff_cmd} ${env_diffopts} -d'
}
// Don't add spaces to the cmd if there are no `env_diffopts`.
return if env_diffopts != '' { '${diff_cmd} ${env_diffopts}' } else { diff_cmd }
} }
// color_compare_files returns a colored diff between two files.
pub fn color_compare_files(diff_cmd string, path1 string, path2 string) string { pub fn color_compare_files(diff_cmd string, path1 string, path2 string) string {
cmd := diff_cmd.all_before(' ') cmd := diff_cmd.all_before(' ')
os.find_abs_path_of_executable(cmd) or { return 'comparison command: `${cmd}` not found' } os.find_abs_path_of_executable(cmd) or { return 'comparison command: `${cmd}` not found' }
@ -63,6 +54,7 @@ pub fn color_compare_files(diff_cmd string, path1 string, path2 string) string {
return os.execute(full_cmd).output.trim_right('\r\n') return os.execute(full_cmd).output.trim_right('\r\n')
} }
// color_compare_strings returns a colored diff between two strings.
pub fn color_compare_strings(diff_cmd string, unique_prefix string, expected string, found string) string { pub fn color_compare_strings(diff_cmd string, unique_prefix string, expected string, found string) string {
tmp_dir := os.join_path_single(os.vtmp_dir(), unique_prefix) tmp_dir := os.join_path_single(os.vtmp_dir(), unique_prefix)
os.mkdir(tmp_dir) or {} os.mkdir(tmp_dir) or {}