0.9.2 • Published 1 year ago
js2mermaid v0.9.2
js2mermaid
js2mermaid は JavaScript におけるクラス本体とメソッド定義の呼び出しを Mermaid.js によって可視化し、複雑（Complicated）な場合の認知負荷を軽減したいソフトウェアエンジニア向けの開発者ツールです。
Install
npm install --save-dev js2mermaidUsage
npx js2mermaid [options] file.js [file|dir]Options
| Option | Default | Description |
|---|---|---|
--format call-graph | Yes | コールグラフを出力します |
--format class-diagram | クラス図を出力します | |
--debug | デバッグ情報を出力します |
Features
es2015 以降 の クラス宣言 と 名前つきクラス式 のクラス本体とメソッド定義を解析し、オプションに応じて次のダイアグラムを出力します。なお出力内容は https://mermaid.live/ などで確認してください。
Call Graph
e.g. 本リポジトリを出力した例
npx js2mermaid --format call-graph bin/js2mermaid.js lib/
Class Diagram
e.g. 本リポジトリを出力した例
npx js2mermaid --format class-diagram bin/js2mermaid.js lib/
Run tests
npm run testAuthor
License
Copyright © 2022 maeda-m.
This project is MIT licensed.
This README was generated with ❤️ by readme-md-generator