aw-studio/cshelper

所有 Wetters PHP CS Fixer 配置以及进一步默认编码风格配置。

维护者

详情

github.com/aw-studio/cshelper

源代码

问题

安装次数: 229

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 2

分支: 0

开放问题: 0

dev-main 2021-02-19 15:23 UTC

Requires

MIT 0ae2aa360771262d43bcb2869d894e9cc6617d03

  • Lukas Heller <lukas.woop@aw-studio.de>

This package is auto-updated.

Last update: 2024-09-19 22:55:01 UTC

README

此软件包包含由 Alle Wetter 用于我们所有 Laravel 网络项目的默认编码风格配置。

包含的编码风格配置

  • PHP-CS-Fixer (configs/.php_cs.dist)，主要基于 Laravel StyleCI 规则，并相应地实现了 PSR-2，添加了一些额外的规则和设置。

安装

您可以通过 composer 安装此包

composer require aw-studio/cshelper

并运行初始化命令

vendor/bin/cshelper init

init 命令将

  • 发布默认配置文件，并将
  • .php_cs.cache 添加到项目根目录的 .gitignore 文件中。
  • 可选地，还会发布一个 GitHub 动作文件，用于在 GitHub Actions 中运行 lint。

使用

VS Code 扩展

通过发布默认配置，我们能够使用 PHP CS Fixer for VS Code 扩展 在保存文件时自动应用我们的编码风格。这并不是必需的，因为 friendsofphp/php-cs-fixer 作为包依赖项是必需的，这使得可以从命令行运行命令。

命令行界面 (CLI)

运行 PHP CS Fixer 而不更改文件

vendor/bin/vendor/bin/cshelper php lint

一次性修复所有内容

vendor/bin/vendor/bin/cshelper php fix

更新配置文件

如果我们的配置将来有所变化，您可以使用 publish --force 命令来覆盖之前发布的配置文件。

vendor/bin/vendor/bin/cshelper publish --force

致谢

此软件包深受 tightenco/duster 和 elbgoods/ci-test-tools 的启发。这个原始的想法和结构受到了他们工作的影响。

许可协议

MIT 许可协议 (MIT)。请参阅 许可文件 获取更多信息。