Skip to content

Commit a2e32cd

Browse files
committed
Make sure all CLI options have POD docs
I also made sure the order in POD matches the order in the help
1 parent 91904aa commit a2e32cd

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

bin/tidyall

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use warnings;
99

1010
our $VERSION = '0.72';
1111

12-
my $usage = '
12+
my $usage = <<'EOF';
1313
Usage: tidyall [options] [file] ...
1414
See https://metacpan.org/module/tidyall for full documentation.
1515
@@ -27,22 +27,22 @@ Options:
2727
-v, --verbose Show extra output
2828
-I I<path1,path2,...> Add one or more paths to @INC
2929
--backup-ttl <duration> Amount of time before backup files can be purged
30-
--check-only Just check each file, don\'t modify
30+
--check-only Just check each file, don't modify
3131
--plugins <name> Explicitly run only the given plugins
3232
--conf-file <path> Relative or absolute path to conf file
3333
--conf-name <name> Conf file name to search for
3434
--data-dir <path> Contains metadata, defaults to root/.tidyall.d
3535
--iterations <count> Number of times to repeat each transform - default is 1
36-
--no-backups Don\'t back up files before processing
37-
--no-cache Don\'t cache last processed times
38-
--no-cleanup Don\'t clean up the temporary files
36+
--no-backups Don't back up files before processing
37+
--no-cache Don't cache last processed times
38+
--no-cleanup Don't clean up the temporary files
3939
--output-suffix <suffix> Suffix to add to tidied file
4040
--refresh-cache Erase any existing cache info before processing each file
4141
--root-dir Specify root directory explicitly
4242
--tidyall-class <class> Subclass to use instead of Code::TidyAll
4343
--version Show version
4444
-h, --help Print help message
45-
';
45+
EOF
4646

4747
sub version {
4848
my $version = $Code::TidyAll::VERSION || 'unknown';
@@ -528,10 +528,6 @@ than once.
528528
529529
Process all added or modified files in the current git working directory.
530530
531-
=item -h, --help
532-
533-
Print help message
534-
535531
=item -l, --list
536532
537533
List each file along with the list of plugins it matches (files without any
@@ -613,6 +609,16 @@ not. This is used by L<Test::Code::TidyAll> and the
613609
L<svn|Code::TidyAll::SVN::Precommit> and L<git|Code::TidyAll::Git::Precommit>
614610
pre-commit hooks, for example, to enforce that you've tidied your files.
615611
612+
=item --plugins I<name>
613+
614+
Only run the specified plugins. The name should match the name given in the
615+
config file exactly, including a leading "+" if one exists.
616+
617+
This overrides the C<--mode> option.
618+
619+
Note that plugins will still only run on files which match their C<select> and
620+
C<ignore> configuration.
621+
616622
=item --conf-file I<path>
617623
618624
Specify relative or absolute path to conf file, instead of searching for it in
@@ -651,15 +657,9 @@ Don't backup files before processing.
651657
Don't cache last processed times; process all files every time. See also
652658
C<--refresh-cache>.
653659
654-
=item --plugins I<name>
655-
656-
Only run the specified plugins. The name should match the name given in the
657-
config file exactly, including a leading "+" if one exists.
660+
=item --no-cleanup
658661
659-
This overrides the C<--mode> option.
660-
661-
Note that plugins will still only run on files which match their C<select> and
662-
C<ignore> configuration.
662+
Don't clean up termporary files.
663663
664664
=item --output-suffix I<suffix>
665665
@@ -680,6 +680,14 @@ files or the current working directory.
680680
681681
Subclass to use instead of C<Code::TidyAll>.
682682
683+
=item --version
684+
685+
Show the version of L<Code::TidyAll> that this script invokes.
686+
687+
=item -h, --help
688+
689+
Print help message
690+
683691
=back
684692
685693
=head2 Specifying options in configuration

0 commit comments

Comments
 (0)