NAME

Egg::Helper - Helper module for Egg.

DESCRIPTION

This module is started by the helper script.

Helper of standard appending.

• "Egg::Helper::Build::Module ".

  The template of the Perl module is generated.

• Egg::Helper::Build::Plugin.

  The template of the plug-in module is generated.

• Egg::Helper::Build::Project.

  The project is constructed.

• Egg::Helper::Build::Prototype.

  'prototype.js' etc. are output.

• Egg::Helper::Config::YAML.

  The model of the configuration of the YAML form is generated.

• Egg::Helper::Util::Tester.

  Test of project application.

• Egg::Helper::Util::VirtualProject.

  Virtual project for package test.

METHODS

run

When the helper script is started, this method is called.

helper_tools

Especially, nothing is done. Helper object is only returned.

The thing used to cause some actions as the file is made before the Egg::Helper::Util::VirtualProject object is acquired in the package test etc. is assumed.

  use Egg::Helper;
  
  my $tool= Egg::Helper->helper_tools;
  
  $tool->helper_create_file(join '', <DATA>);
  .....

It is a project object that this method returns that succeeds to Egg::Helper::Util::Base.

helper_script

The code of the helper scripting to generate the project is returned.

To generate the helper script, as follows is done.

  % perl -MEgg::Helper -e 'Egg::Helper->helper_script' > /path/to/egg_helper.pl

I think that the generated script is convenient when it outputs to the place that passing passed, and the execution attribute is given at the right time.

And, the project is generated as follows.

  % egg_helper.pl project [PROJECT_NAME] -o/path/to

• Alias = out

SEE ALSO

Egg, Egg::Release, Egg::Helper::Util::Base,

AUTHOR

Masatoshi Mizuno <lushe@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2008 Bee Flag, Corp. <http://egg.bomcity.com/>, All Rights Reserved.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.6 or, at your option, any later version of Perl 5 you may have available.