Я мог предположить, что наиболее распространенная ошибка в JS связана с неправильной интерпретацией типа. Это происходит потому, что простые объекты JS гораздо более распространены, чем альтернатива классам.

Но подождите, а как насчет проверки типов: машинописный текст, поток. Они классные, но в большинстве случаев это перебор. Чтобы использовать их, вам нужны дополнительные зависимости, код должен быть скомпилирован или каким-то образом изменен, чтобы он стал исполняемым, они требуют дополнительного времени на настройку. Для более крупных проектов было бы неплохо потратить больше времени на все эти потери, но есть много ситуаций, когда лучше оставить код простым.

Решение

Я предлагаю как можно больше использовать JSDoc.

Плюсы

  • Встроенная поддержка в популярных IDE и редакторах кода.
  • Широко используемый
  • Никаких лишних зависимостей

Минусы

  • Синтаксис немного странный

Пример

Давайте поговорим о примере.

Скажем, у нас есть некоторая асинхронная операция, а затем мы передаем вложенное свойство другим вызовам. Очень частая ситуация. Схема объекта могла быть сложной. Если это так, это может привести к ошибкам или многочисленным ручным проверкам документов.

Давайте добавим к нему набор текста.

Я использую VSCode с конфигурацией по умолчанию, без расширений. Вот что я вижу с автоматическим предложением редактора по умолчанию

Мои другие статьи JSDoc: