PHPackages                             batboat/documentor - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. batboat/documentor

ActiveLibrary[Utility & Helpers](/categories/utility)

batboat/documentor
==================

Samler og genererer dokumentation fra PHP-filer via artisan-kommando

03PHP

Since Jun 29Pushed 6mo agoCompare

[ Source](https://github.com/batboat/laravel_documentor)[ Packagist](https://packagist.org/packages/batboat/documentor)[ RSS](/packages/batboat-documentor/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (2)Used By (0)

Batboat Documentor
==================

[](#batboat-documentor)

En simpel Laravel-pakke til automatisk at samle og generere dokumentation fra dine PHP-filer via en Artisan-kommando.

---

Hvad kan den?
-------------

[](#hvad-kan-den)

- **Scanner** ét eller flere biblioteker/projekter efter PHP-filer og ekstrakterer deres fulde kildekode.
- **Ekskluderer** automatisk mapper som `.git` (og andre “typer” du definerer) ved hjælp af en fleksibel type-baseret filtermekanisme.
- **Understøtter flere profiler** i samme konfiguration (f.eks. én profil pr. pakke eller gruppe af filer).
- **Genererer output** i valgfri formater (TXT, MD osv.) inkl. en valgfri indholdsfortegnelse over alle fundne filer.
- **Debug-mode** giver detaljeret indsigt i, hvilke filer og mapper der scannes og ekskluderes.

---

Installation
------------

[](#installation)

1. Tilføj pakken via Composer:

    ```
    composer require batboat/documentor
    ```
2. (Valgfrit) Publicér konfigurationsfilen, hvis du vil tilpasse indstillingerne:

    ```
    php artisan vendor:publish --provider="Batboat\Documentor\DocumentorServiceProvider" --tag=config
    ```
3. Rediger `config/batboat/documentor.yml` efter dine behov.

---

Konfiguration (`config/batboat/documentor.yml`)
-----------------------------------------------

[](#konfiguration-configbatboatdocumentoryml)

```
basic:
  # Mappenavn under storage_path() hvor dokumentationsfiler gemmes
  path: documentor

  # Aktiver debug-udskrifter i konsollen
  debug: true

  # Globale exclude-typer: hver type håndteres via ExcludeTypeProcessor
  exclude:
    types:
      git: true   # true/false; udelukker alle .git-mapper

profiles:  # Dokumentations-profiler
  package_batboat_documentor:
    include:
      - packages/batboat/documentor   # Mapper/filer der skal dokumenteres
    exclude: []                      # Specifikke stier der skal udelukkes (ud over typer)
    output:
      - txt                          # Output-format(er): txt, md osv.
    options:
      files_index: true              # Medtag en oversigt over alle fundne filer

  package_batboat_artisan-menu-collector:
    include:
      - packages/batboat/artisan-menu-collector
    exclude: []
    output:
      - txt
    options:
      files_index: true

  package_batboat_all:
    include:
      - packages/batboat/artisan-menu-collector
      - packages/batboat/documentor
    exclude: []
    output:
      - txt
    options:
      files_index: true
```

### Forklaring af sektioner

[](#forklaring-af-sektioner)

- `basic.path`Angiver hvor de genererede dokumentationsfiler gemmes (under Laravel `storage_path()`).
- `basic.debug`Når `true`, aktiveres detaljeret debug-udskrift, så du kan se præcis, hvad der scannes og ekskluderes.
- `basic.exclude.types`En liste af typer—hvert nøglenavn svarer til en `handleType`-metode i `ExcludeTypeProcessor`. F.eks. `git: true` udelukker `.git`.
- `profiles`Undersektion for hver dokumentationsprofil:

    - `include`: Array af fil- eller mappestier, der skal scannes.
    - `exclude`: Liste af specifikke stier (relativt til projektrod) der skal udelukkes ud over dem, der defineres på typeniveau.
    - `output`: Hvilke filformater (f.eks. `txt`, `md`) der skal genereres.
    - `options.files_index`: Hvis `true`, indsætter en oversigt over alle scannede filer i toppen af dokumentationen.

---

Brug
----

[](#brug)

Kør kommandoen:

```
php artisan documentor
```

Resultatet gemmes som `.` i den mappe, du har angivet under `basic.path`.

---

Intern struktur
---------------

[](#intern-struktur)

- **Commands/GenerateDocumentationCommand.php**Hovedkommandoen, som læser konfiguration, scanner filer ved hjælp af en `RecursiveCallbackFilterIterator` og genererer output.
- **Excludes/ExcludeTypeProcessor.php**Indeholder logik til at tilføje type-baserede eksklusioner (f.eks. `.git`).
- **DocumentorServiceProvider.php**Loader YAML-konfiguration og registrerer Artisan-kommandoen.
- **config/batboat/documentor.yml**Din hovedkonfigurationsfil med profiler og globale indstillinger.
- **config/batboat/example.yml**Eksempelfil til inspiration med ekstra profiler og formater.

---

Tips og udvidelser
------------------

[](#tips-og-udvidelser)

- Tilføj flere typer i `ExcludeTypeProcessor` (fx `node_modules`, `vendor`).
- Understøt HTML-, JSON- eller PDF-output ved at udvide output-logikken.
- Integrer i din CI/CD-pipeline for automatisk generering af dokumentation på hver build.

---

Med **Batboat Documentor** får du et hurtigt overblik over din PHP-kildekode i ren tekst eller markdown—ideelt til intern dokumentation og kodegennem

###  Health Score

19

—

LowBetter than 9% of packages

Maintenance47

Moderate activity, may be stable

Popularity3

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity17

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/122205177?v=4)[batboat](/maintainers/batboat)[@batboat](https://github.com/batboat)

---

Top Contributors

[![batboat](https://avatars.githubusercontent.com/u/122205177?v=4)](https://github.com/batboat "batboat (6 commits)")

### Embed Badge

![Health badge](/badges/batboat-documentor/health.svg)

```
[![Health](https://phpackages.com/badges/batboat-documentor/health.svg)](https://phpackages.com/packages/batboat-documentor)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)