README

通过从代码库生成规范来简化复杂工作流程的可读性

关键词：工作流程、有限状态机、Symfony2、规范生成

规范生成器 用于 StateWorkflowBundle。

最糟糕的规范是 未更新 的规范。

目标是确保您的 `工作流程规范`（可用状态和转换）始终保持最新，以简化领域可读性。因此 **避免误解** 并允许新成员更快地参与您的项目。**节省您宝贵的时间**，因为您无需再确保规范是最新的。

简单工作流程生成的规范

更复杂工作流程生成的规范

使用方法

从 Symfony2 项目

php app/console.php spec-gen:state-workflow:generate-specifications

工作流程规范文件将生成在 {PROJECT ROOT}/specification/workflow/

示例：{PROJECT ROOT}/specification/workflow/demo.booking_engine.state_workflow.html

安装

步骤 1：下载 Bundle

打开命令行，进入您的项目目录并执行以下命令以下载此 Bundle 的最新稳定版本

$ composer require spec-gen/state-workflow-spec-gen-bundle "~1"

此命令要求您全局安装了 Composer，请参阅 Composer 文档中的安装章节。

步骤 2：启用 Bundle

然后，通过在您的项目的 app/AppKernel.php 文件中添加以下行来启用该 Bundle

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            new Gmorel\StateWorkflowBundle\GmorelStateWorkflowBundle(),
        );
        
        if (in_array($this->getEnvironment(), array('dev', 'test'))) {
            // ...
            $bundles[] = new SpecGen\StateWorkflowSpecGenBundle\SpecGenStateWorkflowSpecGenBundle();
        }

        // ...
    }

    // ...
}

步骤 3：实现您的流程

使用 StateWorkflowBundle。

鸣谢

Cytoscape JavaScript 引擎用于生成工作流程规范。

许可证

MIT 许可证 (MIT)

贡献

希望简化您和团队成员对项目的理解吗？

希望为从其他 SF2 项目方面自动生成规范的新方法做出贡献吗？

增强微服务交互的可读性？
DDD - 边界上下文 - 从应用程序服务生成 UML？
通用语言词典生成器？
其他想法？

加入 https://github.com/spec-gen

spec-gen / state-workflow-spec-gen-bundle

维护者

详细信息