get_maintainer: add --json output mode
PATCH 1/1 get_maintainer: add --json output mode
Add a --json flag to get_maintainer.pl that emits structured JSON output, making results machine-parseable for CI systems, IDE integrations, and AI-assisted development tools.
The JSON output includes a maintainers array with structured name, email, and role fields, plus optional arrays for scm, status, subsystem, web, and bug information when those flags are enabled.
Normal text output behavior is completely unchanged when --json is not specified.
--- scripts/get_maintainer.pl | 114 +++++++++++++++++++++++++++++--------- 1 file changed, 87 insertions(+), 27 deletions(-)
scripts/get_maintainer.pl +87 -27
@@ -68,6 +68,7 @@ my $pattern_depth = 0; my $self_test = undef; my $version = 0; my $help = 0; +my $json = 0; my $find_maintainer_files = 0; my $maintainer_path; my $vcs_used = 0;
@@ -285,6 +286,7 @@ if (!GetOptions( 'find-maintainer-files' => \$find_maintainer_files, 'mpath|maintainer-path=s' => \$maintainer_path, 'self-test:s' => \$self_test, + 'json!' => \$json, 'v|version' => \$version, 'h|help|usage' => \$help, )) {
@@ -648,39 +650,74 @@ my %deduplicate_name_hash = (); my %deduplicate_address_hash = (); my @maintainers = get_maintainers(); -if (@maintainers) { - @maintainers = merge_email(@maintainers); - output(@maintainers); -} -if ($scm) { - @scm = uniq(@scm); - output(@scm); -} +if ($json) { + my @json_maintainers; + if (@maintainers) { + my %saw; + for (@maintainers) { + my ($address, $role) = @$_; + if (!$saw{$address}) { + my ($name, $email_addr) = parse_email($address); + my $entry = '{"name":"' . json_escape_str($name) . + '","email":"' . json_escape_str($email_addr) . '"'; + $entry .= ',"role":"' . json_escape_str($role) . '"' if ($output_roles && $role ne ''); + $entry .= '}'; + push(@json_maintainers, $entry); + $saw{$address} = 1; + } + } + } -if ($output_substatus) { - @substatus = uniq(@substatus); - output(@substatus); -} + @scm = uniq(@scm) if ($scm); + @status = uniq(@status) if ($status); + @subsystem = uniq(@subsystem) if ($subsystem); + @web = uniq(@web) if ($web); + @bug = uniq(@bug) if ($bug); -if ($status) { - @status = uniq(@status); - output(@status); -} + my @fields; + push(@fields, '"maintainers":[' . join(',', @json_maintainers) . ']'); + push(@fields, '"scm":' . json_str_array(@scm)) if ($scm); + push(@fields, '"status":' . json_str_array(@status)) if ($status); + push(@fields, '"subsystem":' . json_str_array(@subsystem)) if ($subsystem); + push(@fields, '"web":' . json_str_array(@web)) if ($web); + push(@fields, '"bug":' . json_str_array(@bug)) if ($bug); + print('{' . join(',', @fields) . '}' . "\n"); +} else { + if (@maintainers) { + @maintainers = merge_email(@maintainers); + output(@maintainers); + } -if ($subsystem) { - @subsystem = uniq(@subsystem); - output(@subsystem); -} + if ($scm) { + @scm = uniq(@scm); + output(@scm); + } -if ($web) { - @web = uniq(@web); - output(@web); -} + if ($output_substatus) { + @substatus = uniq(@substatus); + output(@substatus); + } -if ($bug) { - @bug = uniq(@bug); - output(@bug); + if ($status) { + @status = uniq(@status); + output(@status); + } + + if ($subsystem) { + @subsystem = uniq(@subsystem); + output(@subsystem); + } + + if ($web) { + @web = uniq(@web); + output(@web); + } + + if ($bug) { + @bug = uniq(@bug); + output(@bug); + } } exit($exit);
@@ -1099,6 +1136,7 @@ Output type options: --separator [, ] => separator for multiple entries on 1 line using --separator also sets --nomultiline if --separator is not [, ] --multiline => print 1 entry per line + --json => output results as JSON Other options: --pattern-depth => Number of pattern directory traversals (default: 0 (all))
@@ -2549,6 +2587,28 @@ sub merge_email { return @lines; } +sub json_escape_str { + my ($str) = @_; + $str =~ s/\\/\\\\/g; + $str =~ s/"/\\"/g; + $str =~ s/\n/\\n/g; + $str =~ s/\r/\\r/g; + $str =~ s/\t/\\t/g; + $str =~ s/\x08/\\b/g; + $str =~ s/\x0c/\\f/g; + $str =~ s/([\x00-\x07\x0b\x0e-\x1f])/sprintf("\\u%04x", ord($1))/ge; + return $str; +} + +sub json_str_array { + my (@arr) = @_; + my @quoted; + foreach my $s (@arr) { + push(@quoted, '"' . json_escape_str($s) . '"'); + } + return '[' . join(',', @quoted) . ']'; +} + sub output { my (@parms) = @_;
Signature · 1 line
2.53.0
Joe Perches
maintainerQuoted 3 lines · Sasha Levin
Add a --json flag to get_maintainer.pl that emits structured JSON output, making results machine-parseable for CI systems, IDE integrations, and AI-assisted development tools.
OK here too but perhaps the code can be consolidated a bit more.
Quoted 37 lines
scripts/get_maintainer.pl +6
-8@@ -68,6 +68,7 @@ my $pattern_depth = 0; my $self_test = undef; my $version = 0; my $help = 0; +my $json = 0; my $find_maintainer_files = 0; my $maintainer_path; my $vcs_used = 0;@@ -285,6 +286,7 @@ if (!GetOptions( 'find-maintainer-files' => \$find_maintainer_files, 'mpath|maintainer-path=s' => \$maintainer_path, 'self-test:s' => \$self_test, + 'json!' => \$json, 'v|version' => \$version, 'h|help|usage' => \$help, )) {@@ -648,39 +650,74 @@ my %deduplicate_name_hash = (); my %deduplicate_address_hash = (); my @maintainers = get_maintainers(); -if (@maintainers) { - @maintainers = merge_email(@maintainers); - output(@maintainers); -} -if ($scm) { - @scm = uniq(@scm); - output(@scm); -} +if ($json) { + my @json_maintainers; + if (@maintainers) { + my %saw;
scripts/get_maintainer.pl my %deduplicate_name_hash = (); · line 667
Quoted 10 lines
scripts/get_maintainer.pl +10
-0+ for (@maintainers) { + my ($address, $role) = @$_; + if (!$saw{$address}) { + my ($name, $email_addr) = parse_email($address); + my $entry = '{"name":"' . json_escape_str($name) . + '","email":"' . json_escape_str($email_addr) . '"'; + $entry .= ',"role":"' . json_escape_str($role) . '"' if ($output_roles && $role ne ''); + $entry .= '}'; + push(@json_maintainers, $entry); + $saw{$address} = 1;
Isn't this effectively the merge_email(@maintainers) above? Why not use it?
PATCH v2 1/1 get_maintainer: add --json output mode
In reply to Sasha LevinAdd a --json flag to get_maintainer.pl that emits structured JSON output, making results machine-parseable for CI systems, IDE integrations, and AI-assisted development tools.
The JSON output includes a maintainers array with structured name, email, and role fields, plus optional arrays for scm, status, subsystem, web, and bug information when those flags are enabled.
Normal text output behavior is completely unchanged when --json is not specified.
---
Changes since v1:
- Replace hand-rolled json_escape_str()/json_str_array() with JSON::PP module (core since perl 5.14)
- Reuse merge_email() for deduplication instead of reimplementing it, per Joe's review
- Consolidate uniq() dedup calls before the json/non-json branch so both paths share the same logic
--- scripts/get_maintainer.pl | 73 +++++++++++++++++++++++---------------- 1 file changed, 43 insertions(+), 30 deletions(-)
scripts/get_maintainer.pl +43 -30
@@ -21,6 +21,7 @@ use Cwd; use File::Find; use File::Spec::Functions; use open qw(:std :encoding(UTF-8)); +use JSON::PP; my $cur_path = fastgetcwd() . '/'; my $lk_path = "./";
@@ -68,6 +69,7 @@ my $pattern_depth = 0; my $self_test = undef; my $version = 0; my $help = 0; +my $json = 0; my $find_maintainer_files = 0; my $maintainer_path; my $vcs_used = 0;
@@ -285,6 +287,7 @@ if (!GetOptions( 'find-maintainer-files' => \$find_maintainer_files, 'mpath|maintainer-path=s' => \$maintainer_path, 'self-test:s' => \$self_test, + 'json!' => \$json, 'v|version' => \$version, 'h|help|usage' => \$help, )) {
@@ -648,39 +651,48 @@ my %deduplicate_name_hash = (); my %deduplicate_address_hash = (); my @maintainers = get_maintainers(); -if (@maintainers) { - @maintainers = merge_email(@maintainers); - output(@maintainers); -} - -if ($scm) { - @scm = uniq(@scm); - output(@scm); -} - -if ($output_substatus) { - @substatus = uniq(@substatus); - output(@substatus); -} - -if ($status) { - @status = uniq(@status); - output(@status); -} -if ($subsystem) { - @subsystem = uniq(@subsystem); - output(@subsystem); -} +@maintainers = merge_email(@maintainers) if (@maintainers); +@scm = uniq(@scm) if ($scm); +@substatus = uniq(@substatus) if ($output_substatus); +@status = uniq(@status) if ($status); +@subsystem = uniq(@subsystem) if ($subsystem); +@web = uniq(@web) if ($web); +@bug = uniq(@bug) if ($bug); + +if ($json) { + my @json_maintainers; + for my $m (@maintainers) { + my ($addr, $role); + if ($output_roles && $m =~ /^(.*?)\s+\((.+)\)\s*$/) { + $addr = $1; + $role = $2; + } else { + $addr = $m; + } + my ($name, $email_addr) = parse_email($addr); + my %entry = (name => $name, email => $email_addr); + $entry{role} = $role if (defined $role && $role ne ''); + push(@json_maintainers, \%entry); + } -if ($web) { - @web = uniq(@web); - output(@web); -} + my %result = (maintainers => \@json_maintainers); + $result{scm} = \@scm if ($scm); + $result{status} = \@status if ($status); + $result{subsystem} = \@subsystem if ($subsystem); + $result{web} = \@web if ($web); + $result{bug} = \@bug if ($bug); -if ($bug) { - @bug = uniq(@bug); - output(@bug); + my $json_encoder = JSON::PP->new->canonical->utf8; + print($json_encoder->encode(\%result) . "\n"); +} else { + output(@maintainers) if (@maintainers); + output(@scm) if ($scm); + output(@substatus) if ($output_substatus); + output(@status) if ($status); + output(@subsystem) if ($subsystem); + output(@web) if ($web); + output(@bug) if ($bug); } exit($exit);
@@ -1099,6 +1111,7 @@ Output type options: --separator [, ] => separator for multiple entries on 1 line using --separator also sets --nomultiline if --separator is not [, ] --multiline => print 1 entry per line + --json => output results as JSON Other options: --pattern-depth => Number of pattern directory traversals (default: 0 (all))
Signature · 1 line
2.53.0
Quoted 8 lines · Sasha Levin
Add a --json flag to get_maintainer.pl that emits structured JSON output, making results machine-parseable for CI systems, IDE integrations, and AI-assisted development tools.
The JSON output includes a maintainers array with structured name, email, and role fields, plus optional arrays for scm, status, subsystem, web, and bug information when those flags are enabled.
Quoted 5 lines
Normal text output behavior is completely unchanged when --json is not specified.
Assisted-by Claude:claude-opus-4-6
Thanks Sasha. Looks nicer now.
Quoted 129 lines
---
Changes since v1:
- Replace hand-rolled json_escape_str()/json_str_array() withJSON::PPmodule (core since perl 5.14)
- Reusemerge_email()for deduplication instead of reimplementing it, per Joe's review
- Consolidateuniq()dedup calls before the json/non-json branch so both paths share the same logic--- scripts/get_maintainer.pl | 73 +++++++++++++++++++++++---------------- 1 file changed, 43 insertions(+), 30 deletions(-)scripts/get_maintainer.pl +43
-30@@ -21,6 +21,7 @@ use Cwd; use File::Find; use File::Spec::Functions; use open qw(:std :encoding(UTF-8)); +use JSON::PP; my $cur_path = fastgetcwd() . '/'; my $lk_path = "./";@@ -68,6 +69,7 @@ my $pattern_depth = 0; my $self_test = undef; my $version = 0; my $help = 0; +my $json = 0; my $find_maintainer_files = 0; my $maintainer_path; my $vcs_used = 0;@@ -285,6 +287,7 @@ if (!GetOptions( 'find-maintainer-files' => \$find_maintainer_files, 'mpath|maintainer-path=s' => \$maintainer_path, 'self-test:s' => \$self_test, + 'json!' => \$json, 'v|version' => \$version, 'h|help|usage' => \$help, )) {@@ -648,39 +651,48 @@ my %deduplicate_name_hash = (); my %deduplicate_address_hash = (); my @maintainers = get_maintainers(); -if (@maintainers) { - @maintainers = merge_email(@maintainers); - output(@maintainers); -} - -if ($scm) { - @scm = uniq(@scm); - output(@scm); -} - -if ($output_substatus) { - @substatus = uniq(@substatus); - output(@substatus); -} - -if ($status) { - @status = uniq(@status); - output(@status); -} -if ($subsystem) { - @subsystem = uniq(@subsystem); - output(@subsystem); -} +@maintainers = merge_email(@maintainers) if (@maintainers); +@scm = uniq(@scm) if ($scm); +@substatus = uniq(@substatus) if ($output_substatus); +@status = uniq(@status) if ($status); +@subsystem = uniq(@subsystem) if ($subsystem); +@web = uniq(@web) if ($web); +@bug = uniq(@bug) if ($bug); + +if ($json) { + my @json_maintainers; + for my $m (@maintainers) { + my ($addr, $role); + if ($output_roles && $m =~ /^(.*?)\s+\((.+)\)\s*$/) { + $addr = $1; + $role = $2; + } else { + $addr = $m; + } + my ($name, $email_addr) = parse_email($addr); + my %entry = (name => $name, email => $email_addr); + $entry{role} = $role if (defined $role && $role ne ''); + push(@json_maintainers, \%entry); + } -if ($web) { - @web = uniq(@web); - output(@web); -} + my %result = (maintainers => \@json_maintainers); + $result{scm} = \@scm if ($scm); + $result{status} = \@status if ($status); + $result{subsystem} = \@subsystem if ($subsystem); + $result{web} = \@web if ($web); + $result{bug} = \@bug if ($bug); -if ($bug) { - @bug = uniq(@bug); - output(@bug); + my $json_encoder = JSON::PP->new->canonical->utf8; + print($json_encoder->encode(\%result) . "\n"); +} else { + output(@maintainers) if (@maintainers); + output(@scm) if ($scm); + output(@substatus) if ($output_substatus); + output(@status) if ($status); + output(@subsystem) if ($subsystem); + output(@web) if ($web); + output(@bug) if ($bug); } exit($exit);@@ -1099,6 +1111,7 @@ Output type options: --separator [, ] => separator for multiple entries on 1 line using --separator also sets --nomultiline if --separator is not [, ] --multiline => print 1 entry per line + --json => output results as JSON Other options: --pattern-depth => Number of pattern directory traversals (default: 0 (all))```