ArchTs is a static analysis tool designed to enhance and enforce architectural decisions. It provides developers with insights into their codebase by analyzing class structures and generating Object-Oriented Programming (OOP) diagrams. This helps ensure that the architectural guidelines are followed and assists in visualizing the structure of the code.
- Static Analysis of Codebase: Analyze the class structure of your TypeScript code to ensure alignment with your architectural guidelines.
- OOP Diagram Generation: Automatically generates OOP diagrams from the analyzed code to provide a visual representation of the class structure.
To install ArchTs, you can use the following steps:
npm install -g archts
To run ArchTs on a codebase, modify the index.ts with the right codebase path and run. Right now therre is an example project in the code that is used to develop the tool further.
npm run start-dev
The result can be seen in the diagram.png.
Feel free to contribute to the project by submitting issues or pull requests. Contributions are always welcome!
- Fork the repository
- Create a feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a pull request
This project is licensed under the MIT License - see the LICENSE file for details.