module-starter icon indicating copy to clipboard operation
module-starter copied to clipboard

Document and enforce Distribution-Name and Module::Name conventions [rt.cpan.org #66606]

Open xsawyerx opened this issue 9 years ago • 1 comments

https://rt.cpan.org/Ticket/Display.html?id=66606

Andy,

I've really enjoyed this module since finding it a few years ago.

Even with many years in the Perl community, I wasn't sure how to name
pass arguments to this.  I was so module-centric in my thinking that I
didn't (fully) know what a distribution was.  I had conflated them in my
mind.

I think it would be great to give example command-line examples with
real-world (not symbolic) arguments.

Simple, 1-module distribution:

module-maker --distro=MyCompany-DBI --module=MyCompany::DBI
  equivalent to:
module-maker --module=MyCompany::DBI

More complex, multi-module distribution:

module-maker --distro=MyCompany::Communication
--module=MyCompany::Communication::HTTP,MyCompany::Communication::FTP,MyCompany::Communication::Paper,MyCompany::Communication::Paper::CottonBond,MyCompany::Communication::Paper::HempFiber

In addition, doing a quick naming-convention check (with appropriate
errors) would be helpful and instructive to newbies (and not-so-newbies
like me).

If you like this idea enough to approve it, but don't have time to code
it, let me know.  I'd be happy to submit patches.

Thanks,
Michael

xsawyerx avatar Jan 05 '15 18:01 xsawyerx