Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

test::eol(3) [centos man page]

Test::EOL(3)						User Contributed Perl Documentation					      Test::EOL(3)

NAME
Test::EOL - Check the correct line endings in your project SYNOPSIS
"Test::EOL" lets you check for the presence of trailing whitespace and/or windows line endings in your perl code. It reports its results in standard "Test::Simple" fashion: use Test::EOL tests => 1; eol_unix_ok( 'lib/Module.pm', 'Module is ^M free'); and to add checks for trailing whitespace: use Test::EOL tests => 1; eol_unix_ok( 'lib/Module.pm', 'Module is ^M and trailing whitespace free', { trailing_whitespace => 1 }); Module authors can include the following in a t/eol.t and have "Test::EOL" automatically find and check all perl files in a module distribution: use Test::EOL; all_perl_files_ok(); or use Test::EOL; all_perl_files_ok( @mydirs ); and if authors would like to check for trailing whitespace: use Test::EOL; all_perl_files_ok({ trailing_whitespace => 1 }); or use Test::EOL; all_perl_files_ok({ trailing_whitespace => 1 }, @mydirs ); DESCRIPTION
This module scans your project/distribution for any perl files (scripts, modules, etc) for the presence of windows line endings. FUNCTIONS
all_perl_files_ok all_perl_files_ok( [ \%options ], [ @directories ] ) Applies "eol_unix_ok()" to all perl files found in @directories (and sub directories). If no <@directories> is given, the starting point is one level above the current running script, that should cover all the files of a typical CPAN distribution. A perl file is *.pl or *.pm or *.t or a file starting with "#!...perl" Valid "\%options" currently are: o trailing_whitespace By default Test::EOL only looks for Windows (CR/LF) line-endings. Set this to true to raise errors if any kind of trailing whitespace is present in the file. o all_reasons Normally Test::EOL reports only the first error in every file (given that a text file originated on Windows will fail every single line). Set this a true value to register a test failure for every line with an error. If the test plan is defined: use Test::EOL tests => 3; all_perl_files_ok(); the total number of files tested must be specified. eol_unix_ok eol_unix_ok ( $file [, $text] [, \%options ] ) Run a unix EOL check on $file. For a module, the path (lib/My/Module.pm) or the name (My::Module) can be both used. $text is the diagnostic label emited after the "ok"/"not ok" TAP output. "\%options" takes the same values as described in "all_perl_files_ok". EXPORT
A list of functions that can be exported. You can delete this section if you don't export anything, such as for a purely object-oriented module. ACKNOWLEDGEMENTS
Shamelessly ripped off from Test::NoTabs. SEE ALSO
Test::More, Test::Pod. Test::Distribution, <Test:NoWarnings>, Test::NoTabs, Module::Install::AuthorTests. AUTHORS
o Arthur Axel 'fREW' Schmidt <frioux@gmail.com> o Florian Ragwitz <rafl@debian.org> o Kent Fredric <kentfredric@gmail.com> o Peter Rabbitson <ribasushi@cpan.org> o Tomas Doran <bobtfish@bobtfish.net> COPYRIGHT AND LICENSE
This software is copyright (c) 2012 by Tomas Doran. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. perl v5.16.3 2012-06-15 Test::EOL(3)

Check Out this Related Man Page

HasVersion(3pm) 					User Contributed Perl Documentation					   HasVersion(3pm)

NAME
Test::HasVersion - Check Perl modules have version numbers SYNOPSIS
"Test::HasVersion" lets you check a Perl module has a version number in a "Test::Simple" fashion. use Test::HasVersion tests => 1; pm_version_ok("M.pm", "Valid version"); Module authors can include the following in a t/has_version.t file and let "Test::HasVersion" find and check all installable PM files in a distribution. use Test::More; eval "use Test::HasVersion"; plan skip_all => 'Test::HasVersion required for testing for version numbers' if $@; all_pm_version_ok(); DESCRIPTION
Do you wanna check that every one of your Perl modules in a distribution has a version number? You wanna make sure you don't forget the brand new modules you just added? Well, that's the module you have been looking for. Use it! Do you wanna check someone else's distribution to make sure the author have not commited the sin of leaving Perl modules without a version that can be used to tell if you have this or that feature? "Test::HasVersion" is also for you, nasty little fellow. There's a script test_version which is installed with this distribution. You may invoke it from within the root directory of a distribution you just unpacked, and it will check every .pm file in the directory and under lib/ (if any). $ test_version You may also provide directories and files as arguments. $ test_version *.pm lib/ inc/ $ test_version . (Be warned that many Perl modules in a t/ directory do not receive versions because they are not used outside the distribution.) Ok. That's not a very useful module by now. But it will be. Wait for the upcoming releases. FUNCTIONS PRIVATE _pm_version $v = _pm_version($pm); Parses a PM file and return what it thinks is $VERSION in this file. (Actually implemented with "use ExtUtils::MakeMaker; MM->parse_version($file)".) $pm is the filename (eg., lib/Data/Dumper.pm). pm_version_ok pm_version_ok('Module.pm'); pm_version_ok('M.pm', 'Has valid version'); Checks to see if the given file has a valid version. Actually a valid version number is defined and not equal to 'undef' (the string) which is return by "_pm_version" if a version cannot be determined. all_pm_version_ok all_pm_version_ok(); all_pm_version_ok(@PM_FILES); Checks every given file and .pm files found under given directories to see if they provide valid version numbers. If no argument is given, it defaults to check every file *.pm in the current directory and recurses under the lib/ directory (if it exists). If no test plan was setted, "Test::HasVersion" will set one after computing the number of files to be tested. Otherwise, the plan is left untouched. PRIVATE _list_pm_files @pm_files = _list_pm_files(@dirs); Returns all PM files under the given directories. all_pm_files @files = all_pm_files() @files = all_pm_files(@files_and_dirs); Implements finding the Perl modules according to the semantics of the previous function "all_pm_version_ok". USAGE
Other usage patterns besides the ones given in the synopsis. use Test::More tests => $num_tests; use Test::HasVersion; pm_version_ok($file1); pm_version_ok($file2); Obviously, you can't plan twice. use Test::More; use Test::HasVersion; plan tests => $num_tests; pm_version_ok($file); "plan" comes from "Test::More". use Test::More; use Test::HasVersion; plan 'no_plan'; pm_version_ok($file); "no_plan" is ok either. SEE ALSO
Test::Version Please reports bugs via CPAN RT, http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-HasVersion AUTHOR
A. R. Ferreira, <ferreira@cpan.org> COPYRIGHT AND LICENSE
Copyright (C) 2006 by A. R. Ferreira This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.10.0 2006-10-07 HasVersion(3pm)
Man Page