Vai al contenuto

Stato

Visualizza come Markdown Modifica su GitHub Documentazione di bfe242f

Pitmaster calcola lo stato dell'albero di lavoro confrontando tre stati: l'albero del commit HEAD, l'indice (area di staging) e l'albero di lavoro (i file effettivi su disco). CLI ne stampa un riepilogo in stile git status, mentre statusPorcelainV2() stampa il formato porcelain v2 di git.

Uso di base

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

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

shortFormat() stampa il formato breve di git:

Codice
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

Lo stato di ogni file è rappresentato da un 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"

Enumerazione 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() non segnala i file ignorati, quindi Ignored non compare nel risultato.

Output porcelain v2

Per un output dello stato leggibile dalla macchina e compatibile con git status --porcelain=v2:

PHP
echo $repo->statusPorcelainV2();

Output:

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

Le voci tracciate vengono prima, poi quelle non tracciate. Le rinomine usano righe 2 e i conflitti righe u. Le intestazioni # branch di git status --porcelain=v2 --branch non vengono stampate e i file ignorati non sono elencati.

Calcolo dello stato

La classe WorkingTreeStatus esegue il confronto a tre vie:

PHP
use Pitmaster\Status\WorkingTreeStatus;

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

Passaggio 1: creare la mappa dell'albero HEAD

Appiattire l'albero del commit HEAD in una mappa di path => blob hash. Questa rappresenta l'ultimo stato confermato.

Passaggio 2: confrontare HEAD con l'indice

Per ogni file nell'albero HEAD e nell'indice:

  • In HEAD ma non nell'indice: Deleted nella colonna dell'indice
  • Nell'indice ma non in HEAD: Added nella colonna dell'indice
  • In entrambi ma con hash diversi: Modified nella colonna dell'indice
  • In entrambi con lo stesso hash: Unmodified nella colonna dell'indice

Passaggio 3: confrontare l'indice con il worktree

Per ogni file nell'indice e nell'albero di lavoro:

  • Nell'indice ma non sul disco: Deleted nella colonna del worktree
  • In entrambi ma con contenuto diverso: Modified nella colonna del worktree
  • In entrambi con contenuto corrispondente: Unmodified nella colonna del worktree

Passaggio 4: rilevare i file non tracciati

Esplorare la directory dell'albero di lavoro, ignorare .git/ e i percorsi ignorati, quindi segnalare come Untracked in entrambe le colonne i file non presenti nell'indice.

Supporto .gitignore

Pitmaster analizza i file .gitignore per determinare quali file non tracciati segnalare come ignorati e quali come non tracciati.

PHP
use Pitmaster\Status\GitIgnore;

La classe GitIgnore analizza i pattern di gitignore da:

  • .gitignore nella radice del repository
  • .gitignore nelle sottodirectory
  • .git/info/exclude

Sintassi dei pattern supportata:

  • Pattern glob (*.log, build/)
  • Negazione (!important.log)
  • Pattern limitati alle directory (/ finale)
  • / iniziale per i pattern relativi alla radice
  • ** per la corrispondenza ricorsiva

Categorizzazione delle voci di stato

Un pattern comune per la visualizzazione di 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;
    }
}

Utilizzo di CLI

Shell
./vendor/bin/pitmaster status

Output:

Codice
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 include un helper per il protocollo fsmonitor di git:

PHP
use Pitmaster\Status\Fsmonitor;

La classe Fsmonitor può interrogare l'hook core.fsmonitor (ripiegando sulla scansione delle date di modifica) per individuare i file modificati da un token. Si disattiva per gli handle aperti con ['processes' => false]. Al momento status() non lo chiama: confronta direttamente i dati stat e il contenuto.