naming_convention.md

A list of naming conventions based on this excelent article:
https://betterprogramming.pub/useful-tips-for-naming-your-variables-8139cc8d44b5

Naming numbers

Integer numbers

const somethingCount    // itemsCount (preferable)
const numberOfSomething // numberOfItems

No need to follow this convention for names that already represent integer numbers, such as "age" or "year".

Floating-point numbers

const somethingAmount   // moneyAmount (preferable)
const amountOfSomething // amountOfMoney

No need to follow this convention for names that already represent floating-point numbers, such as "price", "width", "height", "weight", "temperature", etc...

Tips

Add the unit variable when it is not self-evident. For example:

const tooltipShowDelayInMillis // instead of tooltipShowDelay
const temperatureInCelsius     // instead of temperature

Naming booleans

const isSomething  // isMenuOpen
const hasSomething // hasChildren

Naming string

const somethingStr // yearStr

No need to follow this convention for names that already represent strings, such as "name", "title", "label", etc...

Naming objects

const somethingObj // nameObj (name is a string, but nameObj is an object)

In general, you won't need to follow this convention, as most names already suggest whether they are objects or not. Only when it is not clear, we'd add the Obj suffix.

Naming arrays, lists, and sets

Use the plural form, like errors, tasks, clients etc.

Naming optional parameters

Use undefined or a "default value" to tell the Code Reader which parameters are "optional".

// `undefined` tells us that `isOpen` is not required
const toggleMenu = (isOpen = undefined) => {
  this.isOpen = isOpen ?? !this.isOpen
}

const printError = (text, color = 'red') => {
  // ...
}