Siirry sisältöön

Tila

Näytä Markdown-muodossa Muokkaa palvelussa GitHub Dokumentaatio: bfe242f

Pitmaster laskee työhakemiston tilan vertaamalla kolmea tilaa: HEAD-toimituksen puuta, indeksiä (vaiheistusaluetta) ja työhakemistoa (levyllä olevia tiedostoja). CLI tulostaa siitä git status-tyylisen yhteenvedon, ja statusPorcelainV2() tulostaa gitin Porcelain v2-muodossa.

Peruskäyttö

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

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

shortFormat() tulostaa gitin lyhyessä muodossa:

Koodi
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

Kunkin tiedoston tila esitetään merkinnällä 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-enum

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() ei ilmoita ohitettuja tiedostoja, joten Ignored ei näy sen tuloksessa.

Porcelain v2 -tuloste

Koneellisesti luettavaan tilatulosteeseen, joka vastaa muotoa git status --porcelain=v2:

PHP
echo $repo->statusPorcelainV2();

Tuloste:

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

Seuratut merkinnät tulevat ensin, sitten seuraamattomat. Uudelleennimeämiset käyttävät rivejä 2 ja ristiriidat rivejä u. Kohteen git status --porcelain=v2 --branch # branch-otsakkeita ei tulosteta, eikä ohitettuja tiedostoja luetteloida.

Näin tila lasketaan

WorkingTreeStatus-luokka tekee kolmen tilan vertailun:

PHP
use Pitmaster\Status\WorkingTreeStatus;

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

Vaihe 1: Rakenna HEAD-puukartta

Litistä HEAD-toimituksen puu kohteen path => blob hash kartaksi. Se kuvaa viimeisintä toimitettua tilaa.

Vaihe 2: Vertaa HEADia indeksiin

Kunkin HEAD-puun ja indeksin tiedoston kohdalla:

  • HEADissa mutta ei indeksissä: Deleted indeksisarakkeessa
  • Indeksissä mutta ei HEADissa: Added indeksisarakkeessa
  • Molemmissa, mutta tiivisteet eroavat: Modified indeksisarakkeessa
  • Molemmissa ja tiivisteet ovat samat: Unmodified indeksisarakkeessa

Vaihe 3: Vertaa indeksiä työhakemistoon

Kunkin indeksissä ja työhakemistossa olevan tiedoston kohdalla:

  • Indeksissä mutta ei levyllä: Deleted työhakemistosarakkeessa
  • Molemmissa, mutta sisältö eroaa: Modified työhakemistosarakkeessa
  • Molemmissa ja sisältö täsmää: Unmodified työhakemistosarakkeessa

Vaihe 4: Tunnista seuraamattomat tiedostot

Käy työhakemiston hakemisto läpi, ohita .git/ ja ohitetut polut sekä ilmoita indeksistä puuttuvat tiedostot merkinnällä Untracked molemmissa sarakkeissa.

.gitignore-tuki

Pitmaster jäsentää .gitignore-tiedostoja määrittääkseen, mitkä seuraamattomat tiedostot ilmoitetaan ohitettuina ja mitkä seuraamattomina.

PHP
use Pitmaster\Status\GitIgnore;

GitIgnore-luokka jäsentää gitignore-kuvioita seuraavista:

  • .gitignore repositorion juuressa
  • .gitignore alihakemistoissa
  • .git/info/exclude

Tuettu kuviosyntaksi:

  • Jokerikuviot (*.log, build/)
  • Kieltäminen (!important.log)
  • Vain hakemistoihin kohdistuvat kuviot (lopussa /)
  • Alussa oleva / juureen suhteutetuille kuvioille
  • ** rekursiiviseen täsmäytykseen

Tilamerkintöjen luokittelu

Yleinen tapa näyttää 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;
    }
}

CLI-käyttö

Shell
./vendor/bin/pitmaster status

Tuloste:

Koodi
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 sisältää apufunktion gitin fsmonitor-protokollalle:

PHP
use Pitmaster\Status\Fsmonitor;

Fsmonitor-luokka voi kysellä core.fsmonitor-koukkua (ja käyttää muutosaikojen tarkistusta varavaihtoehtona) selvittääkseen, mitkä tiedostot ovat muuttuneet tunnisteen jälkeen. Se poistaa toiminnon käytöstä kahvoissa, jotka on avattu asetuksella ['processes' => false]. status() ei kutsu sitä tällä hetkellä, vaan vertaa suoraan stat-tietoja ja sisältöä.