---
docgen:
  source: npm/rules/npm-module/js/header_doc_pointer.mjs
  crc: d96a2957
  score: 100
---

# header_doc_pointer.mjs

## Огляд

Файл виконує перевірку документації для модулів. Сканує директорії npm/rules та npm/skills. Перевіряє наявність файлів docs/<stem>.md у піддиректоріях правил/скілів. Перевіряє, чи містить відповідні js-файли не більше одного рядка JSDoc. У разі перевищення ліміту, генерує звіт про порушення.

## Поведінка

1. Сканувати директорії npm/rules та npm/skills.
2. Для кожної директорії перевіряти піддиректорії правил/скілів.
3. Для кожного знайденого js-файлу перевіряти наявність файлу docs/<stem>.md.
4. Якщо файл docs/<stem>.md існує, перевіряти, чи містить module-level JSDoc не більше одного непорожного рядка.
5. У разі перевищення ліміту, зарепортувати порушення.
6. Повертати код виходу репортера.

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

- check — сканує файли `npm/rules/*/js/*.mjs` та `npm/skills/*/js/*.mjs`.
  - Якщо існує `docs/<stem>.md`, модуль повинен мати посилання на JSDoc (не наратив).
  - Якщо `docs` відсутній, обмеження не застосовуються.

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

- Read-only: файл не виконує операцій запису у файлову систему.
- Не звертається до мережі.
