Re: CLI command naming conventions?
| From: | Chuck Burgess | Date: | Sat, 12 Apr 2008 02:01:52 +0000 |
| Subject: | Re: CLI command naming conventions? | ||
| References: | 1 2 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-49753@lists.php.net to get a copy of this message | ||
On Fri, Apr 11, 2008 at 8:33 PM, Helgi Þormar Þorbjörnsson <
helgith@gmail.com> wrote:
> On Sat, Apr 12, 2008 at 1:00 AM, Joe Stump <joe@joestump.net> wrote:
> > Do we have naming conventions for naming CLI utilities that ship with
> > packages?
I'm also not aware of any *conventions* per se, though based on the few CLI
utility apps that I've seen in PEAR, it looks like the main thing would be
for the name to semi-reasonably match the package name that it is the key
runtime script for:
- pear - PEAR
- pearsize - PEAR_Size
- phpdoc - PhpDocumentor
- phpcs - PHP_Codesniffer
- docblockgen - PHP_DocBlockGenerator
- php_beautifier - PHP_Beautifier
I suppose another convention would be to keep its name all lowercase, to
avoid complications with case-sensitive vs. case-insensitive platforms.
An observation I've made in looking at these various runtimes is that the
*nix executable script has no extension, while the Windows executable should
be the same name plus the *.bat* extension. Presumably this is so the same
*command* can be used on either platform, without requiring any extension to
be typed.
--
CRB