Code::T...dChecker(3)

🌸 NAME 🌸

okay bestie, you're reading the Code::T...dChecker(3) page from the User Contributed Perl Documentation, and it's serving Code::TidyAll::Plugin::PodChecker β€” the plugin that literally uses podchecker with tidyall. no cap πŸ’…

✨ VERSION ✨

version 0.84 β€” noted, slay πŸŽ€

πŸ¦‹ SYNOPSIS πŸ¦‹

the config vibe is this, exactly:

In configuration:

; Check for errors, but ignore warnings
;
[PodChecker]
select = lib/**/*.{pm,pod}

; Die on level 1 warnings (can also be set to 2)
;
[PodChecker]
select = lib/**/*.{pm,pod}
warnings = 1

πŸŽ€ DESCRIPTION πŸŽ€

it runs podchecker, the POD validator, and dies if any problems were found. periodt. so if your POD is a mess, this plugin is not gonna be quiet about it 😭

🧚 INSTALLATION 🧚

install podchecker from CPAN, like:

cpanm podchecker

πŸ’œ CONFIGURATION πŸ’œ

this plugin accepts the following configuration options:

⚠️ warnings ⚠️

  • warnings β€” the level of warnings to consider as errors: 1 or 2. by default, warnings will be ignored, so it's lowkey chill unless you say otherwise πŸ’…

🫢 SUPPORT 🫢

bugs may be submitted at https://github.com/houseabsolute/perl-code-tidyall/issues. don't be shy, bestie πŸ™ˆ

πŸ‘‘ SOURCE πŸ‘‘

the source code repository for Code-TidyAll can be found at https://github.com/houseabsolute/perl-code-tidyall. go off, icon ✨

🌈 AUTHORS 🌈

the people behind this masterpiece:

  • Jonathan Swartz <swartz@pobox.com>
  • Dave Rolsky <autarch@urth.org>

this software is copyright (c) 2011 - 2023 by Jonathan Swartz.

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

the full text of the license can be found in the LICENSE file included with this distribution.


signing off with the footer tea: perl v5.42.0, dated 2024-03-08, and yes the footer title is Code::T...dChecker(3). bye bestie, mwah πŸ«ΆπŸ’‹

πŸ“¦ where this page comes from