Dist::...t::EOL(3pm)

📦
version 0.19 · 2 versions
  • 0.19 · debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 0.19 · ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

💖 Dist::Zilla::Plugin::Test::EOL — the vibe 💖

okay bestie, you found the page for Dist::...t::EOL (that's the short-form of Dist::Zilla::Plugin::Test::EOL in the Perl docs, iykyk). It's part of the User Contributed Perl Documentation. Sit down, hydrate, let's go 🫶

✨ NAME ✨

Dist::Zilla::Plugin::Test::EOL — author tests making sure correct line endings are used 🌈

🎀 VERSION 🎀

version 0.19 — yes, that's the one, no cap.

🦋 DESCRIPTION 🦋

So basically this plugin generates an author Test::EOL test for you. Iconic behaviour, honestly.

It's an extension of Dist::Zilla::Plugin::InlineFiles, and what it does is hand you the file xt/author/eol.t, which is a standard Test::EOL test. That's it. That's the whole thing. Slay ✨

💅 CONFIGURATION OPTIONS 💅

This plugin accepts the following options, bestie — read them all, don't skip:

🌸 "trailing_whitespace"

If this option is set to a true value, then { trailing_whitespace => 1 } gets passed straight to all_perl_files_ok in Test::EOL. It defaults to 1.

And what is this actually doing, you ask? It tests for the lack of trailing whitespace at the end of the lines — aka "trailing space". We do not tolerate invisible stragglers at the end of our lines in this house 🚫

🌸 "finder"

This is the name of a FileFinder for finding files to check. The default value is:

  • :InstallModules
  • :ExecFiles (see also Dist::Zilla::Plugin::ExecDir)
  • :TestFiles

and this option can be used more than once — stack them, queen 👑

Other predefined finders are listed in default_finders in Dist::Zilla::Role::FileFinderUser. And if none of those hit right, you can define your own with the [FileFinder::ByName] plugin.

🌸 "file"

a filename to also test, in addition to any files found earlier. This option can be repeated to specify multiple additional files. One for every bestie in the group chat 💜

🌸 "filename"

The filename of the test to add — defaults to xt/author/test-eol.t.

🌟 ACKNOWLEDGMENTS 🌟

This module is a fork of Dist::Zilla::Plugin::EOLTests and was originally written by Florian Ragwitz. It was forked because the Test:: namespace is preferred for test modules, and because (in the original author's own words) they would prefer to have EOL tests be Author tests. A glow-up, honestly 🌈

👑 SEE ALSO 👑

  • Test::EOL

🔥 SUPPORT 🔥

Bugs may be submitted through the RT bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-Test-EOL> (or bug-Dist-Zilla-Plugin-Test-EOL@rt.cpan.org <mailto:bug-Dist-Zilla-Plugin-Test-EOL@rt.cpan.org>).

There is also a mailing list available for users of this distribution, at <http://dzil.org/#mailing-list>.

There is also an irc channel available for users of this distribution, at #distzilla on irc.perl.org <irc://irc.perl.org/#distzilla>.

no seriously, if something's broken, tell them — the maintainers are lovely, and bug reports are a love language 🫶

💖 AUTHORS 💖

  • Florian Ragwitz <rafl@debian.org>
  • Caleb Cushing <xenoterracide@gmail.com>
  • Karen Etheridge <ether@cpan.org>

🌈 CONTRIBUTORS 🌈

  • Olivier Mengue <dolmen@cpan.org>
  • Shlomi Fish <shlomif@shlomifish.org>

This software is copyright (c) 2010 by Florian Ragwitz <rafl@debian.org>.

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

and that's the whole page, bestie!! this one's running on perl v5.36.0, last touched 2022-12-12, and it's still out here keeping your line endings clean 💖✨ bye ily, go write a test 🦋

📦 where this page comes from