Для многих в разработке программ самыми большими проблемами являются (а) их сложность и (б) изменчивость требований. Решение обеих проблем — в декомпозиции целого приложения на более мелкие части (пакеты, модули, классы и функции). Декомпозиция для уменьшения сложности в целом достаточно проста (закон Миллера). Но нужно не просто разбить приложение на части, а сделать эти части устойчивыми к изменениям требований. В этой публикации я пытаюсь поразмышлять на следующие вопросы: из каких элементов состоит JavaScript-код? каким образом эти элементы взаимодействуют друг с другом? можно ли как-то повысить устойчивость кода к изменениям? В зависимости от уровня детализации в JavaScript можно выделить следующие группы кода: Первые три (объекты, функции, классы) — это базовые элементы. Они могут взаимодействовать друг с другом. Вторые два (es-модули и npm-пакеты) — составные объекты. Они взаимодействуют друг с другом на уровне базовых элементов, входящих в их состав. Для каждого типа элементов кода существует свой интерфейс взаимодействия с ним — каким образом внешний код может использовать код элемента: При разработке приложения “снизу-вверх” мы создаём сначала базовые элементы кода (объекты, функции, классы), а затем объединяем их в более крупные образования. Базовые элементы кода могут состоять из других базовых элементов (функция внутри функции, например), es-модули — из базовых элементов, npm-пакеты — из es-модулей. При разработке “сверху-вниз” мы движемся в обратном направлении — от пакетов к базовым элементам. Для оценки качества декомпозиции используют такие понятия, как “связность” (cohesion) и “зацепление” (coupling):  Т.е., идеальным (и бесполезным!) вариантом является тот, когда все элементы кода внутри одной группы связаны только друг с другом (высокая связность) и не имеют связей с элементами кода других групп (отсутствует зацепление). На практике, разумеется, такой вариант не встречается вовсе, но зато он даёт ориентир: связность элементов в отдельном элементе кода должна быть как можно выше, а зацепление между различными элементами — как можно меньше. Для того, чтобы один элемент кода мог использовать другой элемент, нужно каким-то образом адресовать этот "другой элемент". В JS существуют анонимные функции, но они, как правило, применяются "по месту" и не участвуют, как правило, в межмодульном зацеплении. Я рассматриваю JS в варианте ES2015+, где базовым “кирпичом” в построении приложений является es-модуль, основанный на механизме экспорта-импорта. Если смотреть на ES2015+ приложение с точки зрения браузера, то оно состоит из es-модулей, полученных с внешних серверов и размещённых в иерархии, напоминающей файловую структуру:  С точки зрения nodejs все es-модули находятся в обычной файловой структуре — файлы модулей находятся в npm-пакетах, а пакеты находятся в каталоге ./node_modules/:  Адрес элемента кода на уровне приложения состоит из двух частей: Пример абсолютной адресации: Адресация относительно местоположения текущего модуля: В nodejs-приложениях возможна также адресация относительно каталога ./node_modules/: Таким образом, основным элементом кода в JS-приложениях является es-модуль, который может входить в состав npm-пакета (в nodejs-приложениях) и может включать в себя базовые элементы кода (объекты, функции, классы) в качестве экспорта:  Получается, что на уровне приложения выстраиваются связи между базовыми элементами кода, экспортируемыми es-модулями (экспортами):  Структуру адреса такого базового элемента, доступного в рамках целого приложения, можно отобразить так: Использование export default в некотором роде отвязывает потребителя кода от его поставщика. Сравните два варианта экспорта: И соответствующего ему импорта: В первом случае потребитель кода не привязан к имени экспорта внутри поставщика кода, но при этом поставщик ограничен всего одним экспортируемым объектом. Внутри отдельного es-модуля адресация базовых элементов кода требует только, чтобы в пределах одной области видимости (scope) имена элементов были уникальны. Во вложенных областях видимости есть риск перекрытия имён используемых элементов (например, obj): Адресация пакетов актуальна только для nodejs-приложений и является частью адресации es-модулей. Каждый элемент кода, помимо своего адреса (имени), обладает также некоторым интерфейсом, который определяет способы “зацепления” с ним других элементов кода. Для JS-объекта интерфейсом взаимодействия внешнего кода с объектом являются имена свойств: “Классический” вариант предполагает, что функция определяется своим именем, входными аргументами (кол-во, порядок, тип) и типом возвращаемого результата: Я как-то уже размышлял на тему, что было бы, если бы у функции был только один входной параметр и один выходной: JS с его деструктирующим присваиванием вплотную подошёл к этому варианту: Использование переменной arguments для анализа входных аргументов и остаточных параметров я отношу к промежуточным вариантам (между одним входным аргументом и “классической” формой). Классы совмещают в себе структуру обрабатываемых данных и методы, которыми эти данные обрабатываются. В ООП классы зачастую являются теми самыми элементами кода, отношение между которыми оцениваются на предмет связности и зацепления. Во многих языках программировании рядом с классами стоят интерфейсы, но JS в их список не входит (хотя на уровне JSDoc’ов такое понятие присутствует). Интерфейс класса в JS, как и в других ЯП, определяется именем класса, именами доступных свойств и методов, входными/выходными аргументами методов. Интерфейс взаимодействия с es-модулем определяется его export-объектом (упоминался выше, когда обсуждалась адресация элементов в es-модуле). Пакет является самым верхним уровнем группировки кода, самым крупным “кирпичом” в приложении. Основа для взаимодействия пакетов — имя пакета и его версия, которые прописываются в npm-дескрипторе приложения (./package.json): Имя npm-пакета участвует в адресации es-модулей в nodejs-приложениях. В пакете может быть определён входной объект, в его ./package.json: Таким образом, на уровне пакетов интерфейсом является имя пакета, его версия, входной объект и структура es-модулей внутри пакета. Для всех типов элементов кода, за исключением разве что объектов, можно выделить публичный и приватный код. Всё, что касается интерфейсной части элемента кода (функции, класса, es-модуля, npm-пакета), является публичной частью, всё остальное — приватной. Изменения в приватной части объекта кода никак не отражаются за границами элемента кода (функции, класса, …), в отличие от изменений в его публичной части. Понятно, что чем больше кода будет находиться в приватной части, тем более устойчивым к изменениям будет код. Но мы вынуждены часть кода делать публичным для связи различных частей приложения, получая зацепление на разных уровнях. Вот так выглядят приватные области кода на уровне функций: Функция nested не видна за пределами producer и мы можем спокойно её менять в рамках функции producer. В классе могут быть определены приватные члены (свойства и методы) на уровне прототипа класса, а также переменные и функции ограниченного доступа на уровне экземпляра класса (в конструкторе): privProp и nestedObj являются внутренними элементами кода для класса SomeClass и недоступны извне напрямую. В es-модуле всё, что не является предметом экспорта, является приватным кодом. В пакетах предусмотрено “джентльменское соглашение”, что основная точка входа в пакет объявляется в дескрипторе пакета (package.json), в узле main (по-умолчанию используется ./index.js): Тогда для импорта основной точки входа достаточно написать: Остальные элементы кода пакета можно сделать доступными по цепочке через основную точку входа, в которой можно подключить остальные пакеты: и использовать их во внешнем коде: Но это именно “джентльменское соглашение” — ничто не мешает разработчику другого npm-пакета обратиться внутрь нашего npm-пакета к любому es-модулю напрямую. Код в целом устойчив к добавлению (свойств, аргументов, методов), менее устойчив к их удалению и совсем не устойчив к переименованию. При добавлении к объекту новых свойств существующие “потребители” никак не затрагиваются. При удалении какого-либо свойства и обращении к нему извне возвращается undefined (и это может быть обработано пользователем кода). Переименование свойства объекта приводит к необходимости изменения всего кода, завязанного на данное свойство (как следствие, вместо переименования свойства/функции/… можно использовать добавление нового, с аналогичным функционалом, а затем, через какое-то время, удаление старого). Наименование элементов кода (npm-пакеты, классы, функции, объекты) и их размещение (es-модули) особенно важно с точки зрения устойчивости, т.к. изменение имён впоследствие может привести к массовому рефакторингу или сделает невозможным использование нашего кода внешними “потребителями”.
Чем крупнее элемент кода (пакет, модуль, класс/функция), тем важнее стабильность его имени для стабильности всего кода. Использование алиасов при использовании внешних элементов кода позволяют замкнуть текущий контекст (модуль или пакет) на алиас, что несколько уменьшает зацепление: Функции с одним входным аргументом более устойчивы к изменениям, но функции со списком аргументов более дружелюбны к разработчику и IDE. Для кода, который будет изменяться в будущем лучше использовать деструктирующее присваивание для входных/выходных аргументов в функциях и методах (y = f(x)). Функции со списком входных аргументов (y = f(a, b, c)) лучше употреблять в приватных частях элементов кода, т.к. у них ограниченная видимость и, в случае чего, рефакторинг не выйдет за рамки этой видимости. JS предоставляет разработчику возможность делать часть кода недоступной для внешнего использования (вне контекста функции, класса, пакета) и этим нужно пользоваться максимально широко, чтобы приложение было более устойчиво к изменениям. На каждом уровне (функция, класс, модуль, пакет) нужно видеть и отделять публичный интерфейс элемента кода от его приватной имплементации, а также осознавать область доступности соответствующего публичного интерфейса.  “Джентльменское соглашение” по поводу “публичной” и “приватной” частей пакета можно использовать не только в виде primary entry point, но и на уровне naming/placing-соглашений (например, как это сделано в Magento, определить, что все модули из каталога ./src/Api/ являются публичными модулями пакета, а все остальные — приватные). wiredgeese.com