Document(3pm)

📦
version 0.000060 · 7 versions
, in ubuntu stonking

💖 NAME 💖

App::perlimports::Document — bestie, we're making implicit imports explicit ✨ like, out loud, on the page, no more hiding 🫶

🎀 VERSION 🎀

version 0.000060 — yes it's slaying, keep up 💅

🧠 MOTIVATION 🧠

okay so listen 🙈 this module is strictly for internal use by perlimports. It's the backstage crew, the stagehands, the little guys behind the curtain. Nothing else should be relying on it, fr fr — so don't you dare build your whole app on top of it, that's not the vibe 👑.

🔍 inspector_for( $module_name )

Hands you back an App::perlimports::ExporterInspector object for whatever module name you pass in. That's it, that's the whole thing 💖

✅ linter_success

Returns true if the document got linted with zero errors, otherwise false. A little vibe check for your file 🌈 — true means we're thriving, false means we're not 🥲

🪄 tidied_document

Returns a serialized PPI document with (hopefully 👀) tidy import statements. Emphasis on hopefully, bestie — we do our best.

🌸 ATTRIBUTES 🌸

📚 constants

A hashref catalog of every detected constant in the document. So like, the line:

use constant FIRST_IDX => 0;

gives you a matching entry in the constants hashref:

FIRST_IDX => {
  name        => 'FIRST_IDX', # (plain string)
  token       => 'FIRST_IDX', # (PPI::Token::Word usually)
  definition  => [ PPI::Token.. ],
  end         => { line => 9, column => 32 },
},

The end is the (line, character) position of the last character of the constant import statement. Why do you care? Because the constant is only actually defined at compile time, and only after this statement — so the position is genuinely useful info fr 🧚

⚠️ heads up bestie: locations can become stale! Don't trust them forever, okay? 💀

The name field is the hero when the constant got defined with atypical syntax (no fat arrow), because the token doesn't stringify the same way. Watch:

use constant 'FIRST_IDX', 0;
# token eq "'FIRST_IDX'", # (PPI::Token::Quote::Single)
# name  eq 'FIRST_IDX',   # same as $token->string

See?? The token is out here with quotes and the name is just clean 🫧 iconic behaviour honestly.

📦 includes

An arrayref of PPI::Statement::Include statements found in the document — but excluding pragmas, ignored modules, and 'use VERSION' statements. They're not invited to this party 🙅♀️

🗂️ found_imports

A hashref catalog of symbols imported from each package by a use statement, like:

{ Carp => ['croak', ..], ... }

Now here's the tea ☕, and it depends on your mode:

  • In lint mode, this attribute is never altered. Hands off, it's chillin' 🌴
  • In edit mode, when tidied_document gets called, every include that gets processed updates this list to what we think it should be ✨

Why do we bother? So we can keep track of what the previous modules are really importing, which lets us avoid duplicate imports — you know, the same symbol name coming in from different packages 😵‍💫 Nobody wants that mess.

👑 AUTHOR 👑

Olaf Alders <olaf@wundercounter.com> — king behaviour, we stan 🫶

This software is copyright (c) 2020 by Olaf Alders.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. So like, go forth and remix bestie 💅

aaaand that's the whole page!! brought to you by perl v5.40.1, dated 2026-05-11, filed under Document(3pm) — mwah, go read some source code, ily 🌈💖✨

📦 where this page comes from