Forrest logo
back to the drupal-check tool

drupal-check:tldr:b1fd7

drupal-check: Check the code in a specific directory for deprecations.
$ drupal-check ${path-to-directory}
try on your machine

The command "drupal-check ${path-to-directory}" is used to run the drupal-check tool on a specific directory or folder in Drupal. Here's the breakdown:

  • "drupal-check" is the command used to execute the drupal-check tool. It is a command-line tool that helps identify Drupal coding standards and coding issues in custom modules, themes, and profiles.

  • "${path-to-directory}" is a placeholder that you need to replace with the actual path to the directory or folder you want to run the drupal-check tool on. The path should be the absolute path (e.g., /var/www/html/sites/all/modules/custom) or relative to the current working directory. For example, if you want to check a module located in the "sites/all/modules/custom" directory, you would replace "${path-to-directory}" with "sites/all/modules/custom".

When you execute the command with the specific directory path, the drupal-check tool will scan the PHP code files within that directory and its subdirectories to identify any coding standards and issues specific to Drupal. It will provide a report of the findings, which can help you ensure your code is following best practices and guidelines.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the drupal-check tool