An open API service indexing awesome lists of open source software.

https://github.com/myxvisual/vscode-ts-uml

💻 Dynamic generates TypeScript UML diagrams to Visual Studio Code.
https://github.com/myxvisual/vscode-ts-uml

Last synced: 9 months ago
JSON representation

💻 Dynamic generates TypeScript UML diagrams to Visual Studio Code.

Awesome Lists containing this project

README

          

# vscode-ts-uml

[![Version](https://vsmarketplacebadge.apphb.com/version/myxvisual.vscode-ts-uml.svg)](https://marketplace.visualstudio.com/items?itemName=myxvisual.vscode-ts-uml)
[![Installs](https://vsmarketplacebadge.apphb.com/installs/myxvisual.vscode-ts-uml.svg)](https://marketplace.visualstudio.com/items?itemName=myxvisual.vscode-ts-uml)
[![Ratings](https://vsmarketplacebadge.apphb.com/rating/myxvisual.vscode-ts-uml.svg)](https://marketplace.visualstudio.com/items?itemName=myxvisual.vscode-ts-uml)

[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/myxvisual/vscode-ts-uml.svg)](https://github.com/myxvisual/vscode-ts-uml/issues "Average time to resolve an issue")
[![Percentage of issues still open](https://isitmaintained.com/badge/open/myxvisual/vscode-ts-uml.svg)](https://github.com/myxvisual/vscode-ts-uml/issues?q=is%3Aopen+is%3Aissue "Percentage of issues still open")

---

Dynamic generates TypeScript UML diagrams to [Visual Studio Code](https://code.visualstudio.com/) (**minimum supported version: `1.25.0`**)

Supported filename extensions: `ts`, `tsx`, `.d.ts`, only supported single file now.

![base-usage](https://raw.githubusercontent.com/myxvisual/vscode-ts-uml/master/images/base-usage.gif)

![dynamic-usage](https://raw.githubusercontent.com/myxvisual/vscode-ts-uml/master/images/dynamic-usage.gif)

---

## Installation

To install the extension just execute the following command:

```sh
ext install vscode-ts-uml
```

## Usage

After reloading `vscode`.

* RightClick `.ts`, `.tsx`, `.d.ts` files, select `Show Typescript UML from file` menu to open `vscode-ts-uml` window.
* Use shortkey `Ctrl + Alt + Shift + Q` to select current editor focus file and open `vscode-ts-uml` window.

## License

The source code is licensed under the [MIT](https://raw.githubusercontent.com/myxvisual/vscode-ts-uml/master/LICENSE) license.

The icons are licensed under the [Creative Commons - ShareAlike (CC BY-SA)](https://creativecommons.org/licenses/by-sa/4.0/) license.

Branded icons are licensed under their copyright license.

## Change Log

You can checkout all our changes in our [change log](https://github.com/vscode-icons/vscode-icons/blob/master/CHANGELOG.md).

**Enjoy!**