cvs: pear /PHP_CodeSniffer/CodeSniffer/Standards/PHPCS PHPCSCodingStandard.php package.xml

squiz Thu May 17 01:31:41 2007 UTC

Added files:
/pear/PHP_CodeSniffer/CodeSniffer/Standards/PHPCS
PHPCSCodingStandard.php
package.xml
Log:
The coding standard used by PHPCS - combines Squiz and PEAR together. Good example of how to use existing sniffs to build your own standard.


http://cvs.php.net/viewvc.cgi/pear/P...markup&rev=1.1
Index: pear/PHP_CodeSniffer/CodeSniffer/Standards/PHPCS/PHPCSCodingStandard.php
+++ pear/PHP_CodeSniffer/CodeSniffer/Standards/PHPCS/PHPCSCodingStandard.php
<?php
/**
* PHP_CodeSniffer Coding Standard.
*
* PHP version 5
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@squiz.net>
* @author Marc McIntyre <mmcintyre@squiz.net>
* @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
* @version CVS: $Id: PHPCSCodingStandard.php,v 1.1 2007/05/17 01:31:41 squiz Exp $
* @link http://pear.php.net/package/PHP_CodeSniffer
*/

require_once 'PHP/CodeSniffer/Standards/CodingStandard.php';

/**
* PHP_CodeSniffer Coding Standard.
*
* @category PHP
* @package PHP_CodeSniffer
* @author Greg Sherwood <gsherwood@squiz.net>
* @author Marc McIntyre <mmcintyre@squiz.net>
* @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)
* @license http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence
* @version Release: @package_version@
* @link http://pear.php.net/package/PHP_CodeSniffer
*/
class PHP_CodeSniffer_Standards_PHPCS_PHPCSCodingStandar d extends PHP_CodeSniffer_Standards_CodingStandard
{


/**
* Return a list of external sniffs to include with this standard.
*
* The PHP_CodeSniffer standard combines the PEAR and Squiz standards
* but removes some sniffs from the Squiz standard that clash with
* those in the PEAR standard.
*
* @return array
*/
function getIncludedSniffs()
{
return array(
'PEAR',
'Squiz',
);

}//end getIncludedSniffs()


/**
* Return a list of external sniffs to exclude from this standard.
*
* The PHP_CodeSniffer standard combines the PEAR and Squiz standards
* but removes some sniffs from the Squiz standard that clash with
* those in the PEAR standard.
*
* @return array
*/
function getExcludedSniffs()
{
return array(
'Generic/Sniffs/PHP/UpperCaseConstantSniff',
'Squiz/Sniffs/Classes/ClassFileNameSniff',
'Squiz/Sniffs/Classes/ValidClassNameSniff',
'Squiz/Sniffs/Commenting/ClassCommentSniff',
'Squiz/Sniffs/Commenting/FileCommentSniff',
'Squiz/Sniffs/Commenting/FunctionCommentSniff',
'Squiz/Sniffs/Commenting/VariableCommentSniff',
'Squiz/Sniffs/ControlStructures/SwitchDeclarationSniff',
'Squiz/Sniffs/Files/FileExtensionSniff',
'Squiz/Sniffs/Files/LineLengthSniff',
'Squiz/Sniffs/WhiteSpace/ScopeIndentSniff',
);

}//end getExcludedSniffs()


}//end class
?>

http://cvs.php.net/viewvc.cgi/pear/P...markup&rev=1.1
Index: pear/PHP_CodeSniffer/CodeSniffer/Standards/PHPCS/package.xml
+++ pear/PHP_CodeSniffer/CodeSniffer/Standards/PHPCS/package.xml
<?xml version="1.0" encoding="UTF-8"?>
<package packagerversion="1.4.10" version="2.0" xmlns="http://pear.php.net/dtd/package-2.0" xmlns:tasks="http://pear.php.net/dtd/tasks-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://pear.php.net/dtd/tasks-1.0
http://pear.php.net/dtd/tasks-1.0.xsd
http://pear.php.net/dtd/package-2.0
http://pear.php.net/dtd/package-2.0.xsd">
<name>PHP_CodeSniffer_PHPCS</name>
<channel>pear.php.net</channel>
<summary>PHP_CodeSniffer standard for the PHP_CodeSniffer itself.</summary>
<description>The PHP_CodeSniffer standard combines the PEAR and Squiz standards but removes some sniffs from the Squiz standard that clash with those in the PEAR standard.</description>
<lead>
<name>Greg Sherwood</name>
<user>squiz</user>
<email>gsherwood@squiz.net</email>
<active>yes</active>
</lead>
<date>2007-05-17</date>
<time>15:49:21</time>
<version>
<release>0.1.0</release>
<api>0.1.0</api>
</version>
<stability>
<release>beta</release>
<api>beta</api>
</stability>
<license uri="http://matrix.squiz.net/developer/tools/php_cs/licence">BSD License</license>
<notes>
- Initial commit.
</notes>
<contents>
<dir name="/">
<file baseinstalldir="PHP/CodeSniffer/Standards/PHPCS" name="PHPCSCodingStandard.php" role="php">
<tasks:replace from="@package_version@" to="version" type="package-info" />
</file>
</dir>
</contents>
<dependencies>
<required>
<php>
<min>5.1.0</min>
</php>
<pearinstaller>
<min>1.4.0b1</min>
</pearinstaller>
<package>
<name>PHP_CodeSniffer</name>
<channel>pear.php.net</channel>
<min>0.6.0</min>
</package>
</required>
</dependencies>
<phprelease />
<changelog>
<release>
<version>
<release>0.1.0</release>
<api>0.1.0</api>
</version>
<stability>
<release>beta</release>
<api>beta</api>
</stability>
<date>2007-05-17</date>
<license uri="http://matrix.squiz.net/developer/tools/php_cs/licence">BSD License</license>
<notes>
- Initial commit.
</notes>
</release>
</changelog>
</package>