digilabscz / hermes
一个通过符号链接映射资源的Composer包
1.0.4
2024-07-08 14:28 UTC
Requires
- composer-plugin-api: ^1.0 || ^2.0
README
Hermes是一个Composer插件,它可以帮助您通过创建符号链接来管理资源文件。此插件从您的包中读取.hermes
文件,并将指定的文件映射到项目中的指定资源目录。
安装
要在项目中安装Hermes,请在项目目录中运行以下命令
composer require digilabscz/hermes
配置
安装插件后,您需要在composer.json
文件中对其进行配置。使用extra
部分指定您希望创建符号链接的资源目录。
{
"require": {
"digilabscz/hermes": "*"
},
"extra": {
"hermes-assets-dir": "www/assets"
}
}
使用方法
在包中定义资源:在包含您希望符号链接的资源任何Composer包中,在包的根目录创建一个名为
.hermes
的文件。在此文件中列出相对于包根目录的资源文件路径。示例
.hermes
文件/js/datagrid.js /css/styles.css
安装包:当您安装或更新Composer依赖项时,插件将自动从每个包中读取
.hermes
文件,并在配置的资源目录中创建指定的符号链接。卸载包:当您卸载一个包时,插件将删除与该包关联的符号链接。
示例
给定以下位于digilabscz/datagrid
包中的.hermes
文件
/js/datagrid.js
以及您主项目的composer.json
中的以下配置
{
"require": {
"digilabscz/hermes": "*"
},
"extra": {
"hermes-assets-dir": "www/assets"
}
}
运行composer install
后,插件将创建以下符号链接
[ROOT_DIR]/www/assets/vendor/digilabscz/datagrid/js/datagrid.js -> [ROOT_DIR]/vendor/digilabscz/datagrid/js/datagrid.js
错误处理
如果您的composer.json
的extra
部分未指定hermes-assets-dir
,则插件将抛出错误并停止执行
Hermes assets directory is not specified in composer.json
请确保配置hermes-assets-dir
以避免此错误。
许可证
本项目采用MIT许可证。