arvodia / grouper
按组管理的 Composer 插件、包和任务管理器
Requires
- composer-plugin-api: ^2.3
- matthiasmullie/minify: ^1.3
Requires (Dev)
- composer/composer: ^2.3
README
按组管理的 Composer 插件、包和任务管理器
Grouper 是一个 Composer 插件,允许您将包分组,使用单个命令安装或卸载组中的包。
Grouper 脚本称为任务,它们可以复制文件、目录或压缩 CSS 和 JS 文件。
与其他 CSS 和 JavaScript 支持相比,grouper 的优势在于无需运行任何额外的脚本。资源文件在 composer update
后自动更新和压缩。
内容
功能
- 将包按单个名称分组
- 激活组,安装所有这些包并运行任务
- 对组和包执行的任务
- 文件映射和 CSS、JS 压缩
- 文件修补程序
- 文件、文件夹删除
- 交互式命令
- 交互式初始化 grouper.json 文件
- 交互式组及任务管理器
- 格式化显示消息
安装
使用 composer 集成 grouper 到您的项目中。
composer require arvodia/grouper
初始化 grouper
composer grouper:init
示例
管理 CSS 和 JavaScript,在此示例中,我们将 bootstraps
、bootstrap-admin
、jquery
、popper
和 font-awesome
组成一个组,并使用 grouper 任务创建公共/src 文件夹,只复制和压缩必要的文件。您还可以使用分组做很多其他事情。
步骤 1
安装 grouper 并压缩
composer require arvodia/grouper
步骤 2
将存储库添加到您的项目中,在 composer.json 文件中添加以下行
"repositories": [
{
"type": "composer",
"url": "https://asset-packagist.org"
}
]
步骤 3
将示例文件 链接 复制到您的工作目录
cp vendor/arvodia/grouper/src/Resources/examples/grouper.json .
步骤 4
最后,激活组。
composer grouper:group arvodia-asset activate
您将在 public/src 文件夹中找到您网站所需的所有资产。
注意
对文件 grouper.json 中一些参数的解释,您会注意到任务的名称后缀为 -overwrite
,表示更新时覆盖文件,选项 "uninstall": true
表示在取消组激活时删除文件。
命令
composer grouper:group
- 组管理命令:激活、取消激活、创建、删除、添加和删除
composer grouper:groups
- 显示所有可用组的信息。
composer grouper:init
- 在 composer 工作目录中创建基本的 grouper.json 文件。
composer grouper:task
- 为组或包添加、运行或删除任务设置。
任务
任务可以交互式地添加到组包或组本身。
任务类型
有三种类型的任务
- 文件映射
- 文件映射覆盖
- CSS 压缩
- CSS 压缩覆盖
- JS 压缩
- JS 压缩覆盖
- 文件修补程序
- 文件目录删除
每个任务都需要两个参数:source
和 destination
- 源组
- 与 composer.json 位置的路径
- 源包
- 相对于包本身的路径
- 目标
- 与 composer.json 位置的路径
包任务
如果组激活,则在以下事件中执行
- post-package-install
- post-package-update
组任务
这些操作只在组激活结束时执行。如果这些包中的任何一个被选中,它们只会在“更新|安装”之后执行。
任务选项
对于instemp来说,只有一个选项uninstall
,如果它被启用,在禁用组后,所有添加的文件或文件夹将被删除。
配置
配置文件放置在grouper.json中,但请勿手动更改此文件,而是使用grouper命令来管理您的组。
卸载
配置文件grouper.json,如果您卸载grouper包,它将被删除。
变更日志
变更日志,按变更顺序降序排列的变更列表,按版本分组。链接:CHANGELOG 从版本1.0.5开始,提交文本代表工作版本。
Git 克隆
$ git clone https://github.com/arvodia/grouper.git
联系
arvodia@hotmail.com - EURL ARVODIA
许可证
MIT许可