The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Tree::From::FS - Create a tree object from directory structure on the filesystem

VERSION

This document describes version 0.000.2 of Tree::From::FS (from Perl distribution Tree-From-FS), released on 2021-10-07.

SYNOPSIS

DESCRIPTION

PLACEHOLDER. NOT YET IMPLEMENTED.

FUNCTIONS

create_tree_from_dir($path) => obj

This module provides a convenience function to build a tree of objects that mirrors a directory structure on the filesystem. Each node will represent a file or a subdirectory.

The class can be any class that provides parent and children methods. See Role::TinyCommons::Tree::Node for more details on the requirement.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Tree-From-FS.

SOURCE

Source repository is at https://github.com/perlancar/perl-Tree-FromFS.

SEE ALSO

RoleBundle::TinyCommons::Tree

Other ways to create tree: Tree::From::Struct, Tree::From::ObjArray, Tree::From::Text, Tree::From::TextLines, Tree::Create::Callback, Tree::Create::Size.

AUTHOR

perlancar <perlancar@cpan.org>

CONTRIBUTING

To contribute, you can send patches by email/via RT, or send pull requests on GitHub.

Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:

 % prove -l

If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.

COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2020, 2016 by perlancar <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.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Tree-From-FS

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.