{"id":55736,"date":"2022-11-08T18:10:10","date_gmt":"2022-11-08T12:40:10","guid":{"rendered":"https:\/\/2thenew.online\/blog\/?p=55736"},"modified":"2022-11-08T18:10:10","modified_gmt":"2022-11-08T12:40:10","slug":"check-drupal-coding-standard-by-phpcs-in-git-pre-commit-hook","status":"publish","type":"post","link":"https:\/\/2thenew.online\/blog\/check-drupal-coding-standard-by-phpcs-in-git-pre-commit-hook\/","title":{"rendered":"Check Drupal coding standard by phpcs in git pre-commit hook"},"content":{"rendered":"
\"Blog<\/span><\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n
<\/div>\n

In this tutorial, you will learn how to improve the custom code, theme and module, and general code development by using the pre-commit hook on git. Git pre-commit validates Drupal coding standards on files before committing them and returns a message to fix each line of code on the files having errors.<\/span><\/p>\n

\n

Follow the next steps to set up the pre-commit git hook with Drupal coding standards:<\/strong><\/h2>\n
    \n
  1. Create hooks directory on root project.<\/li>\n
  2. Create a pre-commit file in the hooks directory.<\/li>\n
  3. Add the below pre-commit code to the hooks\/pre-commit file.<\/li>\n<\/ol>\n
    \n
    #!\/bin\/bash\r\n\r\nSTANDARD=\"Drupal\"\r\nBIN=\".\/vendor\/bin\"\r\n\r\necho\r\necho \"Drupal Coder pre-commit hook \u2013 commit with the --no-verify option to skip the hook\"\r\necho\r\n\r\n# Check whether PHP_CodeSniffer can be found\r\nif [ ! -f \"$BIN\/phpcs\" ]\r\nthen\r\n  echo \"Drupal Coder not found \u2013 is it installed? 'composer require drupal\/coder'\"\r\n  echo\r\n  exit 1\r\nfi\r\n\r\n# Retrieve staged files\r\nFILES=$(git diff --cached --name-only --diff-filter=ACMR HEAD)\r\n\r\n# Run the sniffer\r\necho \"Running Drupal Coder.\"\r\necho\r\nPHPCS=(\"$BIN\/phpcs\" \"--standard=$STANDARD\" \"--filter=gitstaged\" \"--encoding=utf-8\" \"-p\" \".\")\r\n\"${PHPCS[@]}\"\r\n\r\n# Syntax Error\r\nif [ $? != 0 ]\r\nthen\r\n  echo \"Please fix each violations detected.\"\r\n  echo\r\n  exit 1\r\nfi\r\n\r\n# Syntax OK\r\nif [ $? == 0 ]\r\nthen\r\n  echo \"No violations detected\"\r\n  echo\r\n  exit 0\r\nfi<\/pre>\n<\/blockquote>\n
    Add PHP commands on the scripts section of the composer.json file.<\/strong><\/h2>\n
    \n
    \"scripts\": {\r\n\u00a0 \u00a0 \u00a0 \"post-install-cmd\": [\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"php -r \\\"copy('hooks\/pre-commit', '.git\/hooks\/pre-commit');\\\"\",\r\n\u00a0 \u00a0 \u00a0 \u00a0 \u00a0 \"php -r \\\"chmod('.git\/hooks\/pre-commit', 0755);\\\"\"\r\n\u00a0 \u00a0 \u00a0 ]\r\n}<\/pre>\n<\/blockquote>\n
    <\/div>\n
    Now execute Composer install<\/b>\u00a0in your project directory<\/div>\n<\/div>\n
    Composer install will mv hooks\/pre-commit file to .git\/hooks\/pre-commit.<\/div>\n
    <\/div>\n
    \n
    How to use it<\/h2>\n<\/div>\n
    \n
    git commit -m \"<\/span>The commit message.\"<\/span><\/span><\/pre>\n
    This is going to execute Drupal Coder on each file and returns messages on the terminal in case of finding errors on files.<\/p>\n
    <\/div>\n<\/div>\n
    <\/div>","protected":false},"excerpt":{"rendered":"
    In this tutorial, you will learn how to improve the custom code, theme and module, and general code development by using the pre-commit hook on git. Git pre-commit validates Drupal coding standards on files before committing them and returns a message to fix each line of code on the files having errors. Follow the next […]<\/p>\n","protected":false},"author":1368,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":81,"footnotes":""},"categories":[3602],"tags":[4862],"class_list":["post-55736","post","type-post","status-publish","format-standard","hentry","category-drupal","tag-drupal"],"aioseo_notices":[],"aioseo_head":"\n\t\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