Skip to content

Приватность ​

В ряде случаев файлы и директории нужно объявить приватными — чтобы код был недоступен вне родительской директории.

Проект задает префиксы приватных частей в конфигурации. По умолчанию используются _ и internal/:

  • имя файла или директории, начинающееся с _, приватно;
  • директория с точным именем internal и всё ее содержимое приватны.

internal.ts и internal-api/ не соответствуют соглашению internal/.

Приватные файлы и директории ​

Приватные файлы доступны только содержимому их непосредственного родителя. Например, оба пути принадлежат abc/foo:

text
abc/foo/_bar/
abc/foo/internal/bar/

Код из abc/foo/** может импортировать их, а код из abc/x/** и из самого abc/** — нет. То же правило действует для файлов:

text
abc/foo/_helpers.ts
abc/foo/internal.ts

Первый файл приватен из-за _; второй не является приватным из-за соглашения internal/.

Приватные границы вкладываются. В пути abc/foo/_area/internal/value.ts граница _area закрывает всю директорию от кода вне abc/foo, а граница internal дополнительно оставляет value.ts доступным только внутри abc/foo/_area.

Владелец может опубликовать часть реализации через свой баррель:

ts
// abc/foo/index.ts
export { createThing } from './internal/create-thing';

Внешний код тогда импортирует createThing из abc/foo, но не получает права импортировать abc/foo/internal/create-thing напрямую.

Приватные дочерние модули ​

Для дочернего модуля приватность относится к модульной границе, а не к технической директории modules. Приватными дочерними модулями foo являются:

text
modules/foo/modules/_bar
modules/foo/modules/internal/bar

Такой модуль доступен коду самого foo и его прямым дочерним модулям. Доступа нет у модулей вне foo и у модулей, вложенных глубже прямого ребенка:

text
modules/foo/modules/a                 # может импортировать _bar
modules/foo/modules/a/modules/b       # не может импортировать _bar
modules/other                         # не может импортировать _bar

Внутри приватного модуля сохраняются остальные границы: его баррель определяет публичную поверхность для разрешенных потребителей, а его собственные _ и internal/ закрывают внутренние части еще сильнее. Родитель foo может реэкспортировать выбранный API приватного модуля через свой баррель; это не делает путь приватного модуля доступным извне.