skavys / harbor-crane

Harbor 生成器命令

v1.0.1 2022-08-16 18:40 UTC

This package is auto-updated.

Last update: 2024-09-29 23:03:33 UTC


README

build download license release php

Harbor 生成器命令

简介

Harbor Crane 是用于生成 Porto 架构模式的文件和目录的工具。

安装

您可以通过 Composer 安装 Harbor Crane

composer require skavys/harbor-crane --dev

或者,Harbor CranePHAR 归档的形式提供独立版本。您可以在每个 发布Assets 部分下载 phar 版本。

配置

每个命令都有以下 全局 选项

  • --config - 从 JSON 文件加载配置;
  • --ship - Ship 目录的相对路径(默认为 src/Ship);
  • --containers - Containers 目录的相对路径(默认为 src/Containers);
  • --src-namespace - Porto 根命名空间(默认为 App)。

可用命令

运行 vendor/bin/harbor-crane 以查看可用命令列表。

用法

运行以下命令以创建 AccountSection 部分

./vendor/bin/harbor-crane make:section AccountSection

您可以在一步内创建此部分内的部分和容器

./vendor/bin/harbor-crane make:section AccountSection --container-name=User --container-name=Profile

上述命令将在其中创建 AccountSection 部分和两个容器:UserProfile

运行以下命令以创建 Product 容器

./vendor/bin/harbor-crane make:container Product

上述命令将在 containers 目录中创建 Product 容器(默认为 src/Containers)。

您可以在一步内创建部分和容器

./vendor/bin/harbor-crane make:container Product --section=ProductSection

上述命令将创建 ProductSection 部分(如果尚不存在),并在其中创建 Product 容器。

配置文件

如果您的全局选项与默认选项不同,并且您不想在每次运行命令时提供它们,您可以创建 JSON 配置文件。默认情况下,配置文件的名称为 harbor-crane.json,它应位于您项目的根目录中。

{
    "ship": "app/Ship",
    "containers": "app/Containers",
    "src-namespace": "App"
}

贡献

感谢您考虑为 Harbor Crane 贡献!您可以在此处阅读贡献指南。

行为准则

请查阅并遵守行为准则

致谢

许可证

Harbor Crane 是开源软件,许可协议为 MIT 许可证