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

autouml

v1.0.3

Published

Autogenerate UML diagrams using d2

Downloads

8

Vulnerabilities

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

Links

Git

Maintainers

wilgao09wilgao09

Keywords

typescriptd2developer-toolssoftware-architectureUMLuml-class-diagram

Readme

autouml

A UML generation tool for TypeScript codebases. Primarily uses the TypeScript compiler API to compile type relations and d2 to render the class diagrams.

Requirements

  • node >=18

Usage

This tool is primarily used as a command line tool. Install it using

npm i autouml --save-dev

If this is being used in code, --save the package instead. Refer to the documentation for more information.

The command line tool comes with a few options. For a comprehensive list, run npx autouml --help.

Documentation

The official documentation can be hound here. This documentation is designed for developers of this project, and documents the entire codebase. For API information, refer to the exposed functions and classes listed here.

Roadmap

This project can expand in a few directions. The following are a few directions that are currently being considered:

  • tsdoc integration
  • more compilation targets (mermaid, plantuml)
  • javascript project support

Known Issues

The following is a lsit of currently known issues.

  • Empty interfaces are primitives
  • Type literals are interpreted as __type