WIP - JavaScript style guide

[sindresorhus]

At some point I want to make a JS style guide. For now, this is just a braindump.

---

Prioritize readable code

That means using readable variable and function names. No abbreviations.

For example, use const error instead of const err.

More here: https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/docs/rules/prevent-abbreviations.md

Make boolean variables obvious

Boolean variables should use is, has, can, will, or did prefix.

For example:

• .visible → .isVisible
• .rainbow → .hasRainbow

Hopefully, there can be a lint rule for this: typescript-eslint/typescript-eslint#515

Only accept an Iterable if it's used directly

Functions should only accept an Iterable if it can actually take advantage of it. If it only does [...iterable] internally, it should just accept an array. Users can always use the spread syntax at callsite if they have an Iterable. The problem with accepting an Iterable when you're not actually not taking advantage of the iterator interface is:

• It's wasteful.
• String's are Iterable, which can cause weird issues where a user accidentally passes in a string and your function uses each character in the string.

More info