No::Worries::Dir(3)

🎀 NAME 🎀

No::Worries::Dir(3) — directory handling without worries. It's a User Contributed Perl Documentation page, and it's here to make directory stuff feel way less feral. 💖

🛠️ SYNOPSIS 🛠️

use No::Worries::Dir
    qw(dir_change dir_ensure dir_make dir_parent dir_read dir_remove);

# change directory
dir_change("/tmp");

# make sure a directory exists (not an error if it exists already)
dir_ensure("/tmp/some/path", mode => oct(770));

# make a directory (an error if it exists already)
dir_make("/tmp/some/path", mode => oct(770));

# find out the parent directory of some path
$parent = dir_parent($path);
dir_ensure($parent);

# read a directory
foreach $name (dir_read("/etc")) {
    ...
}

# remove a directory
dir_remove("/tmp/some/path");

💅 DESCRIPTION 💅

Okay so this module eases directory handling by giving you convenient wrappers around standard directory functions. All the functions die() on error. Not a vibe when something breaks, but at least it's consistent. 😭

✨ FUNCTIONS ✨

This module provides the following functions (none of them being exported by default):

• dir_change(PATH) — changes the working directory to the given path. It's a safe thin wrapper on top of chdir(). 🌀
• dir_ensure(PATH[, OPTIONS]) — makes sure the given path is an existing directory, creating it (including its parents) if needed. Supported options:
  • "mode" — numerical mode to use for mkdir() (default: oct(777)). 🛠️
• dir_make(PATH[, OPTIONS]) — makes the given directory. It's a safe thin wrapper on top of mkdir(). Supported options:
  • "mode" — numerical mode to use for mkdir() (default: oct(777)). ✨
• dir_parent(PATH) — returns the parent directory of the given path. 🧚
• dir_read(PATH) — reads the given directory and returns its list of entries except . and ... 🦋
• dir_remove(PATH) — removes the given directory (that must exist and be empty). It's a safe thin wrapper on top of rmdir(). 💅

yes bestie, it must exist and be empty — no sneaky non-empty dirs allowed. 🙈

👀 SEE ALSO 👀

No::Worries. That's the whole list, and it's iconic. 💜

💌 AUTHOR 💌

Lionel Cons <http://cern.ch/lionel.cons> — hello legend. 🫶

Copyright (C) CERN 2012-2019

---

And the footer energy: this page is from perl v5.32.1, dated 2021-10-18, and it's No::Worries::Dir(3). Slay. 🎀✨