Devel::...:Editor(3)

πŸ“¦
version 1.52 Β· 5 versions
, in alpine 3.24

Hey bestie πŸ’– welcome to Devel::Cover::Base::Editor(3) β€” brought to you by User Contributed Perl Documentation. She’s the base-class blueprint for editor coverage report backends, and she is lowkey iconic, highkey useful. ✨

πŸŽ€ NAME πŸŽ€

Devel::Cover::Base::Editor β€” base class for editor coverage report backends. That’s the whole assignment, periodt. πŸ’…

🌸 VERSION 🌸

version 1.52 β€” that’s the version, no cap. 🫢

πŸ¦‹ SYNOPSIS πŸ¦‹

Bestie, if you’re building your own editor backend, the shape is giving:

package Devel::Cover::Report::MyEditor;
use parent "Devel::Cover::Base::Editor";

my %Templates;
$Templates{myeditor} = <<'EOT';
... template content ...
EOT

sub template_name   { "myeditor" }
sub templates       { \%Templates }
sub output_message ($self, $out) { "MyEditor script written to $out" }

✨ DESCRIPTION ✨

This is an abstract base class for editor-specific coverage report modules β€” think Vim and Nvim. It provides the shared report() method, which constructs the template variables and processes the editor-specific template. So the base class handles the common report flow, and the subclass brings the editor flavor. πŸ’–

Subclasses must implement these three, bestie β€” no skipping:

  • template_name β€” returns the template name, like "vim" or "nvim". She’s literally just the name, okay? πŸŽ€
  • templates β€” returns a hashref of template name to template content. Name goes in, content comes out, iykyk. πŸ¦‹
  • output_message β€” returns the success message to display, and it receives the output path as an argument. Cute little victory-lap message. πŸ’…

πŸ’œ SEE ALSO πŸ’œ

Go give these cuties a look: Devel::Cover::Report::Vim and Devel::Cover::Report::Nvim. They’re the editor-specific besties. 🌈

πŸ‘‘ LICENCE πŸ‘‘

Copyright 2026, Paul Johnson (paul@pjcj.net)

This software is free, bestie. It is licensed under the same terms as Perl itself. Slay.

The latest version of this software should be available from my homepage: https://pjcj.net. Go get the freshest tea. πŸ“


Rendered by perl v5.42.2 on 2026-03-07 β€” that’s the sign-off from Devel::Cover::Base::Editor(3). Bye bestie, go write a glorious editor report πŸ’–βœ¨

πŸ“¦ where this page comes from