r/javascript • • May 22 '19

JavaScript Clean Code - Best Practices - based on Robert C. Martin's book Clean Code

https://devinduct.com/blogpost/22/javascript-clean-code-best-practices
542 Upvotes

112 comments sorted by

View all comments

40

u/[deleted] May 22 '19

Your article covers a lot of useful improvements to make code cleaner, but I have one question: Why should I use this "function getUsers({ fields, fromDate, toDate })" over "function getUsers(fields, fromDate, toDate)"? The only scenario i can imagine is if the values are optional so I dont have to write "getUsers(null, null, date)"

56

u/careseite [🐱😸].filter(😺 => 😺.❤️🐈).map(😺=> 😺.🤗 ? 😻 :😿) May 22 '19

because you can tell by the shape of the function call what it's probably going to do with it within the function.

In an example with 3 params instead of object destructuring, you'd call getUsers like this:

getUsers(['name', 'surname', 'email'], '2019-01-01', '2019-01-18')

and then had to remember the order of the dates for example. Or check it within the function.

35

u/[deleted] May 22 '19

Thanks! Not having to remember the order of arguments can prevent some hard to find bugs

7

u/nikola1970 May 22 '19

Yup, I started using this pattern recently too.

4

u/grrrrreat May 22 '19

beware though, if you have a weird visitor pattern, you can't put that object back together or manipulate its parts.

6

u/AwesomeInPerson May 22 '19

Could you explain what you mean by that? :)

2

u/grrrrreat May 23 '19

I ran into a nuxt.js hook at passed into a page object.

if I destructured it into html, path, route, I couldn't modify the html property because it didn't expect a return object but if I just accepted the page object, I could set page.html and that modified the html.

it's just a comment to realize that destructured objects are no longer a sum of their parts. so it the nuxtjs case, page can't be destructured in the hooks because it's not reconstitution the object

5

u/Zielakpl May 22 '19

What? Don't you guys use IDE with autocompletion and hints?

1

u/AwesomeInPerson May 22 '19

Which one are you using? Neither VSCode nor WebStorm warn me when I call a function with less arguments than the amount of parameters it accepts. (because I forgot to add some nulls or default values for params I want to skip)

Maybe if you enable strict TS checking for JS files, but that's not really a solution in a lot of environments.

→ More replies (1)

5

u/Julian_JmK May 22 '19 edited May 22 '19

I dont really understand, why is it better to pass getUsers({fields:['name','surname','email'],fromDate:'2019-01-01',toDate:'2019-01-18'}); ?

Edit: Thanks for the replies bois and girls i now understand, it's a pretty good way of doing it indeed

8

u/careseite [🐱😸].filter(😺 => 😺.❤️🐈).map(😺=> 😺.🤗 ? 😻 :😿) May 22 '19

because you dont need to check the implementation of getUsers to find out what the array is for, what the first date is supposed to mean or the second

you can see it right there: youre getting users, probably some properties (name, surname, email) but youre limiting the user selection to dates between 2019-01-01 and 2019-01-18. the only thing unclear for me here would be to find out whether it means "active users" or "newly registered users", or both but thats probably because its not a perfect example

1

u/Ozymandias-X May 23 '19

But then, when I want to use the function, I now get no type hints whatsoever about what information it needs to work. All I see is that it can give it a mysterious blobby object that might have fields of some kind. Never mind if I accidentally misstype one of the keys. That's a nightmare level error to find.

This can only be solved by extensive documentation of the function and we all know that such documentation often lies when people refactor or extend functions and forget to update the docs.

→ More replies (1)

5

u/Extracted May 22 '19

getFromApi("g4adf", "j43fa", false, false)

getFromApi({ userId: "g4adf", serverName: "j43fa", createIfAbsent: false, debug: false })

That's why

→ More replies (1)

3

u/zapatoada May 22 '19

I get what you're saying, but as a VS2017 user, I disagree that it's necessary. As long as you're naming your parameters reasonably, I find that using intellisense to see the parameter order makes it easier than figuring out some arbitrary object.

14

u/BloodAndTsundere May 22 '19

What you're saying isn't wrong but I'd rather have the code be explicit and clean than rely a particular editor's feature to make sense of the code. Firstly, your colleagues might not use such an editor. Secondly, you might not always have access to such an editor.

6

u/zapatoada May 22 '19

It's definitely a personal choice.

I'm a c# developer in a c# shop, so everyone has access to visual studio (and this has been the case throughout my career). Even if the company didn't pay for it, community edition and vscode are free.

And frankly, even if I didn't have that option, I usually prefer separate parameters to an object. The only real difference is extra visual noise in the object literal notation.

→ More replies (6)

2

u/[deleted] May 22 '19

I'd rather have the code be explicit and clean

Separate parameters are explicit and clean.

→ More replies (2)

3

u/fucking_passwords May 22 '19

Another reason is that three or more params starts getting really difficult to read, and if you ever need to add another param you may end up with a very ugly design.

For instance, we added a fourth param to this function that makes the third param no longer required:

someFunc(1234, true, null, false);

2

u/[deleted] May 22 '19

[removed] — view removed comment

1

u/fucking_passwords May 22 '19

I agree, but it was just an example, you could replace all of those args with integers

→ More replies (6)

2

u/[deleted] May 22 '19

because you can tell by the shape of the function call what it's probably going to do with it within the function.

Name is supposed to do that.

4

u/[deleted] May 22 '19

What a great function name, "getUsersWithFieldsWithinDateRange"

3

u/Ozymandias-X May 23 '19

Yeah, so? Characters are not a limited resource. I'd rather have a little more verbose function name than a "this might do anything" name.

2

u/[deleted] May 24 '19

Yes, it is.

1

u/dmitri14_gmail_com Jun 03 '19

I suppose it depends on the use case. You don't write [1,2,3].reduce({function: ..., value: ...})