a cheatsheet for codesmells in your terminal
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bloaters
change-preventers
couplers
dispensables
object-orientation-abusers
other-smells
.gitignore
.help
README.md
codesmells.sh
install.sh

README.md

This puts all the codesmelling information you need right at your fingertips.

Installation Instructions

With Root Permissions

  • clone the repo
  • change directory into the root directory of the repository
  • sudo ./install.sh

Without Root Permissions

  • clone the repo
  • add an alias into your ~/.bashrc or ~/.zshrc for codesmells=<path-to-source>/codesmells.sh

Now you have a cheat sheet for many code smells right at your fingertips. No internet required!

usage:

codesmells

codesmells bloaters

codesmells bloaters primitive-obsession

if you already know the name of the smell you can shortcut the category:

codesmells primitive-obsession

codesmells has a discoverable CLI - so just run codesmells and go from there

Updating

If you have not modified the git settings for this repository, running codesmells --update will update your installation.

Under the hood, it just runs git pull but if more needs to be done - it will be added to that section of the script.

Credit where credit's due

I am sourcing all of my information from https://sourcemaking.com/refactoring - the information there is richer so go ahead and check it out. Command line does have limitations after all ;)