🕵️‍♀️ SmellScan-ts

SmellScan-ts is a 🔧 tool designed to scan Angular/TypeScript code for the detection of design smells or violations of design principles. It is essential that the Angular/TypeScript code follows an Object-Oriented Programming (OOP) approach for the tool to effectively identify design smells.

🌟 Features

SmellScan-ts is capable of detecting the following 10 design smells in TypeScript code:

1. Imperative Abstraction 📚
2. Unnecessary Abstraction 📦
3. Deficient Encapsulation 📉
4. Broken Hierarchy 🧩
5. Cyclic Hierarchy 🔁
6. Deep Hierarchy 🏞️
7. Multipath Hierarchy 🛤️
8. Rebellious Hierarchy 🚧
9. Wide Hierarchy 🌐
10. Broken Modularization 🧱

🚀 Usage

To use SmellScan-ts after installing the extension on VS Code, follow these steps:

1. Select and right-click the folder in the EXPLORER that you wish to scan. 📂
2. Click on the 'Start SmellScan' option in the context menu. 🖱️
3. A file named designSmells.csv will be generated containing the report. 📄
4. For enhanced visualization, a Sunburst chart will also be generated. 🌅

🤝 Contributing

We welcome contributions, issue reports, and feature requests! 🎉

To report issues, please visit:

• https://github.com/abhipsb/smellscan-ts 🐞

🆚 VS Code Compatibility

SmellScan-ts supports VS Code version 1.88.0 or later. 🎯

📚 Additional Information

SmellScan-ts is based on DesigniteJava and has been rewritten from scratch in TypeScript for scanning TypeScript code. For more information about design smells, please visit Design Smells.

🔄 Change log

Version 1.0.0 (2024-04-30)

• Added support for generating Sunburst chart for enhanced visualization.
• Improved performance and accuracy of design smell detection.

Version 0.1.2 to 0.1.6 (2021-06-02 to 2024-04-25)

• Initial releases of SmellScan-ts
• Added support for detecting Imperative Abstraction, Unnecessary Abstraction, Deficient Encapsulation, Broken Hierarchy, Cyclic Hierarchy, Deep Hierarchy, Multipath Hierarchy, Rebellious Hierarchy, Wide Hierarchy, and Broken Modularization design smells.