Add test for checking the line length of --help output

There was some discussion what the line length should be.  Most output
currently clearly targets around 80 columns, but the maximum in use
currently is 95, so we set that as the current maximum.  This just
ensures that there is some guidance and there are no wild deviations.

based on patch by Atsushi Torikoshi <torikoshia@oss.nttdata.com>

Discussion: https://www.postgresql.org/message-id/flat/50ca8ff35a8dd8f9ec89963b503571a7@oss.nttdata.com
This commit is contained in:
Peter Eisentraut 2023-10-06 11:52:05 +02:00
parent b4336515b0
commit ffb69b2311
1 changed files with 9 additions and 0 deletions

View File

@ -884,6 +884,15 @@ sub program_help_ok
ok($result, "$cmd --help exit code 0");
isnt($stdout, '', "$cmd --help goes to stdout");
is($stderr, '', "$cmd --help nothing to stderr");
# This value isn't set in stone, it reflects the current
# convention in use. Most output actually tries to aim for 80.
my $max_line_length = 95;
my @long_lines = grep { length > $max_line_length } split /\n/, $stdout;
is(scalar @long_lines, 0, "$cmd --help maximum line length")
or diag("These lines are too long (>$max_line_length):\n",
join("\n", @long_lines));
return;
}