Path::I...uristic(3)

💖 NAME 💖

Okay so welcome to the Path::IsDev::Role::Heuristic(3) page — it's User Contributed Perl Documentation, and the name is right there: Path::IsDev::Role::Heuristic — Base role for Heuristic things. That's the whole vibe, bestie. ✨

✨ VERSION ✨

This is version 1.001003, no cap. 🎀

🌸 ROLE REQUIRES 🌸

If you're implementing this role, there are requirements. The group chat has rules, and this is one of them.

💅 "matches"

Implementing classes must provide this method. Literally must. No ghosting the method. 😭

Here's the signature tea, exactly as it is:

           return : 1 / undef
                    1     -> this path is a development directory as far as this heuristic is concerned
                    undef -> this path is not 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

Also, consuming classes should set $result_object->result( 1 ) prior to returning true. And composing roles should also invoke $result_object->add_reason( $self, $result_value, $descriptive_reason_for_result, \%contextinfo ). See "Path::IsDev::Result" for details. Iykyk. 🦋

🦋 METHODS 🦋

🌈 "name"

Returns the name to use in debugging. By default, this is derived from the classes name with the "PIDH" prefix removed:

           Path::IsDev::Heuristic::Tool::Dzil->name()
           → "+ ::Tool::Dzil"

So yes, that arrow lands at + ::Tool::Dzil exactly like that. 💫

🧚 "heuristic_type"

Returns a description of the general heuristic type:

           positive heuristic

That's it. That's the description. Iconic. 👑

👑 AUTHOR 👑

Shoutout to Kent Fredric <kentnl@cpan.org> for this one. 💜

🎀 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. Slay. 🌈

---

mwah 💋 — page footer energy: perl v5.42.0, dated 2017-03-11, and the footer says Path::I...uristic(3). Bye bestie 🫶