/ 
App-TaggedDirUtils-0.002
River stage one • 1 direct dependent • 1 total dependent
/ App::TaggedDirUtils

NAME

App::TaggedDirUtils - CLI utilities related to tagged directories

VERSION

This document describes version 0.002 of App::TaggedDirUtils (from Perl distribution App-TaggedDirUtils), released on 2021-08-23.

SYNOPSIS

See CLIs included in this distribution.

DESCRIPTION

This distribution includes several utilities related to tagged directories:

A "tagged directory" is a directory which has one or more tags: usually empty files called .tag-TAGNAME, where TAGNAME is some tag name.

You can backup, rsync, or do whatever you like with a tagged directory, just like a normal filesystem directory. The utilities provided in this distribution help you handle tagged directories.

FUNCTIONS

list_tagged_dirs

Usage:

list_tagged_dirs(%args) -> [$status_code, $reason, $payload, \%result_meta]

Search tagged directories recursively in a list of places.

Note: when a tagged dir is found, its contents are no longer recursed to search for other tagged dirs.

This function is not exported.

Arguments ('*' denotes required arguments):

  • detail => bool

  • has_files => array[filename]

  • has_tags => array[str]

  • lacks_files => array[filename]

  • lacks_tags => array[str]

  • prefixes* => array[dirname]

    Locations to search for tagged directories.

    Location(s) to search for tagged subdirectories, i.e. directories which have some file with specific names in its root.

Returns an enveloped result (an array).

First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata.

Return value: (any)

FAQ

Why tagged directories?

With tagged directories, you can put them in various places and not just on a single parent directory. For example:

media/
  2020/
    media-2020a/ -> a tagged dir
      .tag-media
      ...
    media-2020b/ -> a tagged dir
      .tag-media
      ...
  2021/
    media-2021a/ -> a tagged dir
      .tag-media
      ...
  etc/
    foo -> a tagged dir
      .tag-media
      ...
    others/
      bar/ -> a tagged dir
        .tag-media
        ...

As an alternative, you can also create symlinks:

all-media/
  media-2020a -> symlink to ../media/2020/media-2020a
  media-2020b -> symlink to ../media/2020/media-2020b
  media-2021a -> symlink to ../media/2021/media-2021a
  media-2021b -> symlink to ../media/2021/media-2021b
  foo -> symlink to ../media/etc/foo
  bar -> symlink to ../media/etc/others/bar

and process entries in all-media/.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-TaggedDirUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-TaggedDirUtils.

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 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=App-TaggedDirUtils

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.