1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
|
package Code::TidyAll::Plugin::PerlTidy;
use strict;
use warnings;
use Capture::Tiny qw(capture_merged);
use Perl::Tidy;
use Moo;
extends 'Code::TidyAll::Plugin';
our $VERSION = '0.84';
sub transform_source {
my ( $self, $source ) = @_;
# This bit of insanity is needed because if some other code calls
# Getopt::Long::Configure() to change some options, then everything can go
# to hell. Internally perltidy() tries to use Getopt::Long without
# resetting the configuration defaults, leading to very confusing
# errors. See https://rt.cpan.org/Ticket/Display.html?id=118558
Getopt::Long::ConfigDefaults();
# perltidy reports errors in two different ways.
# Argument/profile errors are output and an error_flag is returned.
# Syntax errors are sent to errorfile or stderr, depending on the
# the setting of -se/-nse (aka --standard-error-output). These flags
# might be hidden in other bundles, e.g. -pbp. Be defensive and
# check both.
my ( $output, $error_flag, $errorfile, $stderr, $destination );
# Add --encode-output-strings (-eos) for PT releases in 2022 and later to
# tell perltidy that we want encoded character strings returned. See
# https://github.com/houseabsolute/perl-code-tidyall/issues/84
# https://github.com/perltidy/perltidy/issues/83
my $argv = $self->argv;
$argv .= ' --encode-output-strings' if $Perl::Tidy::VERSION > 20220101;
$output = capture_merged {
$error_flag = Perl::Tidy::perltidy(
argv => $self->argv,
source => \$source,
destination => \$destination,
stderr => \$stderr,
errorfile => \$errorfile
);
};
die $stderr if $stderr;
die $errorfile if $errorfile;
die $output if $error_flag;
print STDERR $output if defined($output);
return $destination;
}
1;
# ABSTRACT: Use perltidy with tidyall
__END__
=pod
=encoding UTF-8
=head1 NAME
Code::TidyAll::Plugin::PerlTidy - Use perltidy with tidyall
=head1 VERSION
version 0.84
=head1 SYNOPSIS
# In configuration:
; Configure in-line
;
[PerlTidy]
select = lib/**/*.pm
argv = --noll
; or refer to a .perltidyrc in the same directory
;
[PerlTidy]
select = lib/**/*.pm
argv = --profile=$ROOT/.perltidyrc
=head1 DESCRIPTION
Runs L<perltidy>, a Perl tidier.
=head1 INSTALLATION
Install perltidy from CPAN.
cpanm perltidy
=head1 CONFIGURATION
This plugin accepts the following configuration options:
=head2 argv
Arguments to pass to C<perltidy>.
If you are using C<Perl::Tidy> version 20220101 or newer, than the
C<--encode-output-strings> flag will be appended to whatever you supply. In
this case, you should ensure that you are I<not> passing a
C<--character-encoding> (C<-enc>) or C<-utf8> flag to perltidy as well.
=head1 SUPPORT
Bugs may be submitted at L<https://github.com/houseabsolute/perl-code-tidyall/issues>.
=head1 SOURCE
The source code repository for Code-TidyAll can be found at L<https://github.com/houseabsolute/perl-code-tidyall>.
=head1 AUTHORS
=over 4
=item *
Jonathan Swartz <swartz@pobox.com>
=item *
Dave Rolsky <autarch@urth.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2011 - 2023 by Jonathan Swartz.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
The full text of the license can be found in the
F<LICENSE> file included with this distribution.
=cut
|