]>
Dogcows Code - chaz/git-codeowners/blob - lib/App/Codeowners/Options.pm
1 package App
::Codeowners
::Options
;
2 # ABSTRACT: Getopt and shell completion for App::Codeowners
8 use Getopt
::Long
2.39 ();
11 our $VERSION = '0.45'; # VERSION
14 eval { require Pod
::Usage
};
16 my $ref = $VERSION eq '9999.999' ? 'master' : "v$VERSION";
17 my $exit = (@_ == 1 && $_[0] =~ /^\d+$/ && $_[0]) //
18 (@_ % 2 == 0 && {@_}->{'-exitval'}) // 2;
20 Online documentation is available at:
22 https://github.com/chazmcgarvey/git-codeowners/blob/$ref/README.md
24 Tip: To enable inline documentation, install the Pod::Usage module.
30 Pod
::Usage
::pod2usage
(@_);
36 'color|colour!' => (-t STDOUT
? 1 : 0), ## no critic (InputOutput::ProhibitInteractiveTest)
37 'format|f=s' => undef,
40 'shell-completion:s' => undef,
68 my @commands = sort keys %{$self->command_options};
75 if (my $command = $self->{command
}) {
76 @command_options = keys %{$self->command_options->{$command} || {}};
78 return (keys %{$self->early_options}, @command_options);
85 my $self = bless {}, $class;
87 my @args_copy = @args;
89 my $opts = $self->get_options(
91 spec
=> $self->early_options,
92 config
=> 'pass_through',
95 if ($ENV{CODEOWNERS_COMPLETIONS
}) {
96 $self->{command
} = $args[0] || '';
97 my $cword = $ENV{CWORD
};
98 my $cur = $ENV{CUR
} || '';
99 # Adjust cword to remove progname
100 while (0 < --$cword) {
101 last if $cur eq ($args_copy[$cword] || '');
103 $self->completions($cword, @args_copy);
107 if ($opts->{version
}) {
108 my $progname = path
($0)->basename;
109 print "${progname} ${VERSION}\n";
113 pod2usage
(-exitval
=> 0, -verbose
=> 99, -sections
=> [qw(NAME SYNOPSIS OPTIONS COMMANDS)]);
115 if ($opts->{manual
}) {
116 pod2usage
(-exitval
=> 0, -verbose
=> 2);
118 if (defined $opts->{shell_completion
}) {
119 $self->shell_completion($opts->{shell_completion
});
123 # figure out the command (or default to "show")
124 my $command = shift @args;
125 my $command_options = $self->command_options->{$command || ''};
126 if (!$command_options) {
127 unshift @args, $command if defined $command;
129 $command_options = $self->command_options->{$command};
132 my $more_opts = $self->get_options(
134 spec
=> $command_options,
137 %$self = (%$opts, %$more_opts, command
=> $command, args
=> \
@args);
143 my $command = $self->{command
};
144 my @commands = sort keys %{$self->command_options};
145 return if not grep { $_ eq $command } @commands;
146 $command =~ s/[^a-z]/_/g;
152 return @{$self->{args
} || []};
158 my $args = {@_ == 1 && ref $_[0] eq 'HASH' ? %{$_[0]} : @_};
162 while (my ($opt, $default_value) = each %{$args->{spec
}}) {
163 my ($name) = $opt =~ /^([^=:!|]+)/;
165 $results{$name} = $default_value;
166 $options{$opt} = \
$results{$name};
169 if (my $fn = $args->{callback
}) {
170 $options{'<>'} = sub {
172 $fn->($arg, \
%results);
176 my $p = Getopt
::Long
::Parser-
>new;
177 $p->configure($args->{config
} || 'default');
178 return if !$p->getoptionsfromarray($args->{args
}, %options);
184 sub shell_completion
{
186 my $type = lc(shift || 'bash');
188 if ($type eq 'bash') {
190 # git-codeowners - Bash completion
191 # To use, eval this code:
192 # eval "$(git-codeowners --shell-completion)"
193 # This will work without the bash-completion package, but handling of colons
194 # in the completion word will work better with bash-completion installed and
197 local cur words cword
198 if declare -f _get_comp_words_by_ref >/dev/null
200 _get_comp_words_by_ref -n : cur cword words
202 words=("${COMP_WORDS[@]}")
207 COMPREPLY=($(CODEOWNERS_COMPLETIONS=1 CWORD="$cword" CUR="$cur" ${words[@]}))
208 # COMPREPLY=($(${words[0]} --completions "$cword" "${words[@]}"))
211 COMPREPLY=($(compgen -A "${COMPREPLY[0]}" -- "$cur"))
213 declare -f __ltrim_colon_completions >/dev/null && \
214 __ltrim_colon_completions "$cur"
217 complete -F _git_codeowners git-codeowners
221 # TODO - Would be nice to support Zsh
222 warn "No such shell completion: $type\n";
232 my $current = $words[$cword] || '';
233 my $prev = $words[$cword - 1] || '';
237 if ($prev eq '--format' || $prev eq '-f') {
238 $reply = $self->_completion_formats;
240 elsif ($current =~ /^-/) {
241 $reply = $self->_completion_options;
244 if (!$self->command) {
245 $reply = [$self->commands, @{$self->_completion_options([keys %{$self->early_options}])}];
254 print grep { /^\Q$current\E/ } @$reply;
258 sub _completion_options
{
260 my $opts = shift || [$self->options];
264 for my $option (@$opts) {
265 my ($names, $op, $vtype) = $option =~ /^([^=:!]+)([=:!]?)(.*)$/;
266 my @names = split(/\|/, $names);
268 for my $name (@names) {
270 push @options, "--$name", "--no-$name";
273 if (length($name) > 1) {
274 push @options, "--$name";
277 push @options, "-$name";
283 return [sort @options];
286 sub _completion_formats
{ [qw(csv json json:pretty tsv yaml)] }
298 App::Codeowners::Options - Getopt and shell completion for App::Codeowners
308 $options = $options->get_options(
310 spec => \@expected_options,
311 callback => sub { my ($arg, $results) = @_; ... },
314 Convert command-line arguments to options, based on specified rules.
316 Returns a hashref of options or C<undef> if an error occurred.
322 C<args> - Arguments from the caller (e.g. C<@ARGV>).
326 C<spec> - List of L<Getopt::Long> compatible option strings.
330 C<callback> - Optional coderef to call for non-option arguments.
334 C<config> - Optional L<Getopt::Long> configuration string.
338 =head2 shell_completion
340 $options->shell_completion($shell_type);
342 Print shell code to C<STDOUT> for the given type of shell. When eval'd, the shell code enables
343 completion for the F<git-codeowners> command.
347 $options->completions($current_arg_index, @args);
349 Print completions to C<STDOUT> for the given argument list and cursor position, and exit.
351 May also exit with status 9 and a compgen action printed to C<STDOUT> to indicate that the shell
352 should generate its own completions.
358 Please report any bugs or feature requests on the bugtracker website
359 L<https://github.com/chazmcgarvey/git-codeowners/issues>
361 When submitting a bug or request, please include a test-file or a
362 patch to an existing test-file that illustrates the bug or desired
367 Charles McGarvey <chazmcgarvey@brokenzipper.com>
369 =head1 COPYRIGHT AND LICENSE
371 This software is copyright (c) 2019 by Charles McGarvey.
373 This is free software; you can redistribute it and/or modify it under
374 the same terms as the Perl 5 programming language system itself.
This page took 0.060184 seconds and 5 git commands to generate.