Scroll to navigation

Perl::Tidy::Sweetened::Variable::Twigils(3pm) User Contributed Perl Documentation Perl::Tidy::Sweetened::Variable::Twigils(3pm)

NAME

Perl::Tidy::Sweetened::Variable::Twigils - Perl::Tidy::Sweetened filter plugin to handle twigls

VERSION

version 1.20

SYNOPSIS

    our $plugins = Perl::Tidy::Sweetened::Pluggable->new();
    $plugins->add_filter(
        Perl::Tidy::Sweetened::Variable::Twigils->new(
            twigil => '$!',
            marker => 'TWG_BANG',
        ) );

DESCRIPTION

This is a Perl::Tidy::Sweetened filter which enables the use of twigils as defined by the Twigils module. New accepts:

    twigil => '$!'
    

Declares a new twigil. In this case to be used as "$!variable".

    marker => 'TWG_BANG'
    

Provides a text marker to be used to flag the new keywords during "prefilter". The source code will be filtered prior to formatting by Perl::Tidy such that:

    $!class_attribute
    

is turned into:

    $__TWG_BANK_1
    

Then back into the original twigiled variable in the "postfilter".

AUTHOR

Mark Grimes <mgrimes@cpan.org>

SOURCE

Source repository is at <https://github.com/mvgrimes/Perl-Tidy-Sweetened>.

BUGS

Please report any bugs or feature requests on the bugtracker website <https://github.com/mvgrimes/Perl-Tidy-Sweetened/issues>

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

COPYRIGHT AND LICENSE

This software is copyright (c) 2023 by Mark Grimes <mgrimes@cpan.org>.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2023-06-18 perl v5.36.0