rev22 / compy
为 Symfony2 项目创建的 composer 包装器,基于更易于使用的 YAML 文件。
Requires
- composer/composer: dev-master
- symfony/console: >=2.0
- symfony/yaml: >=2.0
This package is not auto-updated.
Last update: 2024-09-28 15:56:41 UTC
README
compy
是一个为 Symfony2 项目创建的 composer 包装器,基于更易于使用的 YAML 文件。
用法
您可以使用 compy
,就像使用 composer
一样,只需修改 compy.yml
而不是 composer.json
alice@acme$ bin/compy --version
Compy version 0.1.6
Composer version aa1c093
您应该只在您的 compy.yml
或 composer.json
所在的目录中运行 compy
您的 compy.yml
YAML 格式更容易阅读,更容易编写,并允许您添加注释,如下面的片段所示
license: MIT require: symfony/yaml: '>=2.0' # This is a comment symfony/console: '>=2.0' composer/composer: dev-master
这对于具有复杂依赖的大型项目特别有用。
(自动) 配置
首次运行时,compy
会自动转换任何存在的 composer.json。如果您修改了 composer.json
,当您再次调用 compy
时,它会自动注意并转换为 compy.yml
。在做出任何更改之前,compy
会将您的 compy.yml
备份到 compy.yml~compy~
。
安装
目前不支持全局安装。
您可以通过手动复制文件或在 composer
中安装来将 compy
安装到您的项目中。
通过 composer 安装
-
通过
composer
需要rev22/compy
包composer require rev22/compy:dev-master
-
现在您可以从 'vendor/bin/' 目录中使用 compy
user> vendor/bin/compy --version
手动复制文件
- 将此代码存档中
bin/
目录的内容复制到您的 symfony 项目中的bin/
或app/
目录; - 在您的
composer.json
中添加对composer/composer
的依赖,并运行composer install
- 确保 composer 工具已在系统范围内安装
许可协议
compy
在 MIT 风格许可协议的条款下可用。有关详细信息,请参阅文件 LICENSE。
工具的历史
compy
脚本是由 Michele Bini 提供的。该包包括 Oleg Stepura 的 convert-config
工具,该工具是从 Igor Wiedler 的 composer-yaml
分支出来的。