How to use the command composer-require-checker (with examples)

The composer-require-checker command is a tool used to analyze Composer dependencies for soft dependencies. It helps identify discrepancies in the composer.json file and provides a report on missing dependencies or potential issues. This article will illustrate two main use cases for the composer-require-checker command.

Use case 1: Analyze a Composer JSON file

Code:

composer-require-checker check path/to/composer.json

Motivation:

When working on a project with multiple dependencies managed by Composer, it is essential to ensure that all required packages are correctly defined in the composer.json file. By analyzing the composer.json file using composer-require-checker, any unresolved dependencies or issues with soft dependencies can be identified early on, allowing for easier debugging and preventing potential runtime errors.

Explanation:

• composer-require-checker: The main command for running the Composer Require Checker.
• check: Subcommand used to analyze Composer dependencies.
• path/to/composer.json: The path to the composer.json file that needs to be analyzed.

Example output:

Soft Dependencies:
-----------------
The following packages seem not to be required by this project, but are still listed as suggestions. Consider removing them from the composer.json file:

 - phpunit/php-invoker suggests asm89/monolog-bridge instead.
 - phpspec/prophecy suggests monolog/monolog as its logger.

Use case 2: Analyze a Composer JSON file with a specific configuration

Code:

composer-require-checker check --config-file path/to/config.json path/to/composer.json

Motivation:

In some scenarios, it can be useful to provide a specific configuration file to composer-require-checker in order to customize the analysis process. This is beneficial when wanting to ignore certain packages or define additional rules. By using a configuration file, the analysis can be fine-tuned to match specific project requirements.

Explanation:

• composer-require-checker: The main command for running the Composer Require Checker.
• check: Subcommand used to analyze Composer dependencies.
• --config-file path/to/config.json: Specifies the path to the configuration file to be used.
• path/to/composer.json: The path to the composer.json file that needs to be analyzed.

Example output:

Soft Dependencies:
-----------------
The following packages seem not to be required by this project, but are still listed as suggestions. Consider removing them from the composer.json file:

 - phpunit/php-invoker suggests asm89/monolog-bridge instead.
 - phpspec/prophecy suggests monolog/monolog as its logger.

Missing Dependencies:
---------------------
These dependencies seem to be required but are missing from the composer.json file. Consider adding them to your project dependencies:

 - psr/log (should be required as monolog/monolog's v2 and v3 versions depend on it)

New Undefined Functions:
------------------------
The following references to undefined functions were found in your code. Consider adding the necessary dependencies to your composer.json file:

 - log($message)
 - bar\baz\qux()

Conclusion:

The composer-require-checker command is a powerful tool for analyzing Composer dependencies, helping developers identify potential issues with soft dependencies and ensuring that all required packages are correctly defined. By regularly running this command, project maintainers can maintain a healthy and error-free dependency management system.