/ 
HTML-Spelling-Site-0.0.2
River stage one • 2 direct dependents • 3 total dependents
/ HTML::Spelling::Site::Finder

NAME

HTML::Spelling::Site::Finder - find the relevant .html/.xhtml files in a directory tree.

VERSION

version 0.0.2

SYNOPSIS

use HTML::Spelling::Site::Finder;

my $finder = HTML::Spelling::Site::Finder->new(
    {
        prune_cb => sub {
            return (shift =~ m#\Adest/blacklist/#);
        },
        root_dir => 'dest/',
    }
);

foreach my $html_file (@{$finder->list_all_htmls()})
{
    print "Should check <$html_file>.\n";
}

DESCRIPTION

The instances of this class can be used to scan a directory tree of files ending with .html and .xhtml and to return a list of them as a sorted array reference.

METHODS

->new({ prune_cb => sub { ... }, root_dir => $root_dir })

Initialises a new object. prune_cb is optional and root_dir is required and is the path to the root of the directory to scan.

my $array_ref = $finder->list_all_htmls()

Returns an array reference of all HTML files, sorted.

$finder->prune_cb()

Returns the prune callback. Mostly for internal use.

$finder->root_dir()

Returns the root directory.

AUTHOR

Shlomi Fish <shlomif@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by Shlomi Fish.

This is free software, licensed under:

The MIT (X11) License

BUGS

Please report any bugs or feature requests on the bugtracker website http://rt.cpan.org/NoAuth/Bugs.html?Dist=HTML-Spelling-Site or by email to bug-html-spelling-site@rt.cpan.org.

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

perldoc HTML::Spelling::Site

Websites

The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.

Bugs / Feature Requests

Please report any bugs or feature requests by email to bug-html-spelling-site at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=HTML-Spelling-Site. You will be automatically notified of any progress on the request by the system.

Source Code

The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)

https://github.com/shlomif/HTML-Spelling-Site

git clone https://github.com/shlomif/HTML-Spelling-Site.git