29 Apr 2011 12:24:08 UTC
- Distribution: CatalystX-Starter
- Module version: 0.07
- Source (raw)
- Browse (raw)
- How to Contribute
- Clone repository
- Issues (0)
- Testers (638 / 1 / 0)
- KwaliteeBus factor: 3
- 86.87% Coverage
- License: perl_5
- Activity24 month
- Download (22.95KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionBOBTFISH Tomas Doranand 1 contributors
- =head1 COPYRIGHT & LICENSE
CatalystX::Starter - bootstrap a CPAN-able Catalyst component
module-starter, but sane:
$ catalystx-starter 'Module::Name' $ cd Module-Name $ git init $ mv gitignore .gitignore $ git add .gitignore * $ git ci -m 'Start my component'
Then edit Changes and README to taste
$ mg README $ mg Changes $ git ci -a -m 'update Changes and README'
Then you're ready to work:
$ make test 00load.............ok live...............ok All tests successful. $ prove --lib t/author # don't want users running these pod................ok pod-coverage.......ok All tests successful.
Recently, I've stopped using
Module::Starter, because it generates way too much boilerplate and not enough of stuff I actually need. I find it easier to just start with nothing and manually write what I need.
CatalystX::Starterautomates this minimalism for me. It will create everything you need to start developing a Catalyst component or plugin, but won't create useless crap that you just have to delete.
Here's what you get:
A live app that can be run from tests (including
t/live-test.t). It also comes with the
testapp_test.pl, so you can try our your TestApp from the command line. Yay for never having to write this again.
So far, I've wasted more than an hour of my life typing this exact TestApp code in again and again. Now it's automatic. FINALLY.
Module::Install-based Makefile.PL with
build_requiresset up to run the default tests.
Save yourself the effort of setting up a
.gitignore. You can of course import this as
.cvsignore. I use git, so that's what you get by default.
Note that you have to rename this yourself, because I want git to track it, not treat it as an ignore file.
A useful MANIFEST.SKIP that ignores stuff that
makeleaves lying around, and my
- Changes / README
No text in here. Change it to what you want it to look like.
package Your::Module; use strict; use warnings; 1;
Write the POD yourself. You're smart enough to remember that the sequence is NAME, SYNOPSIS, DESCRIPTION, METHODS, BUGS, AUTHOR, COPYRIGHT. If not... now you are :)
That's about it. Enjoy.
catalyst.pl, for creating Catalyst applications.
Module::Starter, if you like deleting code more than writing it.
I don't assert any copyright over the generated files. This module itself is copyright (c) 2007 Jonathan Rockway and is licensed under the same terms as Perl itself.
Module Install Instructions
To install CatalystX::Starter, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install CatalystX::Starter
For more information on module installation, please visit the detailed CPAN module installation guide.