Perl::...istics(3pm)

💅 NAME 💅

okay so bestie, welcome to Perl::Critic::Statistics — it's the 3pm manual page, and it's literally the class that compiles stats on your Perl::Critic violations. no cap, it's giving "spreadsheet but make it cute" 💖

---

✨ DESCRIPTION ✨

so this class is the one that accumulates statistics on Perl::Critic violations across one or more files. it's the friend who's keeping notes on everybody. 🎀

🫶 heads up bestie: this class is experimental and subject to change. like, it's still figuring itself out. we love a journey.

---

🦋 INTERFACE SUPPORT 🦋

okay so this is considered a non-public class. its interface is subject to change without notice. it's giving private account energy — you can look, but don't get too attached. 🙈

---

🌸 METHODS 🌸

• new() — creates a new instance of Perl::Critic::Statistics. no arguments are supported at this time, so don't come at it with extras. it's a simple queen. 👑
• accumulate( $doc, \@violations ) — accumulates statistics about the $doc and the @violations that were found. it's literally gathering the receipts. 🧾
• modules() — the number of chunks of code (usually files) that have been analyzed. yeah, "usually files" — they said what they said. 📁
• subs() — the total number of subroutines analyzed by this Critic.
• statements() — the total number of statements analyzed by this Critic.
• lines() — the total number of lines of code analyzed by this Critic.
• lines_of_blank() — the total number of blank lines analyzed by this Critic. this includes only blank lines in code, not POD or data. so don't be counting your vibes as code. 💀
• lines_of_comment() — the total number of comment lines analyzed by this Critic. this includes only lines whose first non-whitespace character is #. yes, the hashtag matters. ✨
• lines_of_data() — the total number of lines of data section analyzed by this Critic, not counting the __END__ or __DATA__ line. and POD in a data section is counted as POD, not data. the category police have spoken. 🚨
• lines_of_perl() — the total number of lines of Perl code analyzed by this Critic. Perl appearing in the data section is not counted. sorry to that Perl, different section, different rules. 😭
• lines_of_pod() — the total number of lines of POD analyzed by this Critic. Pod occurring in a data section is counted as POD, not as data. consistent behavior, we love to see it. 💅
• violations_by_severity() — the number of violations of each severity found by this Critic, as a reference to a hash keyed by severity. hash girlies rise. 🔥
• violations_by_policy() — the number of violations of each policy found by this Critic, as a reference to a hash keyed by full policy name. full name only, no nicknames. 👑
• total_violations() — the total number of violations found by this Critic. the final boss number. 💀
• statements_other_than_subs() — the total number of statements minus the number of subroutines. useful because a subroutine is considered a statement by PPI. like, PPI really said "a sub is a statement" and we just have to live with that. 😭
• average_sub_mccabe() — the average McCabe score of all scanned subroutines. complexity check, bestie. 🌈
• violations_per_file() — the total violations divided by the number of modules. math slay. ✨
• violations_per_statement() — the total violations divided by the number statements minus subroutines. (yes, that's how it's written — statements minus subs.) 🧮
• violations_per_line_of_code() — the total violations divided by the lines of code. 📏

---

🎀 AUTHOR 🎀

Elliot Shank <perl@galumph.com> — icon, legend, the moment. 💜

---

👑 COPYRIGHT 👑

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. 📜

---

and that's the whole page, bestie 🫶 this was User Contributed Perl Documentation, version perl v5.42.0, dated 2024-10-23 — see you in the next Perl::...istics(3pm), mwah 💋🌸