phar-io / composer-distributor
用于安装PHAR文件的Composer插件的基代码
1.0.2
2023-05-31 17:05 UTC
Requires
- php: ^7.3 || ^8.0
- composer-plugin-api: ^1.1 || ^2.0
- ext-dom: *
- ext-libxml: *
- phar-io/filesystem: ^2.0
- phar-io/gnupg: ^1.0
Requires (Dev)
- composer/composer: ^2.0
- phpunit/phpunit: ^9.4
README
如果您有一个像二进制文件一样的工具,希望将其作为PHAR文件分发而不是源代码,但又不想放弃通过Composer安装工具的便利性,则可以使用此库创建一个Composer插件,它可以在极短的时间内处理这些问题。
动机
像PHPUnit、PHPStan、Psalm这样的工具最好以PHAR的形式安装,以避免您的开发工具和您的源代码之间的版本冲突。但由于许多开发人员只想使用Composer来安装所有工具,因此创建了此项目,以简化通过Composer部署PHAR文件。
创建自己的
要创建一个安装您的PHAR文件的Composer插件,请遵循以下3个步骤。
步骤1 - 创建您的Composer插件
最简单的方法是运行以下命令并遵循说明。
composer create-project phar-io/mediator /path/to/your/directory/
这将创建指定的目录中的插件。请确保您的distibutor.xml
配置文件中的信息正确。
<?xml version="1.0" encoding="UTF-8"?> <distributor xmlns="https://phar.io/composer-distributor" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://phar.io/xml/distributor/1.0/schema.xsd" packageName="yournamespace/pluginname" keyDirectory="keys"> <phar name="pharname" file="https://github.com/yournamespace/pluginname/releases/download/{{version}}/pharname.phar" signature="https://github.com/yournamespace/pluginname/releases/download/{{version}}/pharname.phar.asc"/> </distributor>
步骤2 - 在packagist上为您的插件创建Composer包
在您选择的平台上为您的插件创建一个git仓库。然后前往packagist.org并为您的插件设置一个Composer包。
⚠️ 提醒 ⚠️
记住,每次您发布新版本时,都要标记您的插件仓库。
步骤3 - 享受您的PHAR部署
现在,每个人都可以通过运行以下命令来安装您的PHAR。
composer require --dev yournamespace/yourpluginname