QA: Package coding standards check

HELLO ALL YOU PEAR DEVELOPERS,


OUR QUALITY ASSURANCE SUITE NOW UTILIZES OUR GREAT PACKAGE
PHP_CODESNIFFER TO GENERATE REPORTS ABOUT EACH PACKAGE'S
CODING
STANDARDS COMPLIANCE.

YOU CAN GET THE FULL OVERVIEW AT
 HTTP://PEAR.CWEISKE.DE/OVERVIEW.HTM
JUST CLICK AT THE CS ERROR/WARNING COUNT TO GET A DETAILLED
LISTING OF
PROBLEMS IN THE PACKAGE.

PLEASE ALSO NOTE THAT WE'RE CURRENTLY EVALUATING TO EXTEND
AND CLARIFY
THE STANDARDS. SEE MY LAST EMAIL TO THIS LIST OR
HTTP://WIKI.PEAR.PHP.NET/INDEX.PHP/CODINGSTANDARDSCHANGES


AS ALWAYS, COMMENTS ARE VERY WELCOME.

-- 
REGARDS/MIT FREUNDLICHEN GRüßEN
CHRISTIAN WEISKE

Christian Weiske wrote:
> 
> As always, comments are very welcome.
> 

I noticed I got a lot of errors for javascript code
contained inside a 
heredoc... can it ignore this sort of thing?

-- 
     David Sanders
     shangxiao

-- 
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub
.php

I agree with Lukas that equals sign alignment is rather
annoying.

Also, this piece of code:

<?php
$result = $this->dumpSequence(
    $database_definition['sequences'][$sequence],
    $sequence, $eol, $dump
);
?>

gives me the errors:
error  	458  	Space after opening parenthesis of function
call prohibited
error 	461 	Space before closing parenthesis of function
call prohibited

I can't keep the lines behind the 85 character limit if I am
not
allowed to break the functions arguments.

regards,
iGor.

On 10/22/07, Christian Weiske <cweiskecweiske.de> wrote:
> Hello all you pear developers,
>
>
> Our quality assurance suite now utilizes our great
package
> PHP_CodeSniffer to generate reports about each
package's coding
> standards compliance.
>
> You can get the full overview at
>  http://pear.cweis
ke.de/overview.htm
> Just click at the CS error/warning count to get a
detailled listing of
> problems in the package.
>
> Please also note that we're currently evaluating to
extend and clarify
> the standards. See my last email to this list or
> http://wiki.pear.php.net/index.php/CodingStandardsChang
es
>
>
> As always, comments are very welcome.
>
> --
> Regards/Mit freundlichen Grüßen
> Christian Weiske
>
>

On 10/22/07, Igor Feghali <igor.feghaligmail.com> wrote:
>
> <?php
> $result = $this->dumpSequence(
>     $database_definition['sequences'][$sequence],
>     $sequence, $eol, $dump
> );
> ?>
>
> gives me the errors:
> error   458     Space after opening parenthesis of
function call
> prohibited
> error   461     Space before closing parenthesis of
function call
> prohibited
>
> I can't keep the lines behind the 85 character limit if
I am not allowed
> to break the functions arguments.
>

I've dealt with blocks like that in this manner:
<?php
$result =
$this->dumpSequence($database_definition['sequences'][$se
quence],
    $sequence, $eol, $dump);
?>

The combination of "85-char line limit", "no
space after opening paren", and
"no space after closing paren" make it difficult
to easily modify long lines
like that.  Add to that the occurrences of array variables
with ~30chars in
their name and ~10+chars in their multiple-level keys, and
you have some
impossible-to-shorten lines while still indenting properly.
-- 
CRB

Let me introduce you to my very own DMCA-protected
encryption key:
BC 1B 64 4A 8D DE 49 E8 C3 7D CC EE 1A AD EE F5
(compliments of Freedom-to-Tinker http://www.f
reedom-to-tinker.com/?p=1155)

you should go back to stone ages and name your vars $a, $b,
$c 

On 10/22/07, Chuck Burgess <demon.genegmail.com> wrote:
> On 10/22/07, Igor Feghali <igor.feghaligmail.com> wrote:
> >
> > <?php
> > $result = $this->dumpSequence(
> >     $database_definition['sequences'][$sequence],
> >     $sequence, $eol, $dump
> > );
> > ?>
> >
> > gives me the errors:
> > error   458     Space after opening parenthesis of
function call
> > prohibited
> > error   461     Space before closing parenthesis
of function call
> > prohibited
> >
> > I can't keep the lines behind the 85 character
limit if I am not allowed
> > to break the functions arguments.
> >
>
> I've dealt with blocks like that in this manner:
> <?php
> $result =
$this->dumpSequence($database_definition['sequences'][$se
quence],
>     $sequence, $eol, $dump);
> ?>
>
> The combination of "85-char line limit",
"no space after opening paren", and
> "no space after closing paren" make it
difficult to easily modify long lines
> like that.  Add to that the occurrences of array
variables with ~30chars in
> their name and ~10+chars in their multiple-level keys,
and you have some
> impossible-to-shorten lines while still indenting
properly.
> --
> CRB
>
> Let me introduce you to my very own DMCA-protected
encryption key:
> BC 1B 64 4A 8D DE 49 E8 C3 7D CC EE 1A AD EE F5
> (compliments of Freedom-to-Tinker http://www.f
reedom-to-tinker.com/?p=1155)
>

-- 
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub
.php

whoever drew up the coding standards must've forgotten to
put the "no space 
except for newlines" clause in there somewhere.

i prefer igor's method ;)

Chuck Burgess wrote:
> On 10/22/07, Igor Feghali <igor.feghaligmail.com> wrote:
>> <?php
>> $result = $this->dumpSequence(
>>     $database_definition['sequences'][$sequence],
>>     $sequence, $eol, $dump
>> );
>> ?>
>>
>> gives me the errors:
>> error   458     Space after opening parenthesis of
function call
>> prohibited
>> error   461     Space before closing parenthesis of
function call
>> prohibited
>>
>> I can't keep the lines behind the 85 character
limit if I am not allowed
>> to break the functions arguments.
>>
> 
> I've dealt with blocks like that in this manner:
> <?php
> $result =
$this->dumpSequence($database_definition['sequences'][$se
quence],
>     $sequence, $eol, $dump);
> ?>
> 
> The combination of "85-char line limit",
"no space after opening paren", and
> "no space after closing paren" make it
difficult to easily modify long lines
> like that.  Add to that the occurrences of array
variables with ~30chars in
> their name and ~10+chars in their multiple-level keys,
and you have some
> impossible-to-shorten lines while still indenting
properly.


-- 
     David Sanders
     Software Engineer
     Baseline Solutions Pty Ltd
     Suite 201 832 High St
     East Kew VIC 3102 Australia
     Phone: (03) 9249 9687  Fax: (03) 9249 9600
     http://baselinesoluti
ons.com.au
============================================================
============
This e-mail contains privileged and confidential
information. If you are
not the intended recipient of this e-mail, you are hereby
notified that
you must not disseminate, copy or take any action in
reliance on it.
Please notify Baseline Solutions Pty Ltd via e-mail
(securitybaselinesols.com) if you are not the intended
addressee of
this e-mail transmission. Any views or opinions presented in
this
message are solely those of the author.
============================================================
============

-- 
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub
.php

Matthew,

> My package, File_Fortune, isn't on the list. Is this
because it's not in
> CVS? (I have public releases, but haven't put the code
in CVS at this
> point.)
Yes. All the statistics and checks in our QA suite are run
on a current CVS checkout, so all packages that are not in
CVS can't benefit from it.

If you are using some publicy available svn I can make the
script checkout from it, too.

-- 
Christian Weiske

-- 
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub
.php

Christian Weiske wrote:
> Hello all you pear developers,
>
>
> Our quality assurance suite now utilizes our great
package
> PHP_CodeSniffer to generate reports about each
package's coding
> standards compliance.
>
> You can get the full overview at
>  http://pear.cweis
ke.de/overview.htm
> Just click at the CS error/warning count to get a
detailled listing of
> problems in the package.
>   
I'm sure there are quite a few bugs on it ;)
Things that look like spurious errors.
- ***** tag comment indented incorrectly. Expected 3
spaces but found 4.
- Line indented incorrectly; expected 8 spaces, found 12
(related to the 
case issue with the CS)

While it's a CS issue, some issues are more serious than
others?
- No space found after comma in function call

I'm sure there are other issues, but it would help to see
the line that 
the Error is talking about displayed next to or after the
error
Regards
Alan
> Please also note that we're currently evaluating to
extend and clarify
> the standards. See my last email to this list or
> http://wiki.pear.php.net/index.php/CodingStandardsChang
es
>
>
> As always, comments are very welcome.
>
>   

-- 
PEAR Development Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub
.php