NAME

App::VTide::Hooks - Manage code hooks for APP::VTide

VERSION

This documentation refers to App::VTide::Hooks version 1.0.5

SYNOPSIS

   use App::VTide::Hooks;

   # Brief but working code example(s) here showing the most common usage(s)
   # This section will be as far as many users bother reading, so make it as
   # educational and exemplary as possible.

DESCRIPTION

This module provides the basis from running user defined hooks. Those hooks are located in the ~/.vtide/hooks.pl and $PROJECT/.vtide/hooks.pl files. They are perl files that are expected to return a hash where the keys are the hook names and the values are subs to be run. Details about individual hooks can be found in the various sub-command modules.

SUBROUTINES/METHODS

run ( $hook, @args )

The the hook $hook with the supplied arguments.

ATTRIBUTES

vtide

Reference to the vtide object

hook_cmds

Hash of configured hook subroutines

DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Ivan Wills (ivan.wills@gmail.com).

Patches are welcome.

AUTHOR

Ivan Wills - (ivan.wills@gmail.com)

LICENSE AND COPYRIGHT

Copyright (c) 2016 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW Australia 2077). All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.