木质素/作曲家发现

为发现包内的项目提供Composer插件。

安装: 5

依赖者: 1

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:composer-plugin

dev-master 2022-06-30 05:52 UTC

This package is auto-updated.

Last update: 2024-08-29 06:07:32 UTC


README

为Composer提供执行发现过程的方法。

安装

推荐安装此库的方式是通过Composer

composer require xylemical/composer-discovery

用法

一旦在包中定义了发现过程,任何需要该包的包或项目都会应用发现过程。

添加发现过程就像在composer.json文件的extra键中定义发现类一样简单

{
  "extra": {
    "discovery": [
      "My\\Discovery"
    ]
  }
}

以下是一个示例发现,它会打印出所有包的README文件:

namespace My;

use Xylemical\Composer\Discovery\ComposerDiscoveryBase;

/**
 * Performs output of README.md for any package that defines it.
 */
class Discovery extends ComposerDiscoveryBase {

  /**
   * {@inheritdoc}
   */
  public function getName(): string {
    return 'My Discovery';
  }

  /**
   * {@inheritdoc}
   */
  public function discover(Package $package): void {
    $path = $package->getPath() . '/README.md';
    if (file_exists($path)) {
      $this->io->write(file_get_contents($path));
    }
  }

}

许可证

MIT,见LICENSE。