kylos / comp-manager
v2.1
2019-09-12 20:08 UTC
Requires (Dev)
- composer/composer: 1.0.*@dev
- phpunit/phpunit: 8
- symfony/filesystem: ~2.7
- symfony/finder: ~2.7
This package is not auto-updated.
Last update: 2024-09-20 21:12:02 UTC
README
ComposerManages 是一个创建来自动化开发过程的包。
要求
Composer
PHP > 7.2
# 使用
### 1. 安装
composer require kylos/comp-manager
### 2. 在主 composer.json 文件中,您需要指定何时以及需要执行哪个脚本。
**该系统基于 composer-events。如果您想了解更多信息,请查找所有可用的事件类型 https://composer.php.ac.cn/doc/articles/scripts.md .
例如
要执行脚本,您需要在您的 composer.json 的 scripts 部分提供正确的路径。
您需要使用的主要方法: "Kylos\\CompManager\\ComposerScripts::methodName"
在方法名称中需要使用以下方法名称之一:
- copy
- move
- settings
- cleanUp
这些方法在下面的 可用的脚本 部分有很好的描述
例如在 composer.json 中
"scripts": {
"post-install-cmd": [
"Kylos\\CompManager\\ComposerScripts::settings",
"Kylos\\CompManager\\ComposerScripts::cleanUp"
],
},
您需要为需要使用 extras 的每个命令定义 extra 属性以使其正常工作。
在下一步中查看...
对于某些命令,您需要在 composer.json 的 'extras' 中提供额外的信息以使其正常工作。
可用的脚本
## 复制或更新文件 通过路径从给定位置复制文件到另一个位置。
例如
"scripts": {
"post-install-cmd": [
"Kylos\\CompManager\\ComposerScripts::copy",
]
},
"extra" {
"copy-file" : {
"file-path-to-copy/" : "final-file-path-to-copy/"
}
}
移动文件 将文件从一个位置移动到另一个位置。
例如
"scripts": {
"post-install-cmd": [
"Kylos\\CompManager\\ComposerScripts::move",
]
}
"extra" {
"move-file": {
"file-path-to-move/": "file-path-moved/"
}
}
编辑设置文件 通过更改定义的标签之间的内容来编辑文件内容。特别适用于配置文件。
您可以定义要更改内容之间的任何标签。
例如
"scripts": {
"post-install-cmd": [
"Kylos\\CompManager\\ComposerScripts::settings",
]
},
"extra": {
"settings": {
".htaccess": {
"destinationFile": "destination/.htaccess",
"pattern": "## KYLOS CUSTOM ##",
"position": "start"
}
},
}
说明
.htaccess是您想要获取配置的文件的文件路径。定义了标签(如何确切地查看以下内容)destinationFile是要编辑配置或创建该文件的文件名(如果不存在)。pattern设置 'pattern between' 的模式position设置文本添加的start和end位置。如果没有定义,内容将添加到文件末尾。
示例
In destination file You have to wrap your code in given pattern.
目标文件
## KYLOS CUSTOM ##
your code
## KYLOS CUSTOM ##
安装后在 destination/.htaccess 中的效果
SOME CODE
THAT EXISTED BEFORE
## KYLOS CUSTOM ##
your code
## KYLOS CUSTOM ##
清理 例如
"scripts": { "post-install-cmd": [
"Kylos\\CompManager\\ComposerScripts::cleanUp",
]
}
清理安装的包。
将要清理的文件和目录
- .git
- .github
- test
- tests
- travis
- demo
- example
- examples
- doc
- docs
- license
- changelog*
- changes*
- faq*
- contributing*
- history*
- upgrading*',
- upgrade*
- package*
- readme*
- {,.}*.yml
- *.md
- *.xml
- *.txt
- *.dist
- .php_cs*
- .scrutinizer
- .gitignore
- .gitattributes
- .editorconfig
- dockerfile
- composer.lock