mirror of
https://github.com/ipfs/kubo.git
synced 2025-07-02 03:28:25 +08:00
Merge pull request #3774 from ipfs/feat/docs/80-chars
Add 80 columns mans tests
This commit is contained in:
@ -62,26 +62,42 @@ test_expect_success "'ipfs commands' output looks good" '
|
||||
'
|
||||
|
||||
test_expect_success "All commands accept --help" '
|
||||
echo 0 > fail
|
||||
while read -r cmd
|
||||
do
|
||||
$cmd --help </dev/null >/dev/null ||
|
||||
{ echo $cmd doesnt accept --help; FAIL=1; }
|
||||
{ echo $cmd doesnt accept --help; echo 1 > fail; }
|
||||
done <commands.txt
|
||||
|
||||
if [ ${FAIL-0} = 1 ]; then
|
||||
if [ $(cat fail) = 1 ]; then
|
||||
return 1
|
||||
fi
|
||||
'
|
||||
|
||||
test_expect_failure "All ipfs root commands are mentioned in base helptext" '
|
||||
cut -d" " -f 2 commands.txt | sort -u | \
|
||||
echo 0 > fail
|
||||
cut -d" " -f 2 commands.txt | grep -v ipfs | sort -u | \
|
||||
while read cmd
|
||||
do
|
||||
grep " $cmd" help.txt > /dev/null ||
|
||||
{ echo missing $cmd from helptext; FAIL=1; }
|
||||
{ echo missing $cmd from helptext; echo 1 > fail; }
|
||||
done
|
||||
|
||||
if [ ${FAIL-0} = 1 ]; then
|
||||
if [ $(cat fail) = 1 ]; then
|
||||
return 1
|
||||
fi
|
||||
'
|
||||
|
||||
test_expect_failure "All ipfs commands docs are 80 columns or less" '
|
||||
echo 0 > fail
|
||||
while read cmd
|
||||
do
|
||||
LENGTH="$($cmd --help | awk "{ print length }" | sort -nr | head -1)"
|
||||
[ $LENGTH -gt 80 ] &&
|
||||
{ echo "$cmd" help text is longer than 79 chars "($LENGTH)"; echo 1 > fail; }
|
||||
done <commands.txt
|
||||
|
||||
if [ $(cat fail) = 1 ]; then
|
||||
return 1
|
||||
fi
|
||||
'
|
||||
|
Reference in New Issue
Block a user