CodelyTV/refactoring-code-smells
Stars: 528
Forks: 126
Pull Requests: 53
Issues: 3
Watchers: 10
Last Updated: 2023-04-03 10:20:24
♻️ Example projects illustrating Code Smells in order to apply Refactoring techniques
License:
Languages: JavaScript, TypeScript, HTML, Makefile, Java, Shell, Dockerfile, Rust, CSS, PHP
Refactoring from Code Smells to Clean Code
🧼💩 🔜 🌈🦄
Showcase of the refactorings and code smells catalog illustrated with practical examples in different programming languages.
🎥 View refactoring course
·
⭐ Star this repository
·
☝️ Propose an example
🧠 Concepts
💩 Code Smells
These are what we could consider as potential bad practices. Things such as long methods, nested conditionals, feature envy, and so on 😊
The different Code Smells are grouped based on the following taxonomy (source) where you will find each one of the single examples:
- Bloaters: Something that has grown so large that it cannot be effectively handled
- Object-Orientation Abusers: Solutions that does not fully exploit the possibilities of object-oriented design
- Change Preventers: hinder changing or further developing the software
- Dispensables: Something unnecessary that should be removed from the source code
- Couplers: Promotes coupling (knowledge particularities) between different classes
🧼 Refactorings
👷 Work in progress
🌈 Examples
👷 Work in progress
🤯 How to explore this repository
You have the following 3 main folders:
- 💩 Code Smells
- 🧼 Refactorings
- 🌈 Examples
The purpose of this repository is to illustrate with some 🌈 Examples how we can detect 💩 Code Smells and evolve a specific code applying 🧼 Refactorings technics.
That is the reason why the code will always be located in the 🌈 Examples folder with a folder for each of its possible evolutions, and linked from the 💩 Code Smells and 🧼 Refactorings directories using symbolic links.
👌 Examples completeness
The examples you will find in this repository are completely operational projects that you can open up in your IDE and start refactoring executing the provided test suite.
That is, we understand that in order to have a better learning experience, you must have the whole picture of the specific code snippet you actually want to analyze. This gives you the freedom to modify it right away after cloning this project without having to worry about boilerplaty aspects.
🤝 Contributing
Feel free to open an issue explaining how you want to contribute before starting out coding and we will help you figuring out the best way to approach it 😊