{"id":15603456,"url":"https://github.com/maeda-m/js2mermaid","last_synced_at":"2025-04-06T15:32:39.765Z","repository":{"id":61517839,"uuid":"546427043","full_name":"maeda-m/js2mermaid","owner":"maeda-m","description":"Outputs JavaScript class and method definition diagrams and Call Graphs for Mermaid.js.","archived":false,"fork":false,"pushed_at":"2023-04-17T01:01:52.000Z","size":440,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-13T13:17:24.109Z","etag":null,"topics":["callgraph","mermaidjs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/js2mermaid","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/maeda-m.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-06T04:04:19.000Z","updated_at":"2022-10-13T12:20:28.000Z","dependencies_parsed_at":"2024-12-20T02:11:24.424Z","dependency_job_id":"332065ef-1137-4734-bd35-3f13ea9fb3d1","html_url":"https://github.com/maeda-m/js2mermaid","commit_stats":{"total_commits":22,"total_committers":1,"mean_commits":22.0,"dds":0.0,"last_synced_commit":"51c9a77f612a018e498f19293278a1bd78303d06"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maeda-m%2Fjs2mermaid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maeda-m%2Fjs2mermaid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maeda-m%2Fjs2mermaid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maeda-m%2Fjs2mermaid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maeda-m","download_url":"https://codeload.github.com/maeda-m/js2mermaid/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247502752,"owners_count":20949322,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["callgraph","mermaidjs"],"created_at":"2024-10-03T03:03:26.059Z","updated_at":"2025-04-06T15:32:39.736Z","avatar_url":"https://github.com/maeda-m.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# js2mermaid\n\n![Version](https://img.shields.io/badge/version-0.9.1-blue.svg?cacheSeconds=2592000)\n[![License: MIT](https://img.shields.io/github/license/maeda-m/js2mermaid)](https://github.com/maeda-m/js2mermaid/blob/master/LICENSE)\n\n\u003e js2mermaid は JavaScript におけるクラス本体とメソッド定義の呼び出しを [Mermaid.js](https://mermaid-js.github.io/mermaid/) によって可視化し、複雑（Complicated）な場合の認知負荷を軽減したいソフトウェアエンジニア向けの開発者ツールです。\n\n## Install\n\n```sh\nnpm install --save-dev js2mermaid\n```\n\n## Usage\n\n```sh\nnpx js2mermaid [options] file.js [file|dir]\n```\n\n### Options\n\n| Option                   | Default | Description              |\n| ------------------------ | ------- | ------------------------ |\n| `--format call-graph`    | `Yes`   | コールグラフを出力します |\n| `--format class-diagram` |         | クラス図を出力します     |\n| `--debug`                |         | デバッグ情報を出力します |\n\n## Features\n\n[es2015 以降](https://github.com/estree/estree/blob/master/es2015.md) の [クラス宣言](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#class_declarations) と [名前つきクラス式](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#class_expressions) のクラス本体とメソッド定義を解析し、オプションに応じて次のダイアグラムを出力します。なお出力内容は https://mermaid.live/ などで確認してください。\n\n### Call Graph\n\n*e.g. 本リポジトリを出力した例*\n\n```sh\nnpx js2mermaid --format call-graph bin/js2mermaid.js lib/\n```\n\n![call-graph](https://user-images.githubusercontent.com/943541/196910867-f4ece31b-2520-4a32-943f-3d47f615cac4.png)\n\n### Class Diagram\n\n*e.g. 本リポジトリを出力した例*\n\n```sh\nnpx js2mermaid --format class-diagram bin/js2mermaid.js lib/\n```\n\n![class-diagram](https://user-images.githubusercontent.com/943541/195263536-02a3e69f-d371-4271-bc55-86eb35444981.png)\n\n## Run tests\n\n```sh\nnpm run test\n```\n\n## Author\n\n[@maeda-m](https://github.com/maeda-m)\n\n## License\n\nCopyright © 2022 [maeda-m](https://github.com/maeda-m).\n\nThis project is [MIT](https://github.com/maeda-m/js2mermaid/blob/master/LICENSE) licensed.\n\n***\n\n_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaeda-m%2Fjs2mermaid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaeda-m%2Fjs2mermaid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaeda-m%2Fjs2mermaid/lists"}