开源项目教程：bamarni/composer-bin-plugin

开源项目教程：bamarni/composer-bin-plugin

composer-bin-pluginNo conflicts for your bin dependencies项目地址:https://gitcode.com/gh_mirrors/co/composer-bin-plugin

项目介绍

bamarni/composer-bin-plugin 是一个Composer插件，它旨在简化PHP项目中“二进制依赖”的管理。该插件允许你将特定的二进制工具（如php-cs-fixer）安装在vendor-bin目录下，并能够通过 Composer 管理这些工具的版本更新，而不直接干扰到主项目的依赖关系。这有助于保持项目结构整洁，同时便于对开发工具进行独立的版本控制。

项目快速启动

要开始使用 bamarni/composer-bin-plugin，首先确保你的环境中已安装了Composer。然后，按照以下步骤集成该插件：

1. 添加插件到项目

   在你的项目的根目录下的composer.json文件中，加入该插件作为开发依赖：

   {
       "require-dev": {
           "bamarni/composer-bin-plugin": "^1.2"
       }
   }
   

2. 配置插件

   随后，在composer.json的extra部分配置插件，你可以自定义如是否创建软链(bin-links)，目标目录(target-directory)，以及是否自动前向命令(forward-command)到所有bin目录：

   "extra": {
       "bamarni-bin": {
           "bin-links": false,
           "target-directory": "vendor-bin",
           "forward-command": true
       }
   }
   

3. 安装插件及依赖

   运行以下命令以安装插件及其配置：

   composer install --dev
   

4. 安装和管理二进制工具

   例如，要安装php-cs-fixer，你只需在命令行执行：

   composer require --dev friendsofphp/php-cs-fixer
   

   完成以上步骤后，二进制工具会被置于指定的vendor-bin目录，并可通过Composer轻松升级或管理。

应用案例和最佳实践

自动安装脚本

为了在每次Composer安装时自动处理bin依赖的安装，可以在composer.json中的scripts添加如下：

{
    "scripts": {
        "post-install-cmd": [
            "@composer bin php-cs-fixer install --ansi"
        ]
    }
}

这样，每当项目被部署或有人克隆并运行composer install时，都会自动安装php-cs-fixer。

Git忽略与版本控制

为了避免vendor-bin内的工具更新引起不必要的Git提交混乱，推荐在.gitignore中添加相关规则忽略它们的内部依赖：

# .gitignore
vendor-bin/**/vendor/

并在.gitattributes中设置不显示composer.lock的差异，以减少噪音：

# .gitattributes
vendor-bin/**/composer.lock binary

典型生态项目

虽然bamarni/composer-bin-plugin本身是个辅助工具，但它广泛应用于PHP社区的工具链中，尤其是那些需要单独管理版本的开发者工具，比如PHP编码标准修复器(PHP CS Fixer)，PHPUnit等。它与其他生态项目如theofidry/composer-inheritance-plugin协作，共同优化了Composer管理多个子composer.json文件的能力，使得开发环境的配置更加灵活且易于维护。

记住，正确配置和利用此类插件，可以极大地提升开发效率和项目可维护性，尤其是在多工具协同工作的复杂环境中。

composer-bin-pluginNo conflicts for your bin dependencies项目地址:https://gitcode.com/gh_mirrors/co/composer-bin-plugin