npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

js2mermaid

v0.9.2

Published

Outputs JavaScript class and method definition diagrams and Call Graphs for Mermaid.js.

Downloads

16

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

maeda-mmaeda-m

Keywords

call graphclass diagrammermaid

Readme

js2mermaid

Version License: MIT

js2mermaid は JavaScript におけるクラス本体とメソッド定義の呼び出しを Mermaid.js によって可視化し、複雑（Complicated）な場合の認知負荷を軽減したいソフトウェアエンジニア向けの開発者ツールです。

Install

npm install --save-dev js2mermaid

Usage

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/

call-graph

Class Diagram

e.g. 本リポジトリを出力した例

npx js2mermaid --format class-diagram bin/js2mermaid.js lib/

class-diagram

Run tests

npm run test

Author

@maeda-m

License

Copyright © 2022 maeda-m.

This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator