Skip to main content

Drupal Coding standard check

 Installing and checking Drupal coding standards using PHP CodeSniffer consists of the following steps at high level.

  1. Install PHP CodeSniffer
  2. Install Coder
  3. Register Drupal standards in PHP Codesniffer
  4. Run the sniffs
Installing PHP code sniffer : 

1- composer global require drupal/coder

You can check the location of the installation path by below command

composer global show -P

if you are in a windows machine then you need to update the below path in environment variable as a PATH key,

PATH : C:\Users\dharmendra.singh\AppData\Roaming\Composer\vendor\bin

and reopen the terminal to apply changes.

Install the below composer global require drupal/coder dealerdirect/phpcodesniffer-composer-installer And Manually set installed paths : phpcs --config-set installed_paths C:/Users/dharmendra.singh/AppData/Roaming/Composer/vendor/drupal/coder/coder_sniffer

Installation is Done You can verify this has worked or not phpcs -i The above command should include DrupalPractice and Drupal in the installed coding standards list.

Ref :

How to Run : 

PHP Code Standard with Drupal :
 
phpcs --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml batch_example

PHP Code Standard with Drupal Practice:

phpcs --standard=DrupalPractice --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml NonHcpRegistrationForm.php

PHP Code Beautify & Formate :

phpcbf --standard=Drupal --extensions=php,module,inc,install,test,profile,theme,css,info,txt,md,yml batch_example

Comments

Popular posts from this blog

How to span column of custom table in Drupal

If you want to span the column of custom drupal table like below image, Follow the below code to make the header of the table , <?php $header = array('S.N','District', array('data' => '<div class ="house">Household </div><br><span>Rural</span> <p>Urban</p>','colspan' => 2), array('data' => '<div class ="house">Members</div> <br><span>Rural</span> <p>Urban</p>','colspan' => 2), 'Duplicate/Failed Registration', array('data' => '<div class ="house">Pending De duplication </div><br><span>Rural</span> <p>Urban</p>','colspan' => 2), 'Non Un-organised Workers', 'SSID Generated', 'No. of Card Personlised', ); $rows[] = arra...

Drupal 8 : Link actions,Link menus,Link Tasks,Routings

Drupal 8 : Link actions,Link menus,Link Tasks,Routings Link actions Local actions have also been moved out of the hook_menu() system in Drupal 8 .Use actions to define local operations such as adding new items to an administrative list (menus, contact categories, etc). Local actions are defined in a YAML format, named after the module they are defined by. Such as menu_ui.links.action.yml for this example from menu_ui module: menu_ui.link_add:   route_name: menu_ui.link_add   title: 'Add link'   appears_on:     - menu_ui.menu_edit Here, menu_ui.link_add: It is the Unique name of the link action Most likely start with module name, route_name : Name of the route it means when click the link it redirect to this route, appears_on :  An array of route names for this action to be display on. Now how to know the Route name of any internal/external admin pages like below, By through the drupal console we achieve it, drupal debug:router...

Cache In Drupal

Drupal 8 core caching modules: The Internal Page Cache module: this caches pages for anonymous users in the database. Pages requested by anonymous users are stored the first time they are requested and then are reused for future visitors. The Internal Dynamic Page Cache module: This is a key feature that Drupal 7 did not have. Unlike the Internal Page module, the Dynamic Page module aims to speed up the site for both anonymous and logged-in users. How Cache Works in Drupal: There are two modules available in the drupal core 1 - Internal page cache: The Internal Page Cache module caches pages for anonymous users in the database. Pages requested by anonymous users are stored the first time they are requested and then are reused. Configuring the internal page cache :   From the performance page we can set the maximum time how long browsers and proxies may cache pages based on the Cache-Control header. 2 - Internal dynamic page cache: Drupal 8 provides the Dynamic Page Cache m...