pbaszak/lib-skeleton

一个最小的项目,允许您快速基于 Symfony 使用有用工具(standard-version, php-cs-fixer, phpstan, phpunit)创建新的库。

1.2.0 2024-02-14 19:36 UTC

This package is auto-updated.

Last update: 2024-09-09 23:35:25 UTC


README

一个最小的项目,允许您快速基于 Symfony 使用有用工具(standard-versionphp-cs-fixerphpstanphpunitdockerxdebug 和我自己的 启动脚本)创建新的库。它已准备好支持使用 Visual Studio Code 进行调试 - 只需查看 .env.local 即可;)。

为什么?

https://github.com/patrykbaszak/skeleton#why

如何开始

为您的项目创建目录,进入(cd {您的目录})并运行命令

composer create-project pbaszak/lib-skeleton . --no-interaction

使用此命令启动本地环境

# first use
bash start.sh vendor/package

# all next uses
bash start.sh

好了!您的本地环境已准备好使用有用工具开发库。

如何使用 Standard Version

如果您没有 node_modules 目录,请运行

npm install

首次发布

npm run version:first-release

主版本次版本修订版版本更新

npm run version:major
# or
npm run version:minor
# or
npm run version:patch

推送标签

npm run version:release
# or
npm run release

检查 package.json 了解命令的作用。

如何使用 PHPStan

主要命令

docker exec php composer code:analyse

但如果您需要添加错误到忽略列表

docker exec php composer code:analyse:b

如何使用 PHP CS Fixer

docker exec php composer code:fix

如何在 Visual Studio Code 中使用 XDebug

在您的项目中创建新文件:.vscode/launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for xDebug",
            "type": "php",
            "request": "launch",
            "port": 5902,
            "hostname": "0.0.0.0",
            "pathMappings": {
                "/app/": "${workspaceRoot}"
            }
        }
    ]
}

.env.local 中取消注释环境变量

XDEBUG_MODE=develop,debug
XDEBUG_CONFIG=" client_port=5902 idekey=VSCODE client_host=host.docker.internal discover_client_host=0 start_with_request=yes"

Ctrl + Shift + D 并运行 监听 xDebug