1 package App
::Codeowners
::Options
;
2 # ABSTRACT: Getopt and shell completion for App::Codeowners
9 use Getopt
::Long
2.39 ();
12 our $VERSION = '9999.999'; # VERSION
15 eval { require Pod
::Usage
};
17 my $ref = $VERSION eq '9999.999' ? 'master' : "v$VERSION";
18 my $exit = (@_ == 1 && $_[0] =~ /^\d+$/ && $_[0]) //
19 (@_ % 2 == 0 && {@_}->{'-exitval'}) // 2;
21 Online documentation is available at:
23 https://github.com/chazmcgarvey/git-codeowners/blob/$ref/README.md
25 Tip: To enable inline documentation, install the Pod::Usage module.
31 Pod
::Usage
::pod2usage
(@_);
37 'color|colour!' => (-t STDOUT
? 1 : 0), ## no critic (InputOutput::ProhibitInteractiveTest)
38 'format|f=s' => undef,
41 'shell-completion:s' => undef,
69 my @commands = sort keys %{$self->command_options};
76 if (my $command = $self->{command
}) {
77 @command_options = keys %{$self->command_options->{$command} || {}};
79 return (keys %{$self->early_options}, @command_options);
86 # assume UTF-8 args if non-ASCII
87 @args = map { decode
('UTF-8', $_) } @args if grep { /\P{ASCII}/ } @args;
89 my $self = bless {}, $class;
91 my @args_copy = @args;
93 my $opts = $self->get_options(
95 spec
=> $self->early_options,
96 config
=> 'pass_through',
99 if ($ENV{CODEOWNERS_COMPLETIONS
}) {
100 $self->{command
} = $args[0] || '';
101 my $cword = $ENV{CWORD
};
102 my $cur = $ENV{CUR
} || '';
103 # Adjust cword to remove progname
104 while (0 < --$cword) {
105 last if $cur eq ($args_copy[$cword] || '');
107 $self->completions($cword, @args_copy);
111 if ($opts->{version
}) {
112 my $progname = path
($0)->basename;
113 print "${progname} ${VERSION}\n";
117 pod2usage
(-exitval
=> 0, -verbose
=> 99, -sections
=> [qw(NAME SYNOPSIS OPTIONS COMMANDS)]);
119 if ($opts->{manual
}) {
120 pod2usage
(-exitval
=> 0, -verbose
=> 2);
122 if (defined $opts->{shell_completion
}) {
123 $self->shell_completion($opts->{shell_completion
});
127 # figure out the command (or default to "show")
128 my $command = shift @args;
129 my $command_options = $self->command_options->{$command || ''};
130 if (!$command_options) {
131 unshift @args, $command if defined $command;
133 $command_options = $self->command_options->{$command};
136 my $more_opts = $self->get_options(
138 spec
=> $command_options,
141 %$self = (%$opts, %$more_opts, command
=> $command, args
=> \
@args);
147 my $command = $self->{command
};
148 my @commands = sort keys %{$self->command_options};
149 return if not grep { $_ eq $command } @commands;
150 $command =~ s/[^a-z]/_/g;
156 return @{$self->{args
} || []};
161 $options = $options->get_options(
163 spec
=> \
@expected_options,
164 callback
=> sub { my ($arg, $results) = @_; ... },
167 Convert command-line arguments to options
, based on specified rules
.
169 Returns a hashref of options
or C
<undef> if an error occurred
.
172 * C<args> - Arguments from the caller (e.g. C<@ARGV>).
173 * C<spec> - List of L<Getopt::Long> compatible option strings.
174 * C<callback> - Optional coderef to call for non-option arguments.
175 * C<config> - Optional L<Getopt::Long> configuration string.
181 my $args = {@_ == 1 && ref $_[0] eq 'HASH' ? %{$_[0]} : @_};
185 while (my ($opt, $default_value) = each %{$args->{spec
}}) {
186 my ($name) = $opt =~ /^([^=:!|]+)/;
188 $results{$name} = $default_value;
189 $options{$opt} = \
$results{$name};
192 if (my $fn = $args->{callback
}) {
193 $options{'<>'} = sub {
195 $fn->($arg, \
%results);
199 my $p = Getopt
::Long
::Parser-
>new;
200 $p->configure($args->{config
} || 'default');
201 return if !$p->getoptionsfromarray($args->{args
}, %options);
206 =method shell_completion
208 $options->shell_completion($shell_type);
210 Print shell code to C
<STDOUT
> for the
given type of shell
. When
eval'd, the shell code enables
211 completion for the F<git-codeowners> command.
215 sub shell_completion {
217 my $type = lc(shift || 'bash
');
219 if ($type eq 'bash
') {
221 # git-codeowners - Bash completion
222 # To use, eval this code:
223 # eval "$(git-codeowners --shell-completion)"
224 # This will work without the bash-completion package, but handling of colons
225 # in the completion word will work better with bash-completion installed and
228 local cur words cword
229 if declare -f _get_comp_words_by_ref >/dev/null
231 _get_comp_words_by_ref -n : cur cword words
233 words=("${COMP_WORDS[@]}")
238 COMPREPLY=($(CODEOWNERS_COMPLETIONS=1 CWORD="$cword" CUR="$cur" ${words[@]}))
239 # COMPREPLY=($(${words[0]} --completions "$cword" "${words[@]}"))
242 COMPREPLY=($(compgen -A "${COMPREPLY[0]}" -- "$cur"))
244 declare -f __ltrim_colon_completions >/dev/null && \
245 __ltrim_colon_completions "$cur"
248 complete -F _git_codeowners git-codeowners
252 # TODO - Would be nice to support Zsh
253 warn "No such shell completion: $type\n";
259 $options->completions($current_arg_index, @args);
261 Print completions to C
<STDOUT
> for the
given argument list
and cursor position
, and exit.
263 May also
exit with status
9 and a compgen action printed to C
<STDOUT
> to indicate that the shell
264 should generate its own completions
.
275 my $current = $words[$cword] || '';
276 my $prev = $words[$cword - 1] || '';
280 if ($prev eq '--format
' || $prev eq '-f
') {
281 $reply = $self->_completion_formats;
283 elsif ($current =~ /^-/) {
284 $reply = $self->_completion_options;
287 if (!$self->command) {
288 $reply = [$self->commands, @{$self->_completion_options([keys %{$self->early_options}])}];
297 print grep { /^\Q$current\E/ } @$reply;
301 sub _completion_options {
303 my $opts = shift || [$self->options];
307 for my $option (@$opts) {
308 my ($names, $op, $vtype) = $option =~ /^([^=:!]+)([=:!]?)(.*)$/;
309 my @names = split(/\|/, $names);
311 for my $name (@names) {
313 push @options, "--$name", "--no-$name";
316 if (length($name) > 1) {
317 push @options, "--$name";
320 push @options, "-$name";
326 return [sort @options];
329 sub _completion_formats { [qw(csv json json:pretty tsv yaml)] }