Dist::...elling(3pm)

📦
version 2.007006 · 4 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

💖 NAME 💖

okay bestie, so like — Dist::Zilla::Plugin::Test::PodSpelling is the plugin that writes your author tests for POD spelling. That's it, that's the whole job. It lives in the Dist::...elling(3pm) manual and she is thriving.

✨ VERSION ✨

version 2.007006 — yes queen, keep up 💅

🌸 SYNOPSIS 🌸

Pop this in your dist.ini:

[Test::PodSpelling]

or, if you wanna get fancy with it:

[Test::PodSpelling]
directory = docs
wordlist = Pod::Wordlist
spell_cmd = aspell list
stopword = CPAN
stopword = github
stopword = stopwords
stopword = wordlist
ok so important tea ☕ — if you're using [ExtraTests], it has to come after [Test::PodSpelling]. And lowkey this thing ships inside the [@Basic] bundle, so you might have to yank it out of there first. no cap.

🦋 DESCRIPTION 🦋

So here's the vibe: this is a plugin that runs at the gather files stage (iykyk), and it hands you this file:

xt/author/pod-spell.t - a standard Test::Spelling test

Also, Test::Spelling gets added as a develop prerequisite. slay.

🎀 ATTRIBUTES 🎀

directories (or directory)

Extra directories you want searched for POD spell-checking purposes. bin and lib are set by default — periodt.

wordlist

The module name of a word list you wanna use that plays nice with Test::Spelling.

Defaults to Pod::Wordlist. 💖

spell_cmd

If spell_cmd is set, then set_spell_cmd( your_spell_command ); gets added to the test file, so you can plug in your own custom spell-check programs. main character energy fr fr.

Defaults to nothing.

stopwords

If stopwords is set, then add_stopwords( <DATA> ) gets added to the test file, and the words get added after the __DATA__ section.

stopword or stopwords can show up multiple times — one word per line, bestie.

Normally no stopwords are added by default, BUT author names appearing in dist.ini are automatically added as stopwords, so you don't have to add them yourself just because they might show up in the AUTHORS section of the generated POD document. The same goes for contributors listed under the 'x_contributors' field on your distribution's META file. it's giving thoughtful 💅

🌈 METHODS 🌈

add_stopword

Called to add stopwords to the stopwords array. It's used to figure out if the automagically detected words are valid, and to print out debug logging for the whole process. iconic behaviour honestly.

🫶 SUPPORT 🫶

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

(or, if email is more your thing: bug-Dist-Zilla-Plugin-Test-PodSpelling@rt.cpan.org)

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

And there's an irc channel too, at #distzilla on irc.perl.org.

Also, they're usually active on irc as 'ether' on irc.perl.org and irc.libera.chat. come say hi 🧚

👑 AUTHORS 👑

  • Caleb Cushing <xenoterracide@gmail.com>
  • Marcel Gruenauer <hanekomu@gmail.com>

💜 CONTRIBUTORS 💜

  • Karen Etheridge <ether@cpan.org>
  • Randy Stauner <rwstauner@cpan.org>
  • Graham Knop <haarg@haarg.org>
  • David Golden <dagolden@cpan.org>
  • Alexandr Ciornii <alexchorny@gmail.com>
  • Breno G. de Oliveira <garu@cpan.org>
  • Harley Pig <harleypig@gmail.com>

the whole squad showed up, obsessed 😭💖

This software is Copyright (c) 2010 by Karen Etheridge.

This is free software, licensed under:

The Artistic License 2.0 (GPL Compatible)

and that's the whole page babes 🎀 this lil drop is from perl v5.40.0, dated 2024-11-16, and it's the Dist::...elling(3pm) manual — go forth and spell-check your POD, you got this 💅✨🦋

📦 where this page comes from