README

blumilksoftware/codebase

Blumilk 所有项目的通用代码风格助手。

使用方法

将包添加到我们的项目中

composer require blumilksoftware/codestyle --dev

然后运行以下命令以创建配置文件并添加脚本到 composer.json 文件中

./vendor/bin/codestyle init

或者您可以在项目的根目录中创建 codestyle.php 文件

<?php

declare(strict_types=1);

use Blumilk\Codestyle\Config;

return new Config();

配置

您可以在 Config 类构造函数中配置路径和规则

<?php

declare(strict_types=1);

use Blumilk\Codestyle\Config;
use Blumilk\Codestyle\Configuration\Defaults\LaravelPaths;

$paths = new LaravelPaths();

$config = new Config(
    paths: $paths->filter("app", "tests")->add("src"),
);

return $config->config();

或者

<?php

declare(strict_types=1);

use Blumilk\Codestyle\Config;
use Blumilk\Codestyle\Configuration\Defaults\LaravelPaths;

$config = new Config(
    paths: new LaravelPaths(LaravelPaths::LARAVEL_8_PATHS),
);

return $config->config();

或者

<?php

declare(strict_types=1);

use Blumilk\Codestyle\Config;
use Blumilk\Codestyle\Configuration\Defaults\Paths;

$config = new Config(
    paths: new Paths("src"),
);

return $config->config();

使用 Composer 的用法

将脚本添加到您的 composer.json 文件中

{
  "scripts": {
    "cs": "./vendor/bin/php-cs-fixer fix --dry-run --diff --config codestyle.php",
    "csf": "./vendor/bin/php-cs-fixer fix --diff --config codestyle.php"
  }
}

然后运行以下命令来检查代码风格

composer cs

或者以下命令来修复找到的错误

composer csf

附加配置

如果您想禁用风险规则，可以在配置文件中添加 withoutRiskyFixers 方法

return $config->withoutRiskyFixers()->config();

如果您想启用忽略标记的文件，可以在配置文件中添加 ignoreMarkedFiles 方法

return $config->ignoreMarkedFiles()->config();

然后在您想要忽略的文件中添加 // php-cs-fixer:ignore-file

升级指南

升级指南可在 upgrading.md 文件中找到。

贡献

在克隆或分叉的仓库中，运行

cp .env.example .env
composer install

提供用于包代码风格检查和测试的脚本

还提供了 Docker Compose 配置

docker compose up -d
docker compose exec php php -v
docker compose exec php composer -V

还提供了 Makefile 命令

make run
make shell
make stop

请维护我们的项目指南

• 保持问题描述清晰，标记并使用英语
• 将问题编号添加到所有您的提交中
• 将问题编号添加到您的分支名称中
• 将您的提交压缩成一个具有标准化名称的提交