🇸🇪arkitektur

# Visualises JavaScript, TypeScript and Flow codebases as meaningful and committable architecture diagrams - Associates source files with configured architectural components - Renders grouped components and dependency graph including Node.js modules - Supports JavaScript, TypeScript and Flow source code and Vue/Nuxt - Exports codebase architecture visualisation as SVG, PNG or Plant UML diagram - Integrates into development flow, so your CI, VCS, README and PRs are happy ## Usage ```sh # Run arkit straight away npx arkit # Or add it to your project as a dev dependency npm install arkit --save-dev yarn add arkit --dev ``` ```sh # Run arkit against your source folder and save result as SVG npx arkit src/ -o arkit.svg # You can also specify source files to start from and output format npx arkit -f src/main.js -o puml # And get some more with debugging and file exclusions LEVEL=info npx arkit -e "node_modules,test,dist,coverage" -o puml ``` :warning: Arkit is using a web service to convert PlantUML to SVG/PNG. It's hosted at arkit.pro and does not store any data. **If you want to use Arkit at work make sure this is fine with your company tools policy**. If your project is huge and first diagrams look messy, it's better to generate them per feature, architectural layer, etc. Once you satisfied with results, add arkit command to your build script, so it will keep your architecture diagrams up-to-date. ## Configuration Arkit can be configured using basic CLI arguments or advanced JSON, JS module or package.json configuration. #### Basic CLI arguments ```console user@machine:~$ npx arkit --help arkit [directory] Options: -d, --directory Working directory [default: "."] -c, --config Config file path (json or js) [default: "arkit.json"] -o, --output Output path or type (svg, png or puml) [default: "arkit.svg"] -f, --first File patterns to be first in the graph [string] -e, --exclude File patterns to exclude from the graph [default: "test,tests,dist,coverage,**/*.test.*,**/*.spec.*,**/*.min.*"] -h, --help Show help [boolean] -v, --version Show version number [boolean] ``` #### Advanced arkit.json with JSON schema for autocomplete and validation ```json { "$schema": "https://arkit.pro/schema.json", "excludePatterns": ["test/**", "tests/**", "**/*.test.*", "**/*.spec.*"], "components": [ { "type": "Dependency", "patterns": ["node_modules/*"] }, { "type": "Component", "patterns": ["**/*.ts", "**/*.tsx"] } ], "output": [ { "path": "arkit.svg", "groups": [ { "first": true, "components": ["Component"] }, { "type": "Dependencies", "components": ["Dependency"] } ] } ] } ``` **See more possible JSON configuration options in the examples below** ## Real-world examples #### [Express.js](https://github.com/dyatko/arkit/tree/master/test/express) using `npx arkit` ![Express architecture graph](test/express/express.svg?sanitize=true) #### [Arkit itself](https://github.com/dyatko/arkit/tree/master/src) using `npx arkit` and [config in package.json](https://github.com/dyatko/arkit/blob/master/package.json#L17) ![Arkit dependency graph](dist/arkit.svg?sanitize=true) #### [ReactDOM](https://github.com/dyatko/arkit/tree/master/test/react-dom) using `npx arkit` and [config in arkit.json](https://github.com/dyatko/arkit/blob/master/test/react-dom/react-arkit.json) ![ReactDOM architecture graph](test/react-dom/arkit.svg?sanitize=true) #### [Vue/Nuxt TodoMVC](https://github.com/dyatko/arkit-nuxt-todomvc) using `yarn arkit -o arkit.svg` ![Vue and Nuxt dependency graph](https://raw.githubusercontent.com/dyatko/arkit-nuxt-todomvc/master/arkit.svg?sanitize=true) ## Contribution The tool is under active development, so please feel free to [contribute with suggestions](https://github.com/dyatko/arkit/issues/new/choose) and pull requests. Your feedback is priceless. #### Relevant projects - [Dependency cruiser](https://github.com/sverweij/dependency-cruiser) validates and visualizes dependencies - [Madge](https://github.com/pahen/madge) generates a visual graph of module dependencies - [dependo](https://github.com/auchenberg/dependo) visualizes CommonJS, AMD, or ES6 module dependencies - [JSCity](https://github.com/aserg-ufmg/JSCity) visualizes JavaScript source code as navigable 3D cities - [colony](https://github.com/hughsk/colony) in-browser graphs representing the links between your Node.js code and its dependencies - [TsUML](https://github.com/remojansen/TsUML) generates UML diagrams from TypeScript source code

Fun stats, stargazers map by worldstar

GitHub stargazer map
Give a Github star to get on the map.

arkit

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Sick of boring JavaScript newsletters?

Downloads in past