LEOCHARRE::CLI2 - quick cli addons
In script.pl:
use LEOCHARRE::CLI2
'ko:', # options
':all', # subs to import
'This program shows example usage.', # description of what script does
'(manpage suggested)', # where to look for more info in man pages
'[parent package name], # parent package name
'argv_cwd', # explicit sub import name
;
our $VERSION = 1;
$opt_o or die("Missing -o opt");
my @files_selected = argv_files();
my @base_dir_selected = argv_cwd();
my @all_dirs_selected = argv_dirs();
my ($countfiles, $countdirs) = ( argv_dirs_count(), argv_files_count() );
debug("You chose $countfiles files and $countdirs dirs.");
Then to get help:
$ script.pl -h
To get version:
$ script.pl -v
To see debug:
$ script.pl -d -o "my value" ./files* ./dirs*
Automates help, debug, version etc. If you use LEOCHARRE::CLI2, we alter the OPTIONS automatically. Also we automatically generate HELP.
New environment variables are set. The are..
Holds name of your script, no leading path. Is accessible to main.
If you define this, and you don't define usage(), the usage help output generated will contain this string.
use LEOCHARRE::CLI2 'This is a script description because it has spaces.';
When -h is called, if there is not usage() defined, this would spit out:
/bin/file [OPTION]..
This is a script description because it has spaces.
-d debug
-h help
-v version
use LEOCHARRE::CLI2 '[MyPkg]';
use LEOCHARRE::CLI2 '(manpagename)';
For path arguments on disk specified via @ARGV.
You can optionally use these to see any files, dirs, etc that a user defined in the cli. These must all be paths that resolve to disk. They all return abs path.
Files and dirs, holds absolute paths on disk. Count holds number, 0 if none.
To make these accessible, import.
use LEOCHARRE::CLI2 ':argv'; # for all use LEOCHARRE::CLI2 qw/argv_files argv_files_count argv_dirs argv_dirs_count argv_cwd/; # same
Usage: script ./pathtodir ./path2dir2 ./path2file.txt Then in our script:
my @dirs = argv_dirs(); # holds abs path to dirs
my $dirs_count = argv_dirs_count();
argv_files_count()
or die("you forgot to specidy files on disk.");
Note that this alters @ARGV.
If you wish to import these.. Either use export tag ':all' or ':argv'.
Sometimes you want a destination dir to do something to. You want the option for the user to say
script ./path_to/
But if none is provided, you want to assume './'.
my $base_dir = argv_cwd();
Returns array of files abs paths. Undef if none.
Returns count of files, 0 if none.
Returns array of dirs abs paths. Undef if none.
Returns count of dirs abs paths, 0 if none.
Returns dirs chosen by user, or './' abs path.
This uses Getopt::Std, it works very similar to Getopt::Std::Strict. By default unless it is already there, -d -h and -v flags are set to trigger
-h will trigger help, if no usage() sub is defined, one is generated. -d will enable debug -v will print version and exit
If you want to write your own help, define a usage() sub. If you don't defined one, and the user says -h, a help is automatically generated. It will contain all your flags, name of script, etc.
In this example, we generate our own help, and a manual. Usage simply returns a string.
use LEOCHARRE::CLI2;
sub usage {
q{script [OPTION]...
-h help
-d debug
-v version
Try 'man script' for more info.
}
}
__END__
=pod
=head1 NAME
script
=head1 DESCRIPTION
Hi.. I do x y z.
All cli should have a minimal help that triggers when the user says -h. If you define a SCRIPT_DESCRIPTION, it will be placed in the usage generated.
Alpha software.
Leo Charre leocharre at cpan dot org
This package is free software; you can redistribute it and/or modify it under the same terms as Perl itself, i.e., under the terms of the "Artistic License" or the "GNU General Public License".
This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the "GNU General Public License" for more details.
