Perl::...stants(3pm)

πŸ’– NAME πŸ’–

okay so this page is Perl::...stants(3pm) (User Contributed Perl Documentation), and it is all about Perl::Critic::Utils::Constants β€” global constants, bestie. That is the whole name situation. πŸ’…

🌸 DESCRIPTION 🌸

It defines the commonly used constants for Perl::Critic. No cap, that is the description. ✨

πŸ¦‹ INTERFACE SUPPORT πŸ¦‹

This is considered to be a public module. Any changes to its interface will go through a deprecation cycle. So yes, it is public and the interface gets the whole deprecation-cycle glow-up if it ever changes. πŸ’–

✨ IMPORTABLE CONSTANTS ✨

okay bestie, here is the snack bar of constants you can import:

  • $PROFILE_STRICTNESS_WARN
  • $PROFILE_STRICTNESS_FATAL
  • $PROFILE_STRICTNESS_QUIET
  • $PROFILE_STRICTNESS_DEFAULT
  • %PROFILE_STRICTNESSES β€” valid values for the -profile-strictness in perlcritic option. It determines whether recoverable problems found in a profile file appear as warnings, are fatal, or are ignored. $PROFILE_STRICTNESS_DEFAULT is set to $PROFILE_STRICTNESS_WARN. Importable via the :profile_strictness tag.

Then the color severity defaults, serving looks and defaults:

  • $PROFILE_COLOR_SEVERITY_HIGHEST_DEFAULT β€” default for the -color-severity-highest option. Importable via the :color_severity tag.
  • $PROFILE_COLOR_SEVERITY_HIGH_DEFAULT β€” default for the -color-severity-high option. Importable via the :color_severity tag.
  • $PROFILE_COLOR_SEVERITY_MEDIUM_DEFAULT β€” default for the -color-severity-medium option. Importable via the :color_severity tag.
  • $PROFILE_COLOR_SEVERITY_LOW_DEFAULT β€” default for the -color-severity-low option. Importable via the :color_severity tag.
  • $PROFILE_COLOR_SEVERITY_LOWEST_DEFAULT β€” default for the -color-severity-lowest option. Importable via the :color_severity tag.

And the module-list constants:

  • @STRICT_EQUIVALENT_MODULES
  • @WARNINGS_EQUIVALENT_MODULES β€” as the names suggest, these are lists of modules that are equivalent to applying the strict or warnings pragma when loaded. At the moment, both lists are exactly the same. Note: These lists are not exhaustive; they only include the most commonly used modules. Policies that use these lists should permit configuration of additional modules.

🫢 AUTHOR 🫢

Shoutout to Elliot Shank <perl@galumph.com> β€” iconic. πŸ’–

Copyright (c) 2007-2011 Elliot Shank.

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. πŸŽ€


that is the whole page, bestie. Source/version: perl v5.42.0 Β· date: 2024-10-23 Β· page: Perl::...stants(3pm) βœ¨πŸ’…

πŸ“¦ where this page comes from