Perl::...minator(3pm)

✨ NAME ✨

okay bestie, the manual name up top is Perl::...minator(3pm), and it's from the User Contributed Perl Documentation girlies πŸ’–. The actual NAME is Perl::Critic::Policy::ValuesAndExpressions::RequireUpperCaseHeredocTerminator β€” say that three times fast, I dare you 😭 β€” and it's literally about writing " <<'THE_END'; " instead of " <<'theEnd'; ". periodt πŸ’….


πŸ¦‹ AFFILIATION πŸ¦‹

This Policy is part of the core Perl::Critic distribution. slay ✨.


πŸŽ€ DESCRIPTION πŸŽ€

okay so for legibility, HEREDOC terminators should be all UPPER CASE letters (and numbers), without any whitespace. Conway also recommends using a standard prefix like END_ but this policy doesn't enforce that. ngl, it's giving "keep it readable, bestie" 🌸.

Here's the exact vibe check from the page β€” not-ok first, then the iconic ok version:

  print <<'the End';  #not ok
  Hello World
  the End

  print <<'THE_END';  #ok
  Hello World
  THE_END
🚨 not me pointing at the #not ok example like it's the villain of the group chat πŸ’€.

πŸ’œ CONFIGURATION πŸ’œ

This Policy is not configurable except for the standard options. that's it, that's the tea β˜• β€” no extra knobs, no secret settings, just standard-options energy 🫢.


🌈 SEE ALSO 🌈

  • Perl::Critic::Policy::ValuesAndExpressions::RequireQuotedHeredocTerminator β€” the related policy bestie, go say hi πŸ‘‹.

πŸ‘‘ AUTHOR πŸ‘‘

Jeffrey Ryan Thalhammer <jeff@imaginative-software.com> β€” iconic author behavior, fr fr πŸ’–.


Copyright (c) 2005-2011 Imaginative Software Systems. All rights reserved.

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.


And that's the whole page, bestie 🫢 β€” this one comes from the perl v5.42.0 docs, dated 2024-10-23 πŸ’œπŸ¦‹. mwah πŸ’‹.

πŸ“¦ where this page comes from