Pereiti prie turinio

Būsena

Peržiūrėti kaip Markdown Redaguoti per GitHub Dokumentacija: bfe242f

Pitmaster apskaičiuoja darbinio medžio būseną palygindamas tris būsenas: HEAD įrašo medį, indeksą (parengimo sritį) ir darbinį medį (tikruosius diske esančius failus). CLI pateikia git status tipo suvestinę, o statusPorcelainV2() pateikia git porcelain v2 formatą.

Pagrindinis naudojimas

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

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

shortFormat() pateikia trumpą git formatą:

Kodas
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

Kiekvieno failo būsena žymima simboliu 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"

FileStatus išvardijimas

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() nepateikia ignoruojamų failų, todėl Ignored jo rezultatuose nėra.

Porcelain v2 išvestis

Kompiuterio apdorojamai būsenos išvesčiai, atitinkančiai git status --porcelain=v2:

PHP
echo $repo->statusPorcelainV2();

Išvestis:

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

Pirmiausia pateikiami sekami įrašai, tada nesekami. Pervadinimai žymimi 2 eilutėmis, o konfliktai – u eilutėmis. git status --porcelain=v2 --branch # branch antraštės nespausdinamos, ignoruojami failai nepateikiami.

Kaip apskaičiuojama būsena

WorkingTreeStatus klasė atlieka trijų krypčių palyginimą:

PHP
use Pitmaster\Status\WorkingTreeStatus;

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

1 veiksmas: sudaryti HEAD medžio žemėlapį

HEAD įrašo medis išlyginamas į path => blob hash žemėlapį. Jis atspindi paskutinę užfiksuotą būseną.

2 veiksmas: palyginti HEAD su indeksu

Kiekvienam failui HEAD medyje ir indekse:

  • Yra HEAD, bet nėra indekse: Deleted indekso stulpelyje
  • Yra indekse, bet nėra HEAD: Added indekso stulpelyje
  • Yra abiejuose, bet maiša skiriasi: Modified indekso stulpelyje
  • Yra abiejuose, maišos sutampa: Unmodified indekso stulpelyje

3 veiksmas: palyginti indeksą su darbiniu medžiu

Kiekvienam failui indekse ir darbiniame medyje:

  • Yra indekse, bet nėra diske: Deleted darbinio medžio stulpelyje
  • Yra abiejuose, bet turinys skiriasi: Modified darbinio medžio stulpelyje
  • Yra abiejuose, turinys sutampa: Unmodified darbinio medžio stulpelyje

4 veiksmas: aptikti nesekamus failus

Peržiūrėkite darbinio medžio katalogą, praleiskite .git/ ir ignoruojamus kelius, o indekse nesančius failus abiejuose stulpeliuose pažymėkite kaip Untracked.

.gitignore palaikymas

Pitmaster analizuoja .gitignore failus, kad nustatytų, kuriuos nesekamus failus reikia laikyti ignoruojamais, o kuriuos – nesekamais.

PHP
use Pitmaster\Status\GitIgnore;

GitIgnore klasė analizuoja gitignore šablonus iš:

  • .gitignore saugyklos šakniniame kataloge
  • .gitignore pakatalogiuose
  • .git/info/exclude

Palaikoma šablonų sintaksė:

  • Glob šablonai (*.log, build/)
  • Neigimas (!important.log)
  • Tik katalogams skirti šablonai (pabaigoje /)
  • Pradžioje esantis / šablonams, susietiems su šakniniu katalogu
  • ** rekursinei paieškai

Būsenos įrašų kategorizavimas

Įprastas UI rodymo šablonas:

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

CLI naudojimas

Shell
./vendor/bin/pitmaster status

Išvestis:

Kodas
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 turi pagalbinę priemonę git fsmonitor protokolui:

PHP
use Pitmaster\Status\Fsmonitor;

Fsmonitor klasė gali užklausti core.fsmonitor kabliuką (jei nepavyksta, atliekamas failų keitimo laiko patikrinimas), kad sužinotų, kurie failai pasikeitė nuo žetono. Ji išjungiama, kai rankena atverta su ['processes' => false]. Šiuo metu status() jos nekviečia; vietoj to tiesiogiai lygina stat duomenis ir turinį.