The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-VTide-v0.1.5
River stage zero No dependents
1 ++
/ App::VTide::Command

NAME

App::VTide::Command - Base class for VTide sub commands

VERSION

This documentation refers to App::VTide::Command version 0.1.5

SYNOPSIS

    # in a package with the prefix App::VTide::Command::
    extends 'App::VTide::Command';

    # child class code

DESCRIPTION

App::VTide::Command is the base class for the sub-commands of vtide. It provides helper methods and default attributes for those commands.

SUBROUTINES/METHODS

new ( %hash )

See the attributes for the arguments to pass here.

session_dir ( $name )

Get the session directory for $name.

save_session ( $name, $dir )

Save the session and directory in the history file if it is configured. If its not, then the environment variable $VTIDE_DIR is used and failing that falls back to the current directory. The local .vtide.yml is then loaded into the config.

env ( $name, $dir, $config )

Configure the environment variables based on $name, $dir and $config

auto_complete ()

Default auto-complete action for sub-commands

_dglob ( $glob )

Gets the files globs from $glob

_globable ( $glob )

Converts a deep blog (e.g. **/*.js) to a series of perl globs (e.g. ['*.js', '*/*.js', '*/*/*.js', '*/*/*/*.js'])

ATTRIBUTES

defaults

Values from command line arguments

options

Command line configuration

vtide

Reference to parent command with configuration object.

history

History configuration file

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.