Enable development tools in PHPStorm

Last updated:
Edit on GitHub

This document describes how to enable and use development tools, like PHPStan or Code sniffer, directly in PHPStorm’s External Tools panel. These tools are available at both module and project levels and can be executed from the context menu within the project directory tree.

The following tools are supported and can be used for module folders:

  • console code:sniff:style -f: applies coding style fixes.
  • console code:phpstan: runs static analysis.
  • console code:sniff:architecture: detects architecture rule violations.

spryker-tools-in-phpstorm

Prerequisites

To be able to run commands in PHPStorm, install awk.

The installation script supports only MacOS.

Intall the Development module and add PHPStorm configuration

  1. Install the spryker/development@^3.39.0 module.
  2. In terminal, go to the root project directory.
  3. Depending on your project configuration, configure development tools by running one of the following commands:
  • Configure tools to run in Docker SDK containers:
vendor/bin/phpstorm-command-line-tools.sh
  • Configure tools tools to run on your local machine:
vendor/bin/phpstorm-command-line-tools.sh --platform=local
  1. To apply the changes, restart PhpStorm.

This adds or updates the XML configuration of PHPStorm related to Spryker, without changing any other settings.

After updating the spryker/development module, we recommend rerunning the installation command to make sure the latest configurations and updates are applied.