[ANNOUNCEMENT] PHP_CodeSniffer-2.0.0a1 (alpha) Released.
[email protected] ("PEAR Announce")
| Newsgroups | php.pear.general |
|---|---|
| Message-ID | <[email protected]> |
The new PEAR package PHP_CodeSniffer-2.0.0a1 (alpha) has been released at http://pear.php.net/.
Release notes
-------------
- Added the phpcbf script to automatically fix many errors found by the phpcs script
- Added report type --report=diff to show suggested changes to fix coding standard violations
- The --report argument now allows for custom reports to be used
-- Use the full path to your custom report class as the report name
- The --extensions argument is now respected when passing filenames; not just with directories
- The --extensions argument now allows you to specify the tokenizer for each extension
-- e.g., --extensions=module/php,es/js
- Command line arguments can now be set in ruleset files
-- e.g., arg name="report" value="summary" (print summary report; same as --report=summary)
-- e.g., arg value="sp" (print source and progress information; same as -sp)
-- The -vvv, --sniffs, --standard and -l command line arguments cannot be set in this way
- Sniff process() methods can not optionally return a token to ignore up to
-- If returned, the sniff will not be executed again until the passed token is reached in the file
-- Useful if you are looking for tokens like T_OPEN_TAG but only want to process the first one
- Removed the comment parser classes and replaced it with a simple comment tokenier
-- T_DOC_COMMENT tokens are now tokenized into T_DOC_COMMENT_* tokens so they can be used more easily
-- This change requires a significant rewrite of sniffs that use the comment parser
-- This change requires minor changes to sniffs that listen for T_DOC_COMMENT tokens directly
- Added Generic DocCommentSniff to check generic doc block formatting
-- Removed doc block formatting checks from PEAR ClassCommentSniff
-- Removed doc block formatting checks from PEAR FileCommentSniff
-- Removed doc block formatting checks from PEAR FunctionCommentSniff
-- Removed doc block formatting checks from Squiz ClassCommentSniff
-- Removed doc block formatting checks from Squiz FileCommentSniff
-- Removed doc block formatting checks from Squiz FunctionCommentSniff
-- Removed doc block formatting checks from Squiz VariableCommentSniff
- Squiz DocCommentAlignmentSniff has had its error codes changed
-- NoSpaceBeforeTag becomes NoSpaceAfterStar
-- SpaceBeforeTag becomes SpaceAfterStar
-- SpaceBeforeAsterisk becomes SpaceBeforeStar
- Generic MultipleStatementAlignment now aligns assignments within a block so they fit within their max padding setting
-- The sniff previously requested the padding as 1 space if max padding was exceeded
-- It now aligns the assignment with surrounding assignments if it can
-- Removed property ignoreMultiline as multi-line assignments are now handled correctly and should not be ignored
- Squiz FunctionClosingBraceSpaceSniff now requires a blank line before the brace in all cases except function args
- Added error Squiz.Commenting.ClassComment.SpacingAfter to ensure there are no blank lines after a class comment
- Added error Squiz.WhiteSpace.MemberVarSpacing.AfterComment to ensure there are no blank lines after a member var comment
-- Fixes have also been corrected to not strip the member var comment or indent under some circumstances
-- Thanks to Mark Scherer for help with this fix
- Added error Squiz.Commenting.FunctionCommentThrowTag.Missing to ensure a throw is documented
- Removed error Squiz.Commenting.FunctionCommentThrowTag.WrongType
- Content passed via STDIN can now specify the filename to use so that sniffs can run the correct filename checks
-- Ensure the first line of the content is: phpcs_input_file: /path/to/file
- Squiz coding standard now enforces no closing PHP tag at the end of a pure PHP file
- Squiz coding standard now enforces a single newline character at the end of the file
- Squiz ClassDeclarationSniff no longer checks for a PHP ending tag after a class definition
- Squiz ControlStructureSpacingSniff now checks TRY and CATCH statements as well
- Removed MySource ChannelExceptionSniff
Package Info
------------
PHP_CodeSniffer is a PHP5 script that tokenises PHP, JavaScript and CSS files to detect violations of a defined coding standard. It is an essential development tool that ensures your code remains clean and consistent. It can also help prevent some common semantic errors made by developers.
Related Links
-------------
Package home: http://pear.php.net/package/PHP_CodeSniffer
Changelog: http://pear.php.net/package/PHP_CodeSniffer/download/2.0.0a1
Download: http://download.pear.php.net/package/PHP_CodeSniffer-2.0.0a1.tgz
Authors
-------
Greg Sherwood (lead)