docfy coverage

Mierzy, jaki procent Twoich endpointów jest udokumentowany. Przydatne jako obiektywna metryka jakości i jako bramka w CI.

Użycie

bash
npx nestjs-docfy coverage [options]

Opcje

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--format <format>tsFormat pliku docs do wyszukania: ts albo js
--min <percent>noneMinimalne wymagane pokrycie (0-100), kończy się kodem 1, jeśli jest niższe
--jsonfalseZwraca pojedynczy obiekt JSON zamiast sformatowanego tekstu: raport pokrycia plus min i passed.
--quietfalseSuppress all output except errors

Przykładowy wynik

text
Controllers: 42
Endpoints: 187

Documented: 174
Missing docs: 13

Coverage: 93.0%

Wymuszanie minimum w CI

bash
npx nestjs-docfy coverage --min 95

Gdy pokrycie spadnie poniżej --min, komenda kończy się kodem 1, co przerywa build.

.github/workflows/*.yml
# GitHub Actions example
- name: Enforce documentation coverage
  run: npx nestjs-docfy coverage --min 95

Albo jako skrypt npm:

json
{
  "scripts": {
    "docs:coverage": "nestjs-docfy coverage --min 95"
  }
}

Bot PR

Własny workflow nest-docfy, .github/workflows/pr-check.yml, jest realnym przykładem: uruchamia check --json i coverage --json --min na projekcie przy każdym PR i zamieszcza (aktualizując, nigdy nie spamując) jeden zbiorczy komentarz, zbudowany wyłącznie na wyjściu --json i natywnym fetch względem REST API GitHuba, bez dodatkowych zależności.