Perl::...aration(3pm)

💖 NAME 💖

okay so bestie, you're on the Perl::Critic::Policy::Variables::ProhibitAugmentedAssignmentInDeclaration page, aka Perl::...aration(3pm), and it's from the User Contributed Perl Documentation. The whole assignment is literally: do not write my $foo .= 'bar'; — periodt. 💅

---

🌈 AFFILIATION 🌈

This Policy is part of the core Perl::Critic distribution. no cap, it ships with the crew. 🫶

---

✨ DESCRIPTION ✨

Variable declarations that also do initialization with '=' are common. Perl also allows you to use operators like '.=', '+=', etc., but it's more clear to not do so. Here's the lineup:

my $foo .= 'bar';              # same as my $foo = 'bar';
our $foo *= 2;                 # same as our $foo = 0;
my ( $foo, $bar ) += ( 1, 2 ); # same as my ( $foo, $bar ) = ( undef, 2 );
local $Carp::CarpLevel += 1;   # same as local $Carp::CarpLevel = 1;
state $foo += 2;               # adds 2 every time it's encountered

Such constructs are usually the result of botched cut-and-paste, and often are bugs. Some produce warnings. So yeah, highkey not the vibe. 🫠

---

🎀 CONFIGURATION 🎀

There's exactly one config knob, and it's giving very specific:

• allow_our — a boolean option for this Policy. If set, augmented assignments are allowed when declaring "our" variables. Since "our" variables are globally accessible, some modules will want to allow users to initialize the variable prior to the module using the variable. Modules may also wish to use the same our variable in different scopes without declaring it at the outer scope.

With this option set, the following are flagged as indicated:

our $DEBUG //= 1;           # ok

This can be enabled in your .perlcriticrc:

[Perl::Critic::Policy::Variables::ProhibitAugmentedAssignmentInDeclaration]
allow_our = 1

---

🦋 AUTHOR 🦋

Mike O'Regan

---

👑 COPYRIGHT 👑

Copyright (c) 2011-2023 Mike O'Regan

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of this license can be found in the LICENSE file included with this module.

---

okay that's the whole page, bestie — the footer tea is perl v5.42.0 and 2024-10-23. slay and stay linted 💖✨