Állapot

Az Pitmaster a három állapot összehasonlításával számítja ki a munkafa állapotát: a HEAD commit fáját, az indexet (előkészítési területet) és a munkafát (a lemezen lévő tényleges fájlokat). Az CLI ebből git status stílusú összefoglalót ír ki, az statusPorcelainV2() pedig a git porcelán v2 formátumát jeleníti meg.

Alapvető használat

$entries = $repo->status();

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

Az shortFormat() a git rövid formátumát írja ki:

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

Minden fájl állapotát egy StatusEntry jelöli:

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"

FileStatus felsorolás

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

Az status() nem jelenti a figyelmen kívül hagyott fájlokat, ezért az Ignored nem szerepel az eredményében.

Porcelán v2 kimenet

Az git status --porcelain=v2-vel egyező, géppel olvasható állapotkimenethez:

echo $repo->statusPorcelainV2();

Kimenet:

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

Először a követett, majd a nem követett bejegyzések jelennek meg. Az átnevezésekhez 2 sorok, az ütközésekhez u sorok tartoznak. Az git status --porcelain=v2 --branch # branch fejlécei nem jelennek meg, a figyelmen kívül hagyott fájlok pedig nem szerepelnek a listában.

Az állapot kiszámítása

Az WorkingTreeStatus osztály végzi a háromutas összehasonlítást:

use Pitmaster\Status\WorkingTreeStatus;

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

1. lépés: A HEAD fátérképének felépítése

A HEAD commit fáját path => blob hash elemek térképévé lapítja. Ez jelöli a legutóbb véglegesített állapotot.

2. lépés: A HEAD és az index összehasonlítása

A HEAD fájának és az indexnek minden fájljára:

• A HEAD-ben szerepel, az indexben nem: Deleted az index oszlopában
• Az indexben szerepel, a HEAD-ben nem: Added az index oszlopában
• Mindkettőben szerepel, de eltérő hash-sel: Modified az index oszlopában
• Mindkettőben szerepel, azonos hash-sel: Unmodified az index oszlopában

3. lépés: Az index és a munkafa összehasonlítása

Az index és a munkafa minden fájljára:

• Az indexben szerepel, a lemezen nem: Deleted a munkafa oszlopában
• Mindkettőben szerepel, de a tartalom eltér: Modified a munkafa oszlopában
• Mindkettőben szerepel, és a tartalom megegyezik: Unmodified a munkafa oszlopában

4. lépés: Nem követett fájlok észlelése

Bejárja a munkafa könyvtárát, kihagyja az .git/ elemet és a figyelmen kívül hagyott útvonalakat, majd Untracked értékként jelenti azokat a fájlokat mindkét oszlopban, amelyek nem szerepelnek az indexben.

.gitignore támogatása

A Pitmaster elemzi a .gitignore fájlokat, hogy megállapítsa, mely nem követett fájlokat kell figyelmen kívül hagyottként, illetve nem követettként jelenteni.

use Pitmaster\Status\GitIgnore;

Az GitIgnore osztály a gitignore-mintákat a következő helyekről olvassa be:

• .gitignore a tároló gyökérkönyvtárában
• .gitignore az alkönyvtárakban
• .git/info/exclude

Támogatott mintaszintaxis:

• Globminták (*.log, build/)
• Tagadás (!important.log)
• Csak könyvtárakra illeszkedő minták (záró /)
• Kezdő / a gyökérhez viszonyított mintákhoz
• ** rekurzív illesztéshez

Állapotbejegyzések kategorizálása

Gyakori minta az UI megjelenítésére:

$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;
    }
}

CLI használata

./vendor/bin/pitmaster status

Kimenet:

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

Az Pitmaster tartalmaz egy segédeszközt a git fsmonitor protokolljához:

use Pitmaster\Status\Fsmonitor;

Az Fsmonitor osztály lekérdezheti az core.fsmonitor hookot (visszaesve a módosításiidő-alapú vizsgálatra), hogy megtudja, mely fájlok változtak egy token óta. Kikapcsolja magát az ['processes' => false] értékkel megnyitott fogantyúknál. Az status() jelenleg nem hívja meg; közvetlenül a stat adatokat és a tartalmat hasonlítja össze.