Preskoči na vsebino

Stanje

Prikaži kot Markdown Uredi na GitHub Dokumentacija za bfe242f

Pitmaster izračuna stanje delovnega drevesa s primerjavo treh stanj: drevesa commita HEAD, indeksa (območja priprave) in delovnega drevesa (dejanskih datotek na disku). CLI izpiše povzetek v slogu git status, statusPorcelainV2() pa izpiše zapisniško obliko git v2.

Osnovna uporaba

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

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

shortFormat() izpiše kratko obliko ukaza git:

Koda
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

Stanje vsake datoteke je predstavljeno z 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"

Naštevanje 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() ne poroča o prezrtih datotekah, zato se Ignored ne pojavi v njegovem rezultatu.

Izhod Porcelain v2

Za strojno berljiv izhod stanja, ki ustreza git status --porcelain=v2:

PHP
echo $repo->statusPorcelainV2();

Izhod:

Koda
1 .M N... 100644 100644 100644 ce013625030ba8dba906f756967f9e9ca394464a ce013625030ba8dba906f756967f9e9ca394464a modified-file.txt
? untracked-file.txt

Najprej so navedeni sledenji vnosi, nato nesledenji. Pri preimenovanjih se uporabijo vrstice 2, pri sporih pa vrstice u. Glave # branch za git status --porcelain=v2 --branch niso izpisane, prezrte datoteke pa niso navedene.

Kako se izračuna stanje

Razred WorkingTreeStatus izvede primerjavo treh strani:

PHP
use Pitmaster\Status\WorkingTreeStatus;

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

1. korak: Izdelava zemljevida drevesa HEAD

Drevo potrditve HEAD sploščite v zemljevid path => blob hash. Ta predstavlja zadnje potrjeno stanje.

2. korak: Primerjava HEAD z indeksom

Za vsako datoteko v drevesu HEAD in indeksu:

  • V HEAD, ne pa v indeksu: Deleted v stolpcu indeksa
  • V indeksu, ne pa v HEAD: Added v stolpcu indeksa
  • V obeh, vendar z različno zgoščeno vrednostjo: Modified v stolpcu indeksa
  • V obeh z enako zgoščeno vrednostjo: Unmodified v stolpcu indeksa

3. korak: Primerjava indeksa z delovnim drevesom

Za vsako datoteko v indeksu in delovnem drevesu:

  • V indeksu, ne pa na disku: Deleted v stolpcu delovnega drevesa
  • V obeh, vendar se vsebina razlikuje: Modified v stolpcu delovnega drevesa
  • V obeh z ujemajočo se vsebino: Unmodified v stolpcu delovnega drevesa

4. korak: Zaznavanje nesledenih datotek

Preglejte imenik delovnega drevesa, preskočite .git/ in prezrte poti ter datoteke, ki jih ni v indeksu, v obeh stolpcih označite kot Untracked.

Podpora za .gitignore

Pitmaster razčleni datoteke .gitignore, da določi, katere nesledene datoteke naj bodo označene kot prezrte in katere kot nesledene.

PHP
use Pitmaster\Status\GitIgnore;

Razred GitIgnore razčleni vzorce gitignore iz:

  • .gitignore v korenu repozitorija
  • .gitignore v podimenikih
  • .git/info/exclude

Podprta sintaksa vzorcev:

  • Vzorci glob (*.log, build/)
  • Negacija (!important.log)
  • Vzorci samo za imenike (končni /)
  • Začetni / za vzorce glede na koren
  • ** za rekurzivno ujemanje

Razvrščanje vnosov stanja

Pogost vzorec za prikaz 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;
    }
}

Uporaba CLI

Lupina
./vendor/bin/pitmaster status

Izhod:

Koda
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 vključuje pomožno funkcijo za protokol fsmonitor orodja git:

PHP
use Pitmaster\Status\Fsmonitor;

Razred Fsmonitor lahko poizveduje po priklopu core.fsmonitor (ob neuspehu pregleda čase spreminjanja), da ugotovi, katere datoteke so se spremenile po določenem žetonu. Pri ročajih, odprtih z ['processes' => false], se izklopi. status() ga trenutno ne kliče; podatke stat in vsebino primerja neposredno.