arkit visualises architectures of JavaScript, TypeScript and Flow codebases as meaningful and committable diagrams [🇸🇪 arkitektur]
- Supports JavaScript, Node.js, TypeScript and Flow code
- Identifies, connects and groups configured architectural components
- Visualises all components or some segments of the architecture
- Exports codebase visualisation as PlantUML, SVG or PNG
- Integrates into development flow, so your CI, VCS, README and PRs are happy
Usage
Add arkit to your project using NPM or Yarn:
npm install arkit --save-dev
yarn add arkit --dev
Configuration
Arkit can be configured using basic CLI arguments or advanced JSON, JS module or package.json configuration. JSON schema can assist with available options.
CLI arguments
npx arkit --help
JSON config
{
"$schema": "https://raw.githubusercontent.com/dyatko/arkit/master/schema.json"
}
Real-world examples
Simple example (Express.js, zero config)