File::MoreUtil - File-related utilities
This document describes version 0.622 of File::MoreUtil (from Perl distribution File-MoreUtil), released on 2019-08-17.
use File::MoreUtil qw( file_exists l_abs_path dir_empty dir_has_files dir_has_dot_files dir_has_non_dot_files dir_has_subdirs dir_has_dot_subdirs dir_has_non_dot_subdirs ); print "file exists" if file_exists("/path/to/file/or/dir"); print "absolute path = ", l_abs_path("foo"); print "dir exists and is empty" if dir_empty("/path/to/dir");
None are exported by default, but they are exportable.
Usage:
file_exists($path) => BOOL
This routine is just like the -e test, except that it assume symlinks with non-existent target as existing. If sym is a symlink to a non-existing target:
sym
-e "sym" # false, Perl performs stat() which follows symlink
but:
-l "sym" # true, Perl performs lstat() -e _ # false
This function performs the following test:
!(-l "sym") && (-e _) || (-l _)
l_abs_path($path) => STR
Just like Cwd::abs_path(), except that it will not follow symlink if $path is symlink (but it will follow symlinks for the parent paths).
Example:
use Cwd qw(getcwd abs_path); say getcwd(); # /home/steven # s is a symlink to /tmp/foo say abs_path("s"); # /tmp/foo say l_abs_path("s"); # /home/steven/s # s2 is a symlink to /tmp say abs_path("s2/foo"); # /tmp/foo say l_abs_path("s2/foo"); # /tmp/foo
Mnemonic: l_abs_path -> abs_path is analogous to lstat -> stat.
Note: currently uses hardcoded / as path separator.
/
dir_empty($dir) => BOOL
Will return true if $dir exists and is empty.
$dir
This should be trivial but alas it is not. -s always returns true (in other words, -z always returns false) for a directory.
-s
-z
dir_has_files($dir) => BOOL
Will return true if $dir exists and has one or more plain files in it. A plain file is one that passes Perl's -f operator. A symlink to a plain file counts as a plain file. Non-plain files include named pipes, Unix sockets, and block/character special files.
-f
dir_has_dot_files($dir) => BOOL
Will return true if $dir exists and has one or more plain dot files in it. See "dir_has_files" for the definition of plain files. Dot files a.k.a. hidden files are files with names beginning with a dot.
dir_has_non_dot_files($dir) => BOOL
Will return true if $dir exists and has one or more plain non-dot files in it. See "dir_has_dot_files" for the definitions. =head2 dir_has_subdirs
Will return true if $dir exists and has one or more subdirectories in it.
dir_has_dot_subdirs($dir) => BOOL
Will return true if $dir exists and has one or more dot subdirectories (i.e. subdirectories with names beginning with a dot) in it.
dir_has_non_dot_subdirs($dir) => BOOL
Will return true if $dir exists and has one or more non-dot subdirectories (i.e. subdirectories with names not beginning with a dot) in it.
For checking if some path exists, is a plain file, and is empty (content is zero-length), you can simply use the -z filetest operator.
Please visit the project's homepage at https://metacpan.org/release/File-MoreUtil.
Source repository is at https://github.com/perlancar/perl-SHARYANTO-File-Util.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=File-MoreUtil
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.
App::FileTestUtils includes CLI's for functions like "dir_empty", etc.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2019, 2017, 2015, 2014, 2013 by perlancar@cpan.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.
To install File::MoreUtil, copy and paste the appropriate command in to your terminal.
cpanm
cpanm File::MoreUtil
CPAN shell
perl -MCPAN -e shell install File::MoreUtil
For more information on module installation, please visit the detailed CPAN module installation guide.