Discussion on "Javascript Clean Code Tips & Good Practices"

Apoorv Tyagi · 2021-08-22T10:07:36.862Z

Code should be written in such a way that is self-explanatory, easy to understand, and easy to modify or extend for the new features. Because code is read more than it is written that's why so much emphasis is given to clean code. The more readable o...

Thank you very helpful Apoorv Tyagi

Awesome article. Clean code and good practices should be a must topic to learn.

One opinion, though. I think 1. Conditionals needs more explanation about why is wrong to use a negative condition because negative conditions are frequently used in Guard Clauses.

Actually, Tip #1 and #14 would be similar.

Thanks!

I really liked this article.

I just got a point that in the section 08 the good example have a simple error. That code:

const { add, subtract } = require('./calculations')

add(4,2);
calculate.subtract(4,2);

should be:

const { add, subtract } = require('./calculations')

add(4,2);
subtract(4,2);

Oh yeah, It was a mistake on my end. Thanks for letting me know :) 👍

Thank you for the article.

It seems like point 14 example doesn't follow the rules you talk about yourself. For example:

function isPercentage(val) {
 ...
}

This function should be named checkIfInRange or something that makes it more obvious that it is a function. To me as a developer something that is prefixed with is, will most likely be a boolean. In my opinion a better approach at this is:

function checkIfInRange(amount) {
  return (amount >= 0 && amount <= 100);
}

const isInRange = checkIfInRange(78);
console.log(isInRange); // true

Apoorv Tyagi

Indeed isPercentage() is but isPercentage isn't. In my opinion functions should be named to the actions they are taking and not what their return values will be, for example getUser, checkNaming, otherwise if you name the function isPercentage what will you name the return value?

function isPercentage(val) {
  var isInRange = (val >= 0 && val <= 100);
  return isInRange;
} 

const ??? = isPercentage(9);

So the naming for the function above is bad 👎 as it implies a boolean type but is a function.

Also, that function does not check if a value is a percentage, I'd expect that if a function is called isPercentage it would test if a string contains a value like % or a logic around it.

Naming a function like this will lead to confusion and the point of the article is to leave things clean and with good practices, you advocate good practices and explain them in other points but this is not one of them.

There's no such thing as boolean functions, it's just a function that returns a boolean.

typeof(isPercentage) is function and not boolean.

Now that I have set the thumbnail of this post as my wallpaper, I think I won't make the mistake again

That's a good way to remind yourself 😁👍

I really found this helpful, Thank you

Glad to hear that. Thanks a lot 🙌

Bento it actually took me a little while to get what you were saying... But it makes some sense. I've never thought about it like that before. I definitely have had that issue where I end up wanting to name the variable the same as the function.

Also... Great article Apoorv Tyagi!

Search Hashnode

Javascript Clean Code Tips & Good Practices

Responses6