Download the PHP package metadrop/composer-comments without Composer

On this page you can find all versions of the php package metadrop/composer-comments. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package composer-comments

Composer Comments Plugin

This Composer plugins allows to add comments on Composer packages in the composer.json file. Those comments are displayed when the package is installed, updated or removed. Also, a comments command is provided to check if there are any comments.

Install

Just add the plugin to your Composer project:

Limitations

The comments are not displayed when using --dry-run because the packages are not actually being installed, removed or updated. This is due how Composer emits events: Composer does not emit update/intall/remove event so this plugin can't display the comments associated to a package.

Local development

CLone this repository and start hacking!

However, you will need to run it and test it. For this, can add the following code to the composer.json file on another directory where you want to run and test this composer plugin:

/path/to/composer-comments should be a folder where you have cloned this repository.

Adding comments

Add commments in your composer.json using the extra property:

Packages that have comments don't need to be required. In other words, you can add comments for packages that are not present in your project.

Displaying comments

To display all comments run:

To display comments for a given package:

What for?

Sometimes packages are required and later it is not clear why. Or maybe certain package release is requried or you know that certain package should not be used. Using this plugin you can add that information directly to the composer.json file, increasing the chances a developer sees the message when they are dealing with packages avoiding issues in the future.

It is recommended to add only information that is not obvious from the composer.json.

For example:

Please, don't do this:

All versions of composer-comments with dependencies

PHP Build Version
Package Version
Requires php Version >=8.0
composer-plugin-api Version ^2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package metadrop/composer-comments contains the following files

Loading the files please wait ....