{"id":44434,"date":"2019-11-23T11:29:25","date_gmt":"2019-11-23T09:29:25","guid":{"rendered":"https:\/\/mamchenkov.net\/wordpress\/?p=44434"},"modified":"2019-11-23T11:29:28","modified_gmt":"2019-11-23T09:29:28","slug":"php-codesniffer-ignoring-rules","status":"publish","type":"post","link":"https:\/\/mamchenkov.net\/wordpress\/2019\/11\/23\/php-codesniffer-ignoring-rules\/","title":{"rendered":"PHP CodeSniffer: Ignoring rules"},"content":{"rendered":"\n\n

PHP CodeSniffer<\/a> is a great tool for making sure all your code is consistent with a set of rules and guidelines. However, there are cases, when you need to ignore the rules for a particular code snippet. For example, when you are working with third-party frameworks or libraries.<\/p>\n\n\n\n

CodeSniffer provides a number of ways to do this. Until today, the following worked well for me:<\/p>\n\n\n

\n\/\/ @CodingStandardsIgnoreStart\necho "Here goes some code that breaks the rules";\n\/\/ @CodingStandardsIgnoreEnd\n<\/pre><\/div>\n\n\n
This is particularly useful for code within functions and methods.  But what if you need to ignore a particular rule for the whole file, especially in places like method names, which are difficult to surround by starting and ending annotation tags?<\/p>\n\n\n\n
Here’s an example that worked for me (thanks to this comment<\/a> for the solution):<\/p>\n\n\n
\n<?php\n\/**\n * @phpcs:disable CakePHP.NamingConventions.ValidFunctionName.PublicWithUnderscore\n *\/\n<\/pre><\/div>\n\n\n
The only bit that you’d probably need now is an easy way to find the name of the rule from the CodeSniffer output.  The usual output of “.\/vendor\/bin\/phpcs<\/em>” looks like so:<\/p>\n\n\n
\nFILE: src\/Model\/Table\/KeysTable.php\n-----------------------------------------------------------------------------------------------------\nFOUND 1 ERROR AFFECTING 1 LINE\n-----------------------------------------------------------------------------------------------------\n 53 | ERROR | Public method name "KeysTable::_initializeSchema" must not be prefixed with underscore\n-----------------------------------------------------------------------------------------------------\n\n<\/pre><\/div>\n\n\n
But if you run it with the “-s” flag (thanks to this comment<\/a>), CodeSniffer will add sniff codes to all reports.  Here’s the same example with “.\/vendor\/bin\/phpcs -s<\/em>“:<\/p>\n\n\n
\nFILE: src\/Model\/Table\/KeysTable.php\n------------------------------------------------------------------------------------------------------------------------------------------------------------------------\nFOUND 1 ERROR AFFECTING 1 LINE\n------------------------------------------------------------------------------------------------------------------------------------------------------------------------\n 53 | ERROR | Public method name "KeysTable::_initializeSchema" must not be prefixed with underscore\n    |       | (CakePHP.NamingConventions.ValidFunctionName.PublicWithUnderscore)\n------------------------------------------------------------------------------------------------------------------------------------------------------------------------\n\n<\/pre><\/div>\n\n\n
And that’s the code sniff rule that you can add to the ignore annotation tag at the top of your file, like I’ve shown above.<\/p>\n\n","protected":false},"excerpt":{"rendered":"\n
PHP CodeSniffer is a great tool for making sure all your code is consistent with a set of rules and guidelines. However, there are cases, when you need to ignore the rules for a particular code snippet. For example, when you are working with third-party frameworks or libraries. CodeSniffer provides a number of ways to … Continue reading PHP CodeSniffer: Ignoring rules<\/span><\/a><\/p>\n\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"PHP CodeSniffer: Ignoring rules #WebDev #PHP #CakePHP #QA #CodingStyle #BestPractices","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":true,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false,"_links_to":"","_links_to_target":""},"categories":[1,18,62],"tags":[3069,1537,2243,3063,38,3074,1330],"keyring_services":[],"class_list":["post-44434","post","type-post","status-publish","format-standard","hentry","category-general","category-programming","category-technology","tag-best-practices","tag-cakephp","tag-coding-style","tag-frameworks","tag-php","tag-quality-assurance","tag-web-development"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t