codelytv/coding-style

Codely使用的PHP编码风格规则

维护者

详情

github.com/CodelyTV/php-coding_style-codely

源代码

问题

资助包维护！
bit.ly/CodelyTvPro

安装数: 5,652

依赖项: 7

建议者: 0

安全性: 0

星标: 49

关注者: 3

分支: 2

公开问题: 0

1.3.0 2024-08-05 14:17 UTC

Requires

AGPL-3.0-or-later 41d7e6b651619467b05018666606a1ef0958263e

static analysisCode style

This package is auto-updated.

Last update: 2024-09-05 14:29:06 UTC

README

✍️ Codely的简易编码标准配置

Codely Open Source CodelyTV Courses

考虑现代PHP最佳实践并确保一致性的有偏见的linting配置。👌

看看它，玩玩它，享受它吧。 欢迎星标 😊

👀 如何使用

  1. 安装依赖
    composer require --dev codelytv/coding-style
  2. 将其添加到您的ecs.php文件中
    use CodelyTv\CodingStyle;
use Symplify\EasyCodingStandard\Config\ECSConfig;

return function (ECSConfig $ecsConfig): void {
    $ecsConfig->paths([__DIR__ . '/src',]);

    $ecsConfig->sets([CodingStyle::DEFAULT]);

    // Or this if you prefer to have the code aligned
    // $ecsConfig->sets([CodingStyle::ALIGNED]);
};
  3. 执行它
    ./vendor/bin/ecs check

🤔 它的作用

  • 使用PSR-12对PHP进行linting
  • 扩展一些配置（您可以在这里看到所有规则）
  • 使用制表符进行缩进（原因）。如果您想使用空格，可以在您的ecs.php文件末尾添加以下行
    use Symplify\EasyCodingStandard\ValueObject\Option;

$ecsConfig->indentation(Option::INDENTATION_SPACES);

📦 如何发布新版本

只需按照语义化版本创建一个新的GitHub Release。

👌 Codely代码质量标准

发布此包时，我们致力于以下代码质量标准

  • 🤝 尊重 语义化版本：补丁或次要版本中不包含破坏性更改
  • 🤏 无意外传递依赖：使用满足目的所需的最小依赖
  • 🎯 单一特定目的，无需携带一大堆不必要的其他工具
  • 📖 良好的文档化Readme，展示如何安装和使用
  • ⚖️ 支持开源的许可证和协作