NAME

App::CLI::Plugin::StackTrace - for App::CLI::Extension error stacktrace module

VERSION

1.1

SYNOPSIS

  # MyApp.pm
  package MyApp;
  
  use strict;
  use base qw(App::CLI::Extension);
  
  # extension method
  __PACKAGE__->load_plugins(qw(StackTrace));

  __PACKAGE__->config(stacktrace => 1);
  
  1;
  
  # MyApp/Hello.pm
  package MyApp::Hello;
  use strict;
  use feature ":5.10.0";
  use base qw(App::CLI::Command);
  
  sub run {
  
      my($self, @args) = @_;
          my $x = 1;
          my $y = 0;
          my $res = $x / $y;
  }
  
  sub fail {
  
      my($self, @args) = @_;
          print $self->e;
          $self->exit_value(1);
  }
  
  # myapp
  #!/usr/bin/perl
  
  use strict;
  use MyApp;
  
  MyApp->dispatch;
  
  # execute
  [kurt@localhost ~] ./myapp hello
  MyApp::Hello
  
    Illegal division by zero at lib/MyApp/Hello.pm line 17.
  
  
  ----------
    MyApp::Hello at lib/MyApp/Hello.pm line 17.
  
       00012: sub run {
       00013:   
       00014:   my($self, @args) = @_;
       00015:   my $x = 1;
       00016:   my $y = 0;
     * 00017:   my $res = $x / $y;
       00018: }
       00019:   
       00020: sub fail {
       00021:  
       00022:   my($self, @args) = @_;
  
    ==========
    App::CLI::Extension::Component::RunCommand at /usr/lib/perl5/site_perl/5.8.8/App/CLI/Extension/Component/RunCommand.pm line 36.
  
       00031: 
       00032:   try {
       00033:           $self->setup(@argv);
       00034:           $self->prerun(@argv);
       00035:           if ($self->finished == 0) {
     * 00036:                   $self->run(@argv);
       00037:                   $self->postrun(@argv);
       00038:           }
       00039:   }
       00040:   catch App::CLI::Extension::Exception with {
       00041:           # $self->e is App::CLI::Extension::Exception object. execute $self->throw($message)
  
    ==========
    App::CLI::Extension::Component::RunCommand at /usr/lib/perl5/site_perl/5.8.8/App/CLI/Extension/Component/RunCommand.pm line 54.
  
       00049:           $self->exit_value($FAIL_EXIT_VALUE);
       00050:           $self->fail(@argv);
       00051:   }
       00052:   finally {
       00053:           $self->finish(@argv);
     * 00054:   };
       00055: 
       00056:   if (exists $ENV{APPCLI_NON_EXIT}) {
       00057:           no strict "refs";  ## no critic
       00058:           my $dispatch_pkg = $self->app;
       00059:           ${"$dispatch_pkg\::EXIT_VALUE"} = $self->exit_value;
  
    ==========
    App::CLI::Extension at /usr/lib/perl5/site_perl/5.8.8/App/CLI/Extension.pm line 179.
  
       00174:                   unshift @{"$pkg\::ISA"}, @{$class->_plugins};
       00175:           }
       00176:           $cmd->config($class->_config);
       00177:           $cmd->orig_argv($class->_orig_argv);
       00178:   }
     * 00179:   $cmd->run_command(@ARGV);
       00180: }
       00181: 
       00182: ## I really does not want....
       00183: sub error_cmd {
       00184:   "Command not recognized, try $0 help.\n";
  
    ==========
    main at myapp line 7.
  
       00002: 
       00003: use strict;
       00004: use lib qw(./lib);
       00005: use MyApp;
       00006: 
     * 00007: MyApp->dispatch;
       00008: 
  
    ==========
  ----------

DESCRIPTION

App::CLI::Extension stacktrace plugin module

TIPS

How to display the stacktrace

CONFIG

If one is to enable the stacktrace is displayed when an error occurs. If enable is 0 is a normal error message appears when an error occurs

Example:

  # MyApp.pm
  __PACKAGE__->config(stacktrace => 1);

ENVIRON VARIABLE

APPCLI_STACKTRACE_ENABLE environ variable setup. 1: stacktrace 0: normal error message

Example:

  export APPCLI_STACKTRACE_ENABLE=1
  ./myapp hello

OPTION

stacktrace option allows you to specify at runtime, stacktrace can view

Example:

  # MyApp/Hello.pm
  sub options {
      return(stacktrace => "stacktrace");
  }

  # MyApp
  ./myapp --stacktrace hello

AUTHOR

Akira Horimoto

SEE ALSO

App::CLI::Extension Devel::StackTrace

LICENSE

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

Copyright (C) 2010 Akira Horimoto