Path::I...uristic(3)

💖 Path::I...uristic(3) 💖

okay bestie, this is a User Contributed Perl Documentation page, and it's giving base-role energy for Negative Heuristic things. no cap, it's a whole role that other classes consume. 🫶

🦋 NAME 🦋

Path::IsDev::Role::NegativeHeuristic — the base role for Negative Heuristic things. literally that's the name, and it ate. 💅

🌸 VERSION 🌸

version 1.001003 ✨

🫶 ROLE REQUIRES 🫶

🎀 "excludes" 🎀

Implementing classes must provide this method. not optional, bestie.

return : 1 / undef
         1     -> this path is not a development directory as far as this heuristic is concerned
         undef -> this path is a development directory as far as this heuristic is concerned

args : ( $class , $result_object )
    $class         -> method will be invoked on packages, not objects
    $result_object -> will be a Path::IsDev::Result

so like, 1 means "nope, not a development directory as far as this heuristic is concerned", and undef means "yep, development directory as far as this heuristic is concerned". iconic little flip-flop. 😭

Additionally, consuming classes should set $result_object->result( undef ) prior to returning true. do not forget, fr fr.

Composing roles should also invoke $result_object->add_reason( $self, $result_value, $descriptive_reason_for_result, \%contextinfo ). yes, all of those args, exactly like that. 💅

See "Path::IsDev::Result" for details. it's the receipts, iykyk.

✨ METHODS ✨

💅 "name" 💅

Returns the name to use in debugging. lowkey useful.

By default, this is derived from the classes name with the "PIDNH" prefix removed:

Path::IsDev::NegativeHeuristic::IsDev::IgnoreFile->name()
→ "- ::IsDev::IgnoreFile"

the way that prefix just dips out? obsessed. 🦋

🦋 "heuristic_type" 🦋

Returns a description of the general heuristic type:

negative heuristic

periodt. that's the type. 💀

👑 AUTHOR 👑

Kent Fredric <kentnl@cpan.org> 🫶

📜 COPYRIGHT AND LICENSE 📜

This software is copyright (c) 2017 by Kent Fredric <kentfredric@gmail.com>.

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

---

okay bye bestie 👋 this page came from perl v5.42.0, dated 2017-03-11, and it's Path::I...uristic(3) — mwah 💋✨