blendwerk/symfony-skeleton

此包的最新版本(dev-main)没有提供许可证信息。

symfony/website-skeleton 的自定义版本

dev-main 2021-05-08 01:41 UTC

This package is auto-updated.

Last update: 2024-09-08 09:45:35 UTC


README

简介

这是 symfony/website-skeleton 的自定义版本,是 Symfony 在运行 symfony new --full 时使用的默认项目模板。

symfony/website-skeleton 的基础上添加了以下依赖

  • blendwerk/coding-standard(包含 squizlabs/php_codesniffer

  • phpstan/phpstan 和其他相关包

  • php-parallel-lint/php-parallel-lint

  • ergebnis/composer-normalize

  • symfony/webpack-encore-bundle

此外,还添加了 npm 包 husky 以安装 git hooks,配置文件位于 .huskyrc.json 中。

使用方法

对于最高可用版本

composer create-project blendwerk/symfony-skeleton.

除了安装所有 composer 依赖项外,在 composer create-project 的首次运行结束时,还将自动执行以下任务

  • git init
  • PHPUnit 安装到 bin/.phpunit(这是 Symfony 现在处理它的方式)
  • 通过 yarn install 安装 package.json 中的所有依赖项

还将执行一些其他较小的任务。有关详细信息,请参阅 composer.json 中的 post-create-project-cmd 设置。

Composer 脚本

还添加了一些 composer 脚本,可以通过运行 composer <scriptname> 来调用。

其中最重要的有

  • qa:运行整个 QA 检查套件(在 git commit 时也会执行)
  • test:运行整个测试套件(在 git push 时也会执行)

有关详细信息,请参阅 composer.json 中的 scripts 部分。

故障排除

如果 PHP_CodeSniffer 报告错误,您可以使用 composer phpcbf 尝试自动修复它们。

如果 composer-normalize 报告错误,您可以通过运行 composer normalize 自动修复它们。

维护

在新的 Symfony 版本发布时需要更新。以下是方法

在此处创建一个新分支(例如 5.2),从 https://github.com/symfony/website-skeleton 的相应分支(例如 5.2,而不是 master)获取当前的 composer.json,并将其与我们当前的 composer.json 合并。

包含的 package.json 基于包含在 symfony/webpack-encore-bundle 脚本中的版本,源代码位于此处:https://github.com/symfony/recipes/tree/master/symfony/webpack-encore-bundle