faktore/fe-skeleton-coding-standards

定义了一组通用的编码规范

安装: 23

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 1

分支: 0

开放问题: 0

类型:fe-skeleton-extension

0.1.11 2024-03-26 21:12 UTC

This package is auto-updated.

Last update: 2024-09-26 22:09:38 UTC


README

编码规范(phpstan, php-cs-fixer, php_sniffer, github build)

还提供了一个使用简单CI管道和Slack发布的 ".github/workflows/ci.yml.example" 渲染操作。

需要您设置一个指向您的Slack应用程序集成的SLACK_WEBHOOK_URL密钥。

使用方法

作为开发依赖项安装

composer require-dev faktore/fe-skeleton-coding-standards

Composer脚本

查看文件 composer.scripts.json,并将其放置在现有的 composer.json 项目文件中。

位于 fe-skeleton-composer-templates 中的启动器也提供了这个。

(不允许插入自定义脚本,这是为什么不能自动为您执行的原因)

提供文件

在 fe-skeleton 上下文中使用时,此提供以下文件。

仅一次,如果不存在

这些文件只导入一次,并且只有当此类文件尚未存在时。

在骨架更新时,这些文件不应覆盖这些文件,因为它假设您的项目已配置它们。

这是通过骨架-composer-installer评估的 "dirmapOnce" composer.json 配置所发生的情况。

这些文件打算在您的项目存储库中进行版本控制。

  • phpstan-baseline.neon(项目特定的基线)

始终在更新时

这些文件将始终维护在这个存储库中,并且每次更新到新版本都会覆盖您的文件。

您的文件打算在您的项目存储库中进行版本控制。如果您计划更改这些文件中的内容,请删除 "fe-skeleton-autogenerated" 标记。

配置

  • phpcs.xml(PHP_CodeSniffer 配置)
  • .php-cs-fixer.php(PHP-CS-Fixer 配置)
  • phpstan.neon(phpstan 配置)
  • .phpstorm.meta.php(PHPStorm 辅助)
  • phpstorm.inspections.xml(PHPStorm 检查)
  • .editorconfig
  • .github/workflows/ci.yml(工作流程)

提供应用程序/代码

提供了一个简单的Symfony CLI控制台命令

  • 作为 vendor/faktore-git/fe-skeleton-coding-standards/Sniffy(检查辅助程序)提供

重置脚本

rm phpcs.xml .php-cs-fixer.php phpstan.neon .phpstorm.meta.php phpstorm.inspections.xml .editorconfig .github/workflows/main.yml .github/workflows/ci.yml