Latest releases of php_codesniffer

PHP_CodeSniffer 1.5.0RC2

2013-04-04T01:37:27-05:00

- Ruleset processing has been rewritten to be more predictable
-- Provides much better support for relative paths inside ruleset files
-- May mean that sniffs that were previously ignored are now being included when importing external rulesets
-- Ruleset processing output can be seen by using the -vv command line argument
-- Internal sniff registering functions have all changed, so please review custom scripts
- You can now pass multiple coding standards on the command line, comma separated (request #19144)
-- Works with built-in or custom standards and rulesets, or a mix of both
- You can now exclude directories or whole standards in a ruleset XML file (request #19731)
-- e.g., exclude "Generic.Commenting" or just "Generic"
-- You can also pass in a path to a directory instead, if you know it
- Added Generic LowerCaseKeywordSniff to ensure all PHP keywords are defined in lowercase
-- The PSR2 and Squiz standards now use this sniff
- Added Generic SAPIUsageSniff to ensure the PHP_SAPI constant is used instead of php_sapi_name() (request #19863)
- Squiz FunctionSpacingSniff now has a setting to specify how many lines there should between functions (request #19843)
-- Default remains at 2
-- Override the "spacing" setting in a ruleset.xml file to change
- Squiz LowercasePHPFunctionSniff no longer throws errors for the limited set of PHP keywords it was checking
-- Add a rule for Generic.PHP.LowerCaseKeyword to your ruleset to replicate this functionality
- Added support for the PHP 5.4 T_CALLABLE token so it can be used in lower PHP versions
- Generic EndFileNoNewlineSniff now supports checking of CSS and JS files
- PSR2 SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented
-- Default remains at 4; override the indent setting in a ruleset.xml file to change
-- Thanks to Asher Snyder for the patch
- Generic ScopeIndentSniff now has a setting to specify a list of tokens that should be ignored
-- The first token on the line is checked and the whole line is ignored if the token is in the array
-- Thanks to Eloy Lafuente for the patch
- Squiz LowercaseClassKeywordsSniff now checks for the TRAIT keyword
-- Thanks to Anthon Pang for the patch
- If you create your own PHP_CodeSniffer object, PHPCS will no longer exit when an unknown argument is found
-- This allows you to create wrapper scripts for PHPCS more easily
- PSR2 MethodDeclarationSniff no longer generates a notice for methods named "_"
-- Thanks to Bart S for the patch
- Squiz BlockCommentSniff no longer reports that a blank line between a scope closer and block comment is invalid
- Generic DuplicateClassNameSniff no longer reports an invalid error if multiple PHP open tags exist in a file
- Generic DuplicateClassNameSniff no longer reports duplicate errors if multiple PHP open tags exist in a file
- Fixed bug #19819 : Freeze with syntax error in use statement
- Fixed bug #19820 : Wrong message level in Generic_Sniffs_CodeAnalysis_EmptyStatementSniff
- Fixed bug #19859 : CodeSniffer::setIgnorePatterns API changed
- Fixed bug #19871 : findExtendedClassName doesn't return FQCN on namespaced classes
- Fixed bug #19879 : bitwise and operator interpreted as reference by value

PHP_CodeSniffer 1.4.5

2013-04-04T01:36:22-05:00

- Added Generic LowerCaseKeywordSniff to ensure all PHP keywords are defined in lowercase
-- The PSR2 and Squiz standards now use this sniff
- Added Generic SAPIUsageSniff to ensure the PHP_SAPI constant is used instead of php_sapi_name() (request #19863)
- Squiz FunctionSpacingSniff now has a setting to specify how many lines there should between functions (request #19843)
-- Default remains at 2
-- Override the "spacing" setting in a ruleset.xml file to change
- Squiz LowercasePHPFunctionSniff no longer throws errors for the limited set of PHP keywords it was checking
-- Add a rule for Generic.PHP.LowerCaseKeyword to your ruleset to replicate this functionality
- Added support for the PHP 5.4 T_CALLABLE token so it can be used in lower PHP versions
- Generic EndFileNoNewlineSniff now supports checking of CSS and JS files
- PSR2 SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented
-- Default remains at 4; override the indent setting in a ruleset.xml file to change
-- Thanks to Asher Snyder for the patch
- Generic ScopeIndentSniff now has a setting to specify a list of tokens that should be ignored
-- The first token on the line is checked and the whole line is ignored if the token is in the array
-- Thanks to Eloy Lafuente for the patch
- Squiz LowercaseClassKeywordsSniff now checks for the TRAIT keyword
-- Thanks to Anthon Pang for the patch
- If you create your own PHP_CodeSniffer object, PHPCS will no longer exit when an unknown argument is found
-- This allows you to create wrapper scripts for PHPCS more easily
- PSR2 MethodDeclarationSniff no longer generates a notice for methods named "_"
-- Thanks to Bart S for the patch
- Squiz BlockCommentSniff no longer reports that a blank line between a scope closer and block comment is invalid
- Generic DuplicateClassNameSniff no longer reports an invalid error if multiple PHP open tags exist in a file
- Generic DuplicateClassNameSniff no longer reports duplicate errors if multiple PHP open tags exist in a file
- Fixed bug #19819 : Freeze with syntax error in use statement
- Fixed bug #19820 : Wrong message level in Generic_Sniffs_CodeAnalysis_EmptyStatementSniff
- Fixed bug #19859 : CodeSniffer::setIgnorePatterns API changed
- Fixed bug #19871 : findExtendedClassName doesn't return FQCN on namespaced classes
- Fixed bug #19879 : bitwise and operator interpreted as reference by value

PHP_CodeSniffer 1.5.0RC1

2013-02-08T03:22:13-05:00

- Reports have been completely rewritten to consume far less memory
-- Each report is incrementally written to the file system during a run and then printed out when the run ends
-- There is no longer a need to keep the list of errors and warnings in memory during a run
- Multi-file sniff support has been removed because they are too memory intensive
-- If you have a custom multi-file sniff, you can convert it into a standard sniff quite easily
-- See CodeSniffer/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php for an example

PHP_CodeSniffer 1.4.4

2013-02-06T23:16:27-05:00

- Ignored lines no longer cause the summary report to show incorrect error and warning counts
-- Thanks to Bert Van Hauwaert for the patch
- Added Generic CSSLintSniff to run CSSLint over a CSS file and report warnings
-- Set full command to run CSSLint using phpcs --config-set csslint_path /path/to/csslint
-- Thanks to Roman Levishchenko for the contribution
- Added PSR2 ControlStructureSpacingSniff to ensure there are no spaces before and after parenthesis in control structures
-- Fixes bug #19732 : PSR2: some control structures errors not reported
- Squiz commenting sniffs now support non-English characters when checking for capital letters
-- Thanks to Roman Levishchenko for the patch
- Generic EndFileNewlineSniff now supports JS and CSS files
-- Thanks to Denis Ryabkov for the patch
- PSR1 SideEffectsSniff no longer reports constant declarations as side effects
- Notifysend report now supports notify-send versions before 0.7.3
-- Thanks to Ken Guest for the patch
- PEAR and Squiz FunctionCommentSniffs no longer report errors for misaligned argument comments when they are blank
-- Thanks to Thomas Peterson for the patch
- Squiz FunctionDeclarationArgumentSpacingSniff now works correctly for equalsSpacing values greater than 0
-- Thanks to Klaus Purer for the patch
- Squiz SuperfluousWhitespaceSniff no longer throws errors for CSS files with no newline at the end
- Squiz SuperfluousWhitespaceSniff now allows a single newline at the end of JS and CSS files
- Fixed bug #19755 : Token of T_CLASS type has no scope_opener and scope_closer keys
- Fixed bug #19759 : Squiz.PHP.NonExecutableCode fails for return function()...
- Fixed bug #19763 : Use statements for traits not recognised correctly for PSR2 code style
- Fixed bug #19764 : Instead of for traits throws uppercase constant name errors
- Fixed bug #19772 : PSR2_Sniffs_Namespaces_UseDeclarationSniff does not properly recognize last use
- Fixed bug #19775 : False positive in NonExecutableCode sniff when not using curly braces
- Fixed bug #19782 : Invalid found size functions in loop when using object operator
- Fixed bug #19799 : config folder is not created automatically
- Fixed bug #19804 : JS Tokenizer wrong /**/ parsing

PHP_CodeSniffer 1.4.3

2012-12-04T03:17:09-05:00

- Added support for the PHP 5.5 T_FINALLY token to detect try/catch/finally statements
- Added empty CodeSniffer.conf to enable config settings for Composer installs
- Added Generic EndFileNoNewlineSniff to ensure there is no newline at the end of a file
- Autoloader can now load PSR-0 compliant classes
-- Thanks to Maik Penz for the patch
- Squiz NonExecutableCodeSniff no longer throws error for multi-line RETURNs inside CASE statements
-- Thanks to Marc Ypes for the patch
- Squiz OperatorSpacingSniff no longer reports errors for negative numbers inside inline THEN statements
-- Thanks to Klaus Purer for the patch
- Squiz OperatorSpacingSniff no longer reports errors for the assignment of operations involving negative numbers
- Squiz SelfMemberReferenceSniff can no longer get into an infinite loop when checking a static call with a namespace
-- Thanks to Andy Grunwald for the patch
- Fixed bug #19699 : Generic.Files.LineLength giving false positives when tab-width is used
- Fixed bug #19726 : Wrong number of spaces expected after instanceof static
- Fixed bug #19727 : PSR2: no error reported when using } elseif {

PHP_CodeSniffer 1.4.2

2012-11-09T02:40:00-05:00

- PHP_CodeSniffer can now be installed using Composer
-- Require squizlabs/php_codesniffer in your composer.json file
-- Thanks to Rob Bast, Stephen Rees-Carter, Stefano Kowalke and Ivan Habunek for help with this
- Squiz BlockCommentSniff and InlineCommentSniff no longer report errors for trait block comments
- Squiz SelfMemberReferenceSniff now supports namespaces
-- Thanks to Andy Grunwald for the patch
- Squiz FileCommentSniff now uses tag names inside the error codes for many messages
-- This allows you to exclude specific missing, out of order etc., tags
- Squiz SuperfluousWhitespaceSniff now has an option to ignore blank lines
-- This will stop errors being reported for lines that contain only whitespace
-- Set the ignoreBlankLines property to TRUE in your ruleset.xml file to enable this
- PSR2 no longer reports errors for whitespace at the end of blank lines
- Fixed gitblame report not working on Windows
-- Thanks to Rogerio Prado de Jesus
- Fixed an incorrect error in Squiz OperatorSpacingSniff for default values inside a closure definition
- Fixed bug #19691 : SubversionPropertiesSniff fails to find missing properties
-- Thanks to Kevin Winahradsky for the patch
- Fixed bug #19692 : DisallowMultipleAssignments is triggered by a closure
- Fixed bug #19693 : exclude-patterns no longer work on specific messages
- Fixed bug #19694 : Squiz.PHP.LowercasePHPFunctions incorrectly matches return by ref functions

PHP_CodeSniffer 1.4.1

2012-11-01T23:29:39-05:00

- All ignore patterns have been reverted to being checked against the absolute path of a file
-- Patterns can be specified to be relative in a rulset.xml file, but nowhere else
-- e.g., [exclude-pattern type="relative"]^tests/*[/exclude-pattern] (with angle brackets, not square brackets)
- Added support for PHP tokenizing of T_INLINE_ELSE colons, so this token type is now available
-- Custom sniffs that rely on looking for T_COLON tokens inside inline if statements must be changed to use the new token
-- Fixes bug #19666 : PSR1.Files.SideEffects throws a notice Undefined index: scope_closer
- Messages can now be changed from errors to warnings (and vice versa) inside ruleset.xml files
-- As you would with "message" and "severity", specify a "type" tag under a "rule" tag and set the value to "error" or "warning"
- PHP_CodeSniffer will now generate a warning on files that it detects have mixed line endings
-- This warning has the code Internal.LineEndings.Mixed and can be overriden in a ruleset.xml file
-- Thanks to Vit Brunner for help with this
- Sniffs inside PHP 5.3 namespaces are now supported, along with the existing underscore-style emulated namespaces
-- For example: namespace MyStandard\Sniffs\Arrays; class ArrayDeclarationSniff implements \PHP_CodeSniffer_Sniff { ...
-- Thanks to Till Klampaeckel for the patch
- Generic DuplicateClassNameSniff is no longer a multi-file sniff, so it won't max out your memory
-- Multi-file sniff support should be considered deprecated as standard sniffs can now do the same thing
- Added Generic DisallowSpaceIndent to check that files are indented using tabs
- Added Generic OneClassPerFileSniff to check that only one class is defined in each file
-- Thanks to Andy Grunwald for the contribution
- Added Generic OneInterfacePerFileSniff to check that only one interface is defined in each file
-- Thanks to Andy Grunwald for the contribution
- Added Generic LowercasedFilenameSniff to check that filenames are lowercase
-- Thanks to Andy Grunwald for the contribution
- Added Generic ClosingPHPTagSniff to check that each open PHP tag has a corresponding close tag
-- Thanks to Andy Grunwald for the contribution
- Added Generic CharacterBeforePHPOpeningTagSniff to check that the open PHP tag is the first content in a file
-- Thanks to Andy Grunwald for the contribution
- Fixed incorrect errors in Squiz OperatorBracketSniff and OperatorSpacingSniff for negative numbers in CASE statements
-- Thanks to Arnout Boks for the patch
- Generic CamelCapsFunctionNameSniff no longer enforces exact case matching for PHP magic methods
- Generic CamelCapsFunctionNameSniff no longer throws errors for overridden SOAPClient methods prefixed with double underscores
-- Thanks to Dorian Villet for the patch
- PEAR ValidFunctionNameSniff now supports traits
- PSR1 ClassDeclarationSniff no longer throws an error for non-namespaced code if PHP version is less than 5.3.0
- Fixed bug #19616 : Nested switches cause false error in PSR2
- Fixed bug #19629 : PSR2 error for inline comments on multi-line argument lists
- Fixed bug #19644 : Alternative syntax, e.g. if/endif triggers Inline Control Structure error
- Fixed bug #19655 : Closures reporting as multi-line when they are not
- Fixed bug #19675 : Improper indent of nested anonymous function bodies in a call
- Fixed bug #19685 : PSR2 catch-22 with empty third statement in for loop
- Fixed bug #19687 : Anonymous functions inside arrays marked as indented incorrectly in PSR2

PHP_CodeSniffer 1.4.0

2012-09-26T05:18:51-05:00

- Added PSR1 and PSR2 coding standards that can be used to check your code against these guidelines
- PHP 5.4 short array syntax is now detected and tokens are assigned to the open and close characters
-- New tokens are T_OPEN_SHORT_ARRAY and T_CLOSE_SHORT_ARRAY as PHP does not define its own
- Added the ability to explain a coding standard by listing the sniffs that it includes
-- The sniff list includes all imported and native sniffs
-- Explain a standard by using the -e and --standard=[standard] command line arguments
-- E.g., phpcs -e --standard=Squiz
-- Thanks to Ben Selby for the idea
- Added report to show results using notify-send
-- Use --report=notifysend to generate the report
-- Thanks to Christian Weiske for the contribution
- The JS tokenizer now recognises RETURN as a valid closer for CASE and DEFAULT inside switch statements
- AbstractPatternSniff now sets the ignoreComments option using a public var rather than through the constructor
-- This allows the setting to be overwritten in ruleset.xml files
-- Old method remains for backwards compatibility
- Generic LowerCaseConstantSniff and UpperCaseConstantSniff no longer report errors on classes named True, False or Null
- PEAR ValidFunctionNameSniff no longer enforces exact case matching for PHP magic methods
- Squiz SwitchDeclarationSniff now allows RETURN statements to close a CASE or DEFAULT statement
- Squiz BlockCommentSniff now correctly reports an error for blank lines before blocks at the start of a control structure
- Fixed a PHP notice generated when loading custom array settings from a rulset.xml file
- Fixed bug #17908 : CodeSniffer does not recognise optional @params
-- Thanks to Pete Walker for the patch
- Fixed bug #19538 : Function indentation code sniffer checks inside short arrays
- Fixed bug #19565 : Non-Executable Code Sniff Broken for Case Statements with both return and break
- Fixed bug #19612 : Invalid @package suggestion

PHP_CodeSniffer 1.3.6

2012-08-08T03:05:01-05:00

- Memory usage has been dramatically reduced when using the summary report
-- Reduced memory is only available when displaying a single summary report to the screen
-- PHP_CodeSniffer will not generate any messages in this case, storing only error counts instead
-- Impact is most notable with very high error and warning counts
- Significantly improved the performance of Squiz NonExecutableCodeSniff
- Ignore patterns now check the relative path of a file based on the dir being checked
-- Allows ignore patterns to become more generic as the path to the code is no longer included when checking
-- Thanks to Kristof Coomans for the patch
- Sniff settings can now be changed by specifying a special comment format inside a file
-- e.g., // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature allowMultipleArguments false
-- If you change a setting, don't forget to change it back
- Added Generic EndFileNewlineSniff to ensure PHP files end with a newline character
- PEAR FunctionCallSignatureSniff now includes a setting to force one argument per line in multi-line calls
-- Set allowMultipleArguments to false
- Squiz standard now enforces one argument per line in multi-line function calls
- Squiz FunctionDeclarationArgumentSpacingSniff now supports closures
- Squiz OperatorSpacingSniff no longer throws an error for negative values inside an inline THEN statement
-- Thanks to Klaus Purer for the patch
- Squiz FunctionCommentSniff now throws an error for not closing a comment with */
-- Thanks to Klaus Purer for the patch
- Summary report no longer shows two lines of PHP_Timer output when showing sources
- Fixed undefined variable error in PEAR FunctionCallSignatureSniff for lines with no indent
- Fixed bug #19502 : Generic.Files.LineEndingsSniff fails if no new-lines in file
- Fixed bug #19508 : switch+return: Closing brace indented incorrectly
- Fixed bug #19532 : The PSR-2 standard don't recognize Null in class names
- Fixed bug #19546 : Error thrown for __call() method in traits

PHP_CodeSniffer 1.3.5

2012-07-12T07:26:06-05:00

- Added Generic CamelCapsFunctionNameSniff to just check if function and method names use camel caps
-- Does not allow underscore prefixes for private/protected methods
-- Defaults to strict checking, where two uppercase characters can not be next to each other
-- Strict checking can be disabled in a ruleset.xml file
- Squiz FunctionDeclarationArgumentSpacing now has a setting to specify how many spaces should surround equals signs
-- Default remains at 0
-- Override the equalsSpacing setting in a ruleset.xml file to change
- Squiz ClassDeclarationSniff now throws errors for > 1 space before extends/implements class name with ns seperator
- Squiz standard now warns about deprecated functions using Generic DeprecatedFunctionsSniff
- PEAR FunctionDeclarationSniff now reports an error for multiple spaces after the FUNCTION keyword and around USE
- PEAR FunctionDeclarationSniff now supports closures
- Squiz MultiLineFunctionDeclarationSniff now supports closures
- Exclude rules written for Unix systems will now work correctly on Windows
-- Thanks to Walter Tamboer for the patch
- The PHP tokenizer now recognises T_RETURN as a valid closer for T_CASE and T_DEFAULT inside switch statements
- Fixed duplicate message codes in Generic OpeningFunctionBraceKernighanRitchieSniff
- Fixed bug #18651 : PHPunit Test cases for custom standards are not working on Windows
- Fixed bug #19416 : Shorthand arrays cause bracket spacing errors
- Fixed bug #19421 : phpcs doesn't recognize ${x} as equivalent to $x
- Fixed bug #19428 : PHPCS Report "hgblame" doesn't support windows paths
-- Thanks to Justin Rovang for the patch
- Fixed bug #19448 : Problem with detecting remote standards
- Fixed bug #19463 : Anonymous functions incorrectly being flagged by NonExecutableCodeSniff
- Fixed bug #19469 : PHP_CodeSniffer_File::getMemberProperties() sets wrong scope
- Fixed bug #19471 : phpcs on Windows, when using Zend standard, doesn't catch problems
-- Thanks to Ivan Habunek for the patch
- Fixed bug #19478 : Incorrect indent detection in PEAR standard
-- Thanks to Shane Auckland for the patch
- Fixed bug #19483 : Blame Reports fail with space in directory name