script/catalyst.pl

   1 #!/usr/bin/perl -w
   2
   3 use strict;
   4 use Getopt::Long;
   5 use Pod::Usage;
   6 use Catalyst::Helper;
   7
   8 my $help  = 0;
   9 my $nonew = 0;
  10
  11 GetOptions(
  12     'help|?' => \$help,
  13     'nonew'  => \$nonew
  14 );
  15
  16 pod2usage(1) if ( $help || !$ARGV[0] );
  17
  18 my $helper = Catalyst::Helper->new( { '.newfiles' => !$nonew } );
  19 pod2usage(1) unless $helper->mk_app( $ARGV[0] );
  20
  21 1;
  22 __END__
  23
  24 =head1 NAME
  25
  26 catalyst - Bootstrap a Catalyst application
  27
  28 =head1 SYNOPSIS
  29
  30 catalyst.pl [options] application-name
  31
  32  Options:
  33    -help        display this help and exits
  34    -nonew       don't create a .new file where a file to be created exists
  35
  36  application-name must be a valid Perl module name and can include "::"
  37
  38  Examples:
  39     catalyst.pl My::App
  40     catalyst.pl MyApp
  41
  42
  43 =head1 DESCRIPTION
  44
  45 The C<catalyst.pl> script bootstraps a Catalyst application, creating a
  46 directory structure populated with skeleton files.
  47
  48 The application name must be a valid Perl module name.  The name of the
  49 directory created is formed from the application name supplied, with double
  50 colons replaced with hyphens (so, for example, the directory for C<My::App> is
  51 C<My-App>).
  52
  53 Using the example application name C<My::App>, the application directory will
  54 contain the following items:
  55
  56 =over 4
  57
  58 =item README
  59
  60 a skeleton README file, which you are encouraged to expand on
  61
  62 =item Build.PL
  63
  64 a C<Module::Build> build script
  65
  66 =item Changes
  67
  68 a changes file with an initial entry for the creation of the application
  69
  70 =item Makefile.PL
  71
  72 an old-style MakeMaker script.  Catalyst uses the C<Module::Build> system so
  73 this script actually generates a Makeifle that invokes the Build script.
  74
  75 =item lib
  76
  77 contains the application module (C<My/App.pm>) and
  78 subdirectories for model, view, and controller components (C<My/App/M>,
  79 C<My/App/V>, and C<My/App/C>).
  80
  81 =item root
  82
  83 root directory for your web document content.  This is left empty.
  84
  85 =item script
  86
  87 a directory containing helper scripts:
  88
  89 =over 4
  90
  91 =item C<my_app_create.pl>
  92
  93 helper script to generate new component modules
  94
  95 =item C<my_app_server.pl>
  96
  97 runs the generated application within a Catalyst test server, which can be
  98 used for testing without resorting to a full-blown web server configuration.
  99
 100 =item C<my_app_cgi.pl>
 101
 102 runs the generated application as a CGI script
 103
 104 =item C<my_app_fastcgi.pl>
 105
 106 runs the generated application as a FastCGI script
 107
 108
 109 =item C<my_app_test.pl>
 110
 111 runs an action of the generated application from the comand line.
 112
 113 =back
 114
 115 =item t
 116
 117 test directory
 118
 119 =back
 120
 121
 122 The application module generated by the C<catalyst.pl> script is functional,
 123 although it reacts to all requests by outputting a friendly welcome screen.
 124
 125
 126 =head1 NOTE
 127
 128 Neither C<catalyst.pl> nor the generated helper script will overwrite existing
 129 files.  In fact the scripts will generate new versions of any existing files,
 130 adding the extension C<.new> to the filename.  The C<.new> file is not created
 131 if would be identical to the existing file.
 132
 133 This means you can re-run the scripts for example to see if newer versions of
 134 Catalyst or its plugins generate different code, or to see how you may have
 135 changed the generated code (although you do of course have all your code in a
 136 version control system anyway, don't you ...).
 137
 138
 139
 140 =head1 SEE ALSO
 141
 142 L<Catalyst::Manual>, L<Catalyst::Manual::Intro>
 143
 144 =head1 AUTHOR
 145
 146 Sebastian Riedel, C<sri@oook.de>,
 147 Andrew Ford, C<A.Ford@ford-mason.co.uk>
 148
 149
 150 =head1 COPYRIGHT
 151
 152 Copyright 2004-2005 Sebastian Riedel. All rights reserved.
 153
 154 This library is free software, you can redistribute it and/or modify it under
 155 the same terms as Perl itself.
 156
 157 =cut