Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/artiphishle/ankh-uml
Developer tools and project management tools
https://github.com/artiphishle/ankh-uml
Last synced: about 1 month ago
JSON representation
Developer tools and project management tools
- Host: GitHub
- URL: https://github.com/artiphishle/ankh-uml
- Owner: artiphishle
- License: mit
- Created: 2024-02-19T16:30:27.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-24T04:35:53.000Z (5 months ago)
- Last Synced: 2024-10-31T14:12:44.280Z (about 2 months ago)
- Language: TypeScript
- Size: 364 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ankh-uml
Ankhorage is the entrypoint of multiple tools that help plan, implement, test & document IT projects.
## Quickstart
```bash
# @param root class file (.ts)
# @param output directory
npx ankh-uml path/to/RootClass.ts .
```
## Features
Generate UML diagrams for your TypeScript classes.
This allows inspection of parts of your whole architecture. Furthermore you can enable/disable features like:
- [x] Start from a root file (entrypoint)
- [ ] Show/hide interfaces/types
- [x] Show method returnType
- [ ] Show/hide method params
- [x] Show/hide dependencies
- [ ] Set the depth of the diagram
- [ ] Choose between multiple renderers
- [ ] Mermaid
- [x] PlantUML
## Contributing
At the moment the tools are written for Node.js & TypeScript.
However other languages, platforms & tools are welcome.
### Attach your tool
If you have a tool that you want to attach to Ankhorage, you can do so by providing a NPX entrypoint.
### Enhance this repository
If you want to enhance this repository, you can do so by providing a PR.
#### Conventions
| Convention | Details |
| ---------- | ------------------------ |
| eslint | `eslint-google-config` |
| prettier | `artiphishle/prettierrc` |
#### Conventions
Entrypoint:
- Naming: `ankh-`.
- Callable via: `npx ankh-`.
- Styling of stdout style as in `npx ankhorage`.
## Changelog
### 2024/02/23
- Repo renaming and move to meta repository
### 2024/02/20
- Created a standalone package for ankh-tools-uml
- Add `examples/` directory with a UML example
### 2024/02/19
#### Added UML Generator
- Basic support of UML generation for a single TS Class
- Generating UML using PlantUML (Mermaid planned).