devmcc/package-dev

用于开发Composer包的简单工具。

2.0.1 2021-03-03 15:08 UTC

This package is auto-updated.

Last update: 2024-09-29 04:25:51 UTC


README

用于开发Composer包的简单工具。

PackageDev利用符号链接使您开发的包看起来像在vendor中运行。因此,您可以立即修改包并检查结果。

安装

建议全局安装PackageDev

composer global require devmcc/package-dev

安装PackageDev后,前往需要使用您的包的项目根目录,并运行

package-dev init

接下来,打开项目的composer.json文件,并添加以下内容

"scripts": {
    "pre-install-cmd": [
        "package-dev symlink-remove"
    ],
    "pre-update-cmd": [
        "package-dev symlink-remove"
    ],
    "post-install-cmd": [
        "package-dev symlink-create"
    ],
    "post-update-cmd": [
        "package-dev symlink-create"
    ]
}

链接包

运行init后,将创建一个名为packages的新目录,您需要将您的包添加到该目录中。

如果您的包名为devmcc/testing,您需要按照以下文件夹结构添加您的包

./packages/devmcc/testing

使用以下命令链接您的包

package-dev link devmcc/testing

使用以下命令解除您的包链接

package-dev unlink devmcc/testing

使用phar存档

PackageDev可以通过phar存档运行。这在使用Docker容器等工具时非常有用。

您可以使用以下命令创建存档

package-dev phar

接下来,修改项目composer.json文件中的以下内容

"pre-install-cmd": [
-    "package-dev symlink-remove"
+    "@php package-dev.phar symlink-remove"
],
"pre-update-cmd": [
-    "package-dev symlink-remove"
+    "@php package-dev.phar symlink-remove"
],
"post-install-cmd": [
-    "package-dev symlink-create"
+    "@php package-dev.phar symlink-create"
],
"post-update-cmd": [
-    "package-dev symlink-create"
+    "@php package-dev.phar symlink-create"
]

注意:为了能够创建phar存档,您需要在您的php.ini文件中添加以下内容

phar.readonly = 0

从版本1升级

对于使用版本1的用户,以下是升级到版本2的方法:解除所有包的链接,升级,然后再次链接

测试

在克隆仓库并安装所有依赖项后,您可以执行以下操作

  • 使用vendor/bin/phpunit运行单元测试
  • 使用vendor/bin/phpstan analyse src tests --level max运行代码分析
  • 使用vendor/bin/phpunit --coverage-html tmp/code-coverage运行代码覆盖率分析
    • 然后在浏览器中打开tmp/code-coverage/index.html
  • 使用vendor/bin/phpcs --standard=PSR12 src tests运行phpcs