# docgen-ignore.mjs

## Огляд

Цей файл містить список глобальних файлів, які `docgen` ігнорує під час генерації документації. Він використовується для визначення, які файли не потрібно аналізувати, забезпечуючи ефективність процесу генерації та запобігаючи включенню нерелевантної інформації. Цей список є основою для predicate, який scanner використовує для визначення, чи потрібно читати певний файл.

## Поведінка

DOCGEN_IGNORE_GLOBS: визначає список глобів, які `docgen` ігнорує.
isDocgenIgnored: перевіряє, чи шлях має бути пропущений `docgen`, використовуючи глоби.

## Публічний API

- DOCGEN_IGNORE_GLOBS — Список glob-ів, які ігнорує `docgen`.
- isDocgenIgnored — Перевіряє, чи потрібно пропустити шлях під час генерації документації.

## Гарантії поведінки

- `DOCGEN_IGNORE_GLOBS` завжди ігнорує певний набір шляхів.
- `isDocgenIgnored` повертає `true` якщо шлях ігнорується.
- Шляхи `.git` та `node_modules` завжди ігноруються.
- Файл є read-only.
- У разі невдачі повертає `false` або `null`.
- Результат прогону кешується для подальшого використання.
