Coder Social home page Coder Social logo

burobo / compocomp Goto Github PK

View Code? Open in Web Editor NEW

This project forked from naosim/compocomp

0.0 0.0 0.0 84 KB

コンポーネントとユースケースを記述したデータから見たい粒度の図を生成する

License: MIT License

TypeScript 22.52% JavaScript 77.48%

compocomp's Introduction

CompoComp

コンポーネントとユースケースを記述したデータから見たい粒度の図を生成する

import用モジュール

import {CompoComp} from "https://naosim.github.io/CompoComp/CompoComp.js";

sample

const list = [];// 要定義

const models = CompoComp.createModels(list);
const options = {
  title: '他社状況同期のシステム関係図',
  aggregateType: 'aggregate', // none, aggregate, aggregateWithoutBoundary
  bucFilter: ['他社状況同期'],  // bucの指定
  displayUsecaseName: false   // ユースケース名の表示
};
const plantuml = CompoComp.toPlantUml(models, options);
console.log(plantuml);

データフォーマット

※例はyaml

system システム

key 必須 説明
type string o 固定値:system
id string o システムID
name string システム名。未定義の場合はidがnameになる
actorType string アクタータイプ。system, boundary, その他plantumlのアイコンで使える値。未設定の場合はsystemになる
place string システムの場所

type: system
id: サービス管理
name: サービス管理

component コンポーネント

key 必須 説明
type string o 固定値:component
id string o コンポーネントID
name string コンポーネント名。未定義の場合はidがnameになる
systemId string o システムID。親。
actorType string アクタータイプ。system, boundary, その他plantumlのアイコンで使える値。未設定の場合はsystemになる
place string システムの場所

type: component
id: サービス管理メイン
name: サービス管理メイン
place: AWS
systemId: サービス管理
actorType: system
style:
  fill: ff0

BUC ビジネスユースケース

key 必須 説明
type string o 固定値:buc
id string o BUCID
name string o BUC名

type: buc
id: 入会
name: 入会

SUC システムユースケース

key 必須 説明
type string o 固定値:suc
id string o BUCID
name string o BUC名
systemId string o 関係するシステムID(主語)
buc string[] o 関係するBUC。複数。
dependences (sucId | SubUsecase)[] 関係するユースケース。アクセス先SUC、または、ここで直接定義するユースケース。

type: suc
id: サビ管メイン_申込
name: 申込
systemId: サービス管理メイン
buc: 
- 入会
dependences:
- 他社連携_申込

ComponentStyle

システムとコンポーネントのスタイル

key 必須 説明
type string o 固定値:componentStyle
componentId string o 対象のコンポーネントID
name string 名前
style object o
style.fill string 背景色。ff0のように指定する。(#はいらない)
style.stroke string 線の色。ff0のように指定する。(#はいらない)

SubUsecase

SUCの中で使うオブジェクト。

key 必須 説明
systemId string o 依存先のシステムID または コンポーネントID。ただしコンポーネントIDの方が表示の不整合が起きにくい
uc string o ユースケース名

開発者用

bundle

deno bundle ./src/CompoComp.ts ./docs/CompoComp.js

compocomp's People

Contributors

naosim avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.