🕵️‍♀️ SmellScan-Pro

SmellScan-Pro is a 🔧 tool designed to scan the code and detect the design smells or violations of design principles. It evaluates language-independent design principles using language-specific semantic evidence.

Currently we release with Angular/TypeScript support, other languages will be added in subsequent releases.

🌟 Features

SmellScan-Pro is capable of detecting the following design smells in code:

Abstraction Smells

1. Imperative Abstraction 📚
2. Unnecessary Abstraction 📦
3. Unutilized Abstraction 🎯

Encapsulation Smells

4. Deficient Encapsulation 📉
5. Unexploited Encapsulation 🔐

Hierarchy Smells

6. Broken Hierarchy 🧩
7. Cyclic Hierarchy 🔁
8. Deep Hierarchy 🏞️
9. Multipath Hierarchy 🛤️
10. Rebellious Hierarchy 🚧
11. Wide Hierarchy 🌐
12. Missing Hierarchy ⛓️

Modularization Smells

13. Broken Modularization 🧱
14. Cyclic-Dependent Modularization 🔄
15. Insufficient Modularization 📊
16. Hub-like Modularization 🌀

🚀 Usage

To use SmellScan-Pro 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. Go to the 'Start SmellScan' group in the context menu and select the language. 🖱️
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-pro 🐞

🆚 VS Code Compatibility

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

🔄 Change log

Version 1.0.0

• Initial release of SmellScan-Pro with Angular/TypeScript support.
• Added support for detecting 16 design smells across 4 categories:
  • Abstraction: Imperative Abstraction, Unnecessary Abstraction, Unutilized Abstraction
  • Encapsulation: Deficient Encapsulation, Unexploited Encapsulation
  • Hierarchy: Broken Hierarchy, Cyclic Hierarchy, Deep Hierarchy, Multipath Hierarchy, Rebellious Hierarchy, Wide Hierarchy, Missing Hierarchy
  • Modularization: Broken Modularization, Cyclic-Dependent Modularization, Insufficient Modularization, Hub-like Modularization