Using Guard Clauses to Clean Up Your Conditionals [A How-To Guide]

One of the first techniques developers learn is the if/else statement. For obvious reasons if/else statements are a primary way to create logic trees. This is where we handle calculations differently depending on the input variables. However, complex and nested if/else statements become a cognitive burden to reason about. Therefore, it can be hard for the next developer to understand quickly.

Guard Clauses

Guard Clauses are a way to leverage the ability to return early from a function (or break/continue through a loop) to make nested conditionals more one-dimensional.

I'm primarily a go developer. The way errors are handled in go naturally encourage the developer to make use of guard clauses. When I started writing more javascript, I was disappointed to see how many nested conditionals existed in the code I was working on.

Go is the shit

Let's take a look at the following fake javascripty example:

function getInsuranceAmount(status) {
  let amount;
  if (!status.hasInsurance()){
    amount = 1;
  } else {
    if (status.isTotaled()){
      amount = 10000;
    } else {
      if (status.isDented()){
        amount = 160;
        if (status.isBigDent()){
          amount = 270;
        }
      }
    }
  }
  return amount;
}

Could be written with guard clauses instead:

function getInsuranceAmount(status) {
  if (!status.hasInsurance()){
    return 1;
  }
  if (status.isTotaled()){
    return 10000;
  }
  if (status.isDented() && status.isBigDent()){
    return 270;
  }
  if (status.isDented()){
    return 160;
  }
  return 0;
}

The example above still probably isn't the best way to approach this function. It is much easier to read and understand, however. When writing code, it is important to try to reduce cognitive load on the reader by reducing the amount of things they need to think about at any given time.

In the first example, if the developer is tying to figure out when 270 is returned, they need to think about each branch in the logic tree and try to remember which cases matter and which cases don't. With a more one dimensional structure, its as simple as stepping through each case in order.

I hope this helps us to create more readable code! I think it's great to learn the patterns and best practices that exist in programming languages we aren't familiar with, because many times those techniques can be applied to programming in general.

Download | RSS Feed | Github

(Disclaimer: The author is the Founder at qVault)

(Originally published here)