NAME

Taskwarrior::Kusarigama::Plugin - Base class for Kusarigama plugins

VERSION

version 0.0.1

SYNOPSIS

package Taskwarrior::Kusarigama::Plugin::Foo;

use Moo;

extends 'Taskwarrior::Kusarigama::Plugin';

with 'Taskwarrior::Kusarigama::Hook::OnLaunch';

sub on_launch { ... }'

1;

DESCRIPTION

Base class for all Taskwarrior::Kusarigama plugins.

METHODS

new

my $plugin = Taskwarrior::Kusarigama::Plugin->new(
    tw => $tw,
);

Constructor. Supports the following arguments.

tw

Associated Taskwarrior::Kusarigama::Hook object. Required.

name

Plugin name. If not provided, it is derived from the package name.

tw

Returns the associated Taskwarrior::Kusarigama::Hook object.

All the Taskwarrior::Kusarigama::Core methods are made available to the plugin object via this attribute.

name

Returns the plugin name.

setup

Method used by task-kusarigama to set up the plugin. If the plugin defines any UDAs, they will be created. Likewise, if the plugin is a custom command, a dummy report will be created in the taskwarrior configuration to allow it to be used.

AUTHOR

Yanick Champoux <yanick@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 by Yanick Champoux.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.