denis-korchagin95 / fs-control
fs-control 帮助您管理目录树。
v1.2.0
2024-06-23 09:12 UTC
Requires
- php: >=8.1
- symfony/yaml: >=5.2
- webmozart/glob: ^4.7
Requires (Dev)
- mikey179/vfsstream: ^1.6
- phpstan/phpstan: ^1.9
- phpstan/phpstan-strict-rules: ^1.4
- phpunit/phpunit: ^9.5
- roave/security-advisories: dev-latest
- slevomat/coding-standard: ^8.6
README
fs-control 是一个分析您的目录树的工具,让您能够对其进行控制。
也许您在项目中有一些建议和规则针对目录树,但实际上在现实生活中可能只有 100% 的工作。这个工具可以允许您定义自己的配置变体,并帮助您修复并控制。
如果您的思路改变了关于目录树,那好吧,很酷。只需编辑配置,fs-control 会为您处理。同时,让您摆脱一些“审查斗争”,并让您专注于更重要的事情。
入门指南
您可以通过 Composer 使用主 composer.json
安装 fs-control。
composer require --dev denis-korchagin95/fs-control
或者您可能需要在一个专门的 composer.json
中通过 Composer 安装 fs-control,例如在 tools/fs-control
目录中。
mkdir -p tools/fs-control composer require --working-dir=tools/fs-control denis-korchagin95/fs-control
用法
您需要为整个项目或其部分创建一个配置文件。
基本配置文件可能看起来像这样
fs_control: paths: - ./example-fs/Shared exclude_paths: - ./example-fs/Shared/Infrastructure/ParamConverter/Check groups: Application: ~ Domain: ~ Infrastructure: ~ bindings: $/Application: Application $/Domain: Domain $/Infrastructure: Infrastructure rules: Entity: - Domain ParamConverter: - Infrastructure Command: - Application
您可以使用某个项目的配置文件来分析该项目。
./vendor/bin/fs-control example-fs-config.yaml
有关更多示例和详细信息,请参阅 用法、工具概念、内置扩展列表 和 配置参考 文档。
如果您需要解决该工具不支持的具体问题,您可以 创建一个自定义扩展。
贡献
欢迎任何贡献。此存储库对拉取请求开放。