Preskočiť na obsah

Stav

Zobraziť ako Markdown Upraviť na GitHub Dokumentácia na bfe242f

Pitmaster vypočíta stav pracovného stromu porovnaním troch stavov: stromu commitu HEAD, indexu (oblasti prípravy) a pracovného stromu (skutočných súborov na disku). CLI z neho vytlačí súhrn v štýle git status a statusPorcelainV2() vytlačí porcelánový formát git v2.

Základné používanie

PHP
$entries = $repo->status();

foreach ($entries as $entry) {
    echo $entry->shortFormat() . "\n";
}

shortFormat() vytlačí krátky formát git:

Kód
M  src/Modified.php          (staged modification)
 M src/WorktreeModified.php  (unstaged modification)
A  src/NewFile.php           (staged new file)
 D src/Deleted.php           (deleted in worktree)
?? untracked.txt             (untracked file)

StatusEntry

Stav každého súboru predstavuje StatusEntry:

PHP
use Pitmaster\Status\StatusEntry;

$entry->path;       // File path relative to repo root
$entry->index;      // FileStatus: HEAD-to-index state
$entry->worktree;   // FileStatus: index-to-worktree state
$entry->origPath;   // Original path for renamed entries, otherwise null
$entry->renameScore; // Similarity score for renamed entries, otherwise null
$entry->shortFormat(); // "XY path", "?? path", or "R  old -> new"

Výčet FileStatus

PHP
use Pitmaster\Status\FileStatus;

FileStatus::Added;      // 'A' - new file
FileStatus::Modified;   // 'M' - content changed
FileStatus::Deleted;    // 'D' - file removed
FileStatus::Renamed;    // 'R' - file renamed
FileStatus::Copied;     // 'C' - file copied
FileStatus::Unmerged;   // 'U' - unresolved merge conflict
FileStatus::Untracked;  // '?' - not in index
FileStatus::Ignored;    // '!' - matched by .gitignore
FileStatus::Unmodified; // ' ' - no change

status() neuvádza ignorované súbory, preto sa Ignored vo výsledku nezobrazí.

Výstup Porcelain v2

Na výstup stavu v strojovo čitateľnom formáte zodpovedajúcom git status --porcelain=v2:

PHP
echo $repo->statusPorcelainV2();

Výstup:

Kód
1 .M N... 100644 100644 100644 ce013625030ba8dba906f756967f9e9ca394464a ce013625030ba8dba906f756967f9e9ca394464a modified-file.txt
? untracked-file.txt

Najprv sa uvádzajú sledované položky a potom nesledované. Premenovania používajú riadky 2 a konflikty riadky u. Hlavičky # branch v git status --porcelain=v2 --branch sa nevypisujú a ignorované súbory sa neuvádzajú.

Ako sa vypočítava stav

Trieda WorkingTreeStatus vykonáva porovnanie troch stavov:

PHP
use Pitmaster\Status\WorkingTreeStatus;

$status = new WorkingTreeStatus($repo->objectDatabase(), $repo->workDir(), $repo->gitDir());
$entries = $status->compute($repo->index(), $repo->resolve('HEAD'));

Krok 1: Vytvorenie mapy stromu HEAD

Rozložte strom commitu HEAD na mapu path => blob hash. Predstavuje posledný commitnutý stav.

Krok 2: Porovnanie HEAD s indexom

Pre každý súbor v strome HEAD a v indexe:

  • V HEAD, ale nie v indexe: Deleted v stĺpci indexu
  • V indexe, ale nie v HEAD: Added v stĺpci indexu
  • V oboch, ale s odlišným hashom: Modified v stĺpci indexu
  • V oboch s rovnakým hashom: Unmodified v stĺpci indexu

Krok 3: Porovnanie indexu s pracovným stromom

Pre každý súbor v indexe a pracovnom strome:

  • V indexe, ale nie na disku: Deleted v stĺpci pracovného stromu
  • V oboch, ale obsah sa líši: Modified v stĺpci pracovného stromu
  • V oboch s rovnakým obsahom: Unmodified v stĺpci pracovného stromu

Krok 4: Zistenie nesledovaných súborov

Prejdite adresár pracovného stromu, preskočte .git/ a ignorované cesty a nahláste súbory, ktoré nie sú v indexe, ako Untracked v oboch stĺpcoch.

Podpora .gitignore

Pitmaster parsuje súbory .gitignore, aby určil, ktoré nesledované súbory sa majú označiť ako ignorované a ktoré ako nesledované.

PHP
use Pitmaster\Status\GitIgnore;

Trieda GitIgnore parsuje vzory gitignore z týchto miest:

  • .gitignore v koreňovom adresári repozitára
  • .gitignore v podadresároch
  • .git/info/exclude

Podporovaná syntax vzorov:

  • Vzory glob (*.log, build/)
  • Negácia (!important.log)
  • Vzory platné iba pre adresáre (koncové /)
  • Počiatočné / pre vzory relatívne ku koreňovému adresáru
  • ** pre rekurzívne párovanie

Kategorizácia položiek stavu

Bežný vzor na zobrazenie UI:

PHP
$staged = [];
$unstaged = [];
$untracked = [];

foreach ($repo->status() as $entry) {
    if ($entry->index === FileStatus::Untracked) {
        $untracked[] = $entry;
    } elseif ($entry->index !== FileStatus::Unmodified) {
        $staged[] = $entry;
    }

    if ($entry->worktree !== FileStatus::Unmodified
        && $entry->index !== FileStatus::Untracked
    ) {
        $unstaged[] = $entry;
    }
}

Používanie CLI

Shell
./vendor/bin/pitmaster status

Výstup:

Kód
On branch main

Changes to be committed:
	new file:   src/Feature.php

Changes not staged for commit:
	modified:   src/Existing.php

Untracked files:
	notes.txt

Fsmonitor

Pitmaster obsahuje pomocníka pre protokol fsmonitor nástroja git:

PHP
use Pitmaster\Status\Fsmonitor;

Trieda Fsmonitor môže zistiť z hooku core.fsmonitor, ktoré súbory sa zmenili od zadania tokenu (pri nedostupnosti vykoná kontrolu časov poslednej zmeny). Pri handle otvorenom pomocou ['processes' => false] túto funkciu vypne. status() ju momentálne nevolá; porovnáva priamo údaje stat a obsah.