README

此Composer插件允许在composer.json文件中添加Composer包的注释。这些注释在安装、更新或删除包时显示。此外，还提供了一个comments命令来检查是否有任何注释。

安装

只需将插件添加到您的Composer项目中

composer require metadrop/composer-comments

限制

使用--dry-run时不会显示注释，因为实际上并没有安装、删除或更新包。这是由于Composer如何发出事件：Composer不发出更新/安装/删除事件，因此此插件无法显示与包关联的注释。

本地开发

将此存储库克隆并开始编写代码！

但是，您需要运行它并进行测试。为此，可以在另一个目录中的composer.json文件中添加以下代码，以运行和测试此Composer插件：

  "repositories": [
    {
      "type": "path",
      "url": "/path/to/composer-comments"
    }

/path/to/composer-comments应为您克隆此存储库的文件夹。

添加注释

使用extra属性在composer.json中添加注释

  "extra": {
    "package-comments": {
      "vendor/package1": "A comment about package1",
      "vendor/package2": "A comment about package2",
      "vendor/package3": "A comment about package3",
    }
  }

具有注释的包不需要被要求。换句话说，您可以添加注释给那些不在您的项目中出现的包。

显示注释

要显示所有注释，请运行

composer comments

要显示特定包的注释

composer comments vendor/package

为什么

有时包是必需的，但后来不清楚为什么。或者可能需要某个特定版本的包，或者您知道某些包不应该使用。使用此插件，您可以直接在composer.json文件中添加这些信息，增加开发者在处理包时看到这些信息的机会，避免未来的问题。

建议只添加composer.json中不明显的信息。

例如

  "extra": {
    "package-comments": {
      "vendor/bogus_package": "This package was tested but the peformance was not good enough and was discarded",
      "vendor/bogus_release": "On certain installations this package triggered a mysterious error. We decided to stick to releaase 1.2.3 because the bug as not present there until we found the root cause.",
      "vendor/good_package": "This package is used to provide X functionality"
    }
  }

请不要这样做

  "extra": {
    "package-comments": {
      "vendor_x/package": "This package is provided by Vendor X",
      "vendor/fancy_package": "This is the fancy package",
      "vendor/package": "Using version 1.2.3"
    }
  }