Git clean

Nell'esempio viene creato un nuovo repository Git nella directory git_clean_test. Quindi, vengono creati un tracked_file, aggiunto all'indice Git, un untracked_file e una untracked_dir. Viene quindi richiamato git status che restituisce un output in cui è indicato lo stato interno di Git delle modifiche monitorate e non monitorate. Con il repository in questo stato, possiamo eseguire il comando git clean per dimostrarne lo scopo previsto.

A questo punto, l'esecuzione del comando git clean predefinito potrebbe generare un errore irreversibile. L'esempio sopra mostra questo possibile scenario. Per impostazione predefinita, Git è configurato a livello globale per richiedere la selezione dell'opzione "force" per l'avvio di git clean. Questo è un meccanismo di sicurezza importante. Quando git clean viene infine eseguito, non sarà più possibile annullarlo. Una volta eseguito completamente, git clean effettuerà un'eliminazione definitiva del file system, simile a quando si esegue l'utilità rm della riga di comando. Prima di eseguire il comando, assicurati di voler davvero eliminare i file non monitorati.

Vista la spiegazione precedente dei comportamenti e degli avvertimenti predefiniti relativi a git clean, di seguito sono illustrati vari casi d'uso di git clean e le relative opzioni della riga di comando necessarie per il loro funzionamento.

L'opzione -n esegue un "dry run" di git clean per mostrare quali file verranno rimossi, ma senza rimuoverli effettivamente. Come best practice, esegui sempre per prima cosa un dry run di git clean. Possiamo dimostrare questa opzione nel repository dimostrativo creato in precedenza.

L'output ci informa che untracked_file verrà rimosso quando verrà eseguito il comando git clean. Osserva che untracked_dir non è riportata nell'output qui. Per impostazione predefinita, git clean non opera in modo ricorsivo sulle directory. Questo è un altro meccanismo di sicurezza per impedire le eliminazioni definitive accidentali.

L'opzione force avvia l'eliminazione effettiva dei file non monitorati dalla directory corrente. Tale opzione è richiesta, a meno che l'opzione di configurazione clean.requireForce non sia impostata su false. In questo modo non verranno rimosse le cartelle o i file non monitorati specificati da .gitignore. Eseguiamo ora il comando git clean live nel repository di esempio.

Il comando restituirà come output i file rimossi. Puoi vedere qui che untracked_file è stato rimosso. Se esegui git status a questo punto o se effettui un ls vedrai che untracked_file è stato eliminato e che non è possibile trovarlo da nessuna parte. Per impostazione predefinita, git clean -f opererà su tutti i file non monitorati della directory corrente. Inoltre, è possibile trasmettere un valore < path > con l'opzione -f per rimuovere un file specifico.

L'opzione -d comunica a git clean che vuoi rimuovere anche tutte le directory non monitorate (per impostazione predefinita questo comando ignora le directory). Possiamo aggiungere l'opzione -d agli esempi precedenti:

Qui abbiamo eseguito un "dry run" usando la combinazione -dn che restituisce come output le untracked_dir pronte per la rimozione. Quindi eseguiamo una pulizia forzata e riceviamo tramite l'output la conferma della rimozione di untracked_dir.

Uno schema comune del rilascio di software consiste nel disporre di una directory della build o della distribuzione, non sottoposta a commit, nell'indice di monitoraggio dei repository. La directory della build contiene gli artefatti effimeri della build generati dal codice sorgente sottoposto a commit. Questa directory della build viene solitamente aggiunta al file .gitignore dei repository . Può essere utile eliminare da questa directory gli altri file non monitorati. L'opzione -x comunica a Git clean di includere anche tutti i file ignorati. Come per le precedenti attivazioni di Git clean, è consigliabile eseguire un "dry run" prima dell'eliminazione definitiva. L'opzione -x agirà su tutti i file ignorati, non solo su quelli specifici della build del progetto. Potrebbe trattarsi di elementi involontari, come i file di configurazione ./.idea IDE.

Come l'opzione -d, l'opzione -x può essere trasmessa e composta con altre opzioni. In questo esempio viene mostrata una combinazione con -f per rimuovere i file non monitorati dalla directory corrente e tutti i file che di solito sono ignorati da Git.

Oltre all'esecuzione ad hoc della riga di comando dimostrata finora, git clean ha una modalità "interattiva" che è possibile avviare trasmettendo l'opzione -i. Riprendiamo il repository di esempio dall'introduzione di questo documento. Partendo da quello stato iniziale, avviamo una sessione di pulizia interattiva.

Abbiamo avviato la sessione interattiva con l'opzione -d, quindi questa agirà anche su untracked_dir. La modalità interattiva mostra un prompt What now> che richiede quale comando applicare ai file non monitorati. Le funzioni dei comandi stessi sono piuttosto chiare. Daremo una breve occhiata a ciascuno di questi comandi in ordine casuale a partire dal comando 6: help. Selezionando il comando 6 verranno spiegati quindi gli altri comandi:

È intuitivo e consente di uscire dalla sessione interattiva.

Elimina gli elementi indicati. Se dovessimo eseguire 1: clean a questo punto, untracked_dir/ untracked_file verrebbero rimossi

Crea iterazioni su ogni file non monitorato e mostra un prompt Y/N per l'eliminazione. Ha un aspetto simile al seguente:

Visualizza un prompt aggiuntivo che prende l'input utilizzato per filtrare la lista dei file non monitorati.

Qui inseriamo il carattere jolly *_file che limita la lista dei file non monitorati soltanto a untracked_dir.

Simile al comando 2, il comando 3 consente di perfezionare la lista dei nomi dei file non monitorati. La sessione interattiva richiede i numeri che corrispondono a un nome di file non monitorato.

Ricapitolando, git clean è un metodo pratico per eliminare i file non monitorati nella directory di lavoro di un repository. Questi file sono quelli che si trovano nella directory del repository, ma che non sono ancora stati aggiunti all'indice del repository con git add. Nel complesso, l'effetto di git clean può essere ottenuto utilizzando git status e gli strumenti di eliminazione nativi del sistema operativo. git clean può essere usato insieme a git reset per annullare completamente qualsiasi aggiunta e commit in un repository.