5 tipi di file da includere nel tuo .gitignore

Il controllo della versione è uno strumento vitale per tenere traccia delle modifiche alla tua base di codice, ma non sempre vuoi tenere traccia di ogni file.

Per evitare il disordine e ridurre il rischio di distribuire informazioni riservate, puoi utilizzare un file chiamato .gitignore. Questo file specifica quali file e directory Git non deve indicizzare.

Determinare quali file includere in .gitignore può essere una sfida, soprattutto se sei nuovo nello sviluppo. Scopri quali file dovresti aggiungere al tuo .gitignore per un flusso di lavoro Git più fluido.

Creazione di un file .gitignore

Affinché il tuo file .gitignore abbia effetto, devi aver inizializzato Git nel tuo progetto.

Puoi inizializzare Git eseguendo il comando seguente nel tuo terminale:

git init

Questo comando crea un nuovo repository Git per il tuo progetto, in una sottodirectory ".git" nascosta che contiene tutti i file e le directory necessari per controllare la versione del tuo progetto.

Per eseguire questo comando, devi avere Git installato nel tuo sistema.

Quindi, crea il tuo file .gitignore eseguendo il comando seguente:

tocco.gitignore

L'esecuzione del comando precedente crea un nuovo file, ".gitignore" nella directory corrente. Puoi escludere un file da Git aggiungendo il nome del file o il percorso del file (se il file si trova in una directory diversa da quella .gitignore file).

Git non ha bisogno di tenere traccia di ogni file nel tuo progetto e il monitoraggio di alcuni file può portare a problemi imprevisti. Questi sono alcuni dei file che dovresti aggiungere al tuo .gitignore.

1. File di configurazione

I file di configurazione memorizzano le impostazioni e altri parametri utilizzati dalle applicazioni per definire e personalizzare il proprio comportamento. Questi file spesso memorizzano stringhe di connessione al database, chiavi API e altre informazioni riservate che non dovresti esporre nel tuo repository Git.

Se includi i file di configurazione nel tuo repository, chiunque possa accedervi può visualizzarne il contenuto. Ciò può includere informazioni sensibili, che possono portare a violazioni della sicurezza e altri problemi.

Per escludere i file di configurazione dal tuo repository Git, aggiungi nomi di file o nomi di cartelle specifici al tuo .gitignore file.

Ad esempio, puoi aggiungere la riga sottostante al tuo file .gitignore file da ignorare a .env file.

.env

2. Costruisci artefatti

Gli artefatti di compilazione sono i file compilati o generati prodotti durante la compilazione del progetto. Questi file in genere risiedono in a "bersaglio" O "costruire" directory.

Gli artefatti di compilazione possono includere classi Java compilate, file JAR, file WAR, file binari, pacchetti di distribuzione, report, file di registro e altri generati durante il processo di compilazione.

In genere è una buona pratica escludere gli artefatti di compilazione dal repository Git perché possono essere molto grandi. Potrebbero anche essere meno portabili dei file di origine, rilevanti solo per un ambiente specifico. Includerli nel tuo repository può gonfiare le dimensioni del tuo repository e rallentare la clonazione e l'utilizzo.

Per escludere artefatti di compilazione dal tuo repository Git, aggiungi il file "bersaglio/" O "costruire/" directory al tuo .gitignore file.

Per esempio:

# .gitignore
bersaglio/
costruire/

3. File dell'ambiente di sviluppo integrato

I file IDE (Integrated Development Environment) sono file di configurazione, metadati di progetto e altri file generati dall'IDE quando crei o apri un progetto. Questi file sono specifici per ciascun IDE. Il tuo IDE utilizza questi file per configurare le impostazioni del progetto.

Questi file non sono necessari per la creazione o l'esecuzione dell'applicazione e spesso possono causare problemi se inseriti in un repository Git condiviso. Ad esempio, persone diverse del tuo team potrebbero utilizzare IDE o versioni diverse e il commit di file specifici dell'IDE potrebbe causare conflitti di unione e rendere difficile la collaborazione al progetto.

Poiché questi file sono specifici dell'IDE, i file da includere nel file .gitignore dipenderà dal tuo IDE. Ecco Consigli .gitignore di GitHub per alcuni IDE popolari. Puoi cercare il tuo IDE preferito e aggiungere i file delineati al tuo .gitignore file.

4. File di dipendenza e pacchetto

I file delle dipendenze e dei pacchetti sono file che contengono informazioni sulle dipendenze e sui pacchetti utilizzati dall'applicazione. Vari strumenti di costruzione, come il Node Package Manager (npm), genera questi file.

Ad esempio, se usi npm per gestire le dipendenze per un progetto JavaScript, creerà un "node_modules" cartella nella directory principale del progetto. La directory contiene tutte le dipendenze installate per il tuo progetto.

Questa directory può diventare molto grande, specialmente se il tuo progetto ha molte dipendenze o alcune dipendenze hanno file di grandi dimensioni. Escludendo il "node_modules" cartella dal tuo repository Git, puoi mantenerla pulita e ridurne le dimensioni.

Per evitare di aggiungere il "node_modules" directory al tuo repository Git, aggiungi il suo nome al tuo file .gitignore:

#.gitignore
moduli_nodo/

5. File del sistema operativo

Il tuo sistema operativo e altri strumenti di sistema possono generare file durante il normale utilizzo. Questi possono includere file di registro, file temporanei e file di configurazione del sistema. Un esempio è il Pollici.db file su Windows e il suo equivalente macOS, il file .DS_Store file.

In genere è buona norma escludere i file del sistema operativo dal repository Git, in quanto essi sono specifici per l'ambiente locale e possono differire tra diversi computer e operativi sistemi.

GitHub ha consigliato le linee guida .gitignore per finestre, Mac OS, E Linux.

L'importanza del controllo della versione

L'uso del controllo della versione può migliorare significativamente il flusso di lavoro e ridurre gli errori e i conflitti che possono sorgere quando si lavora su una base di codice. Con il controllo della versione, puoi facilmente tenere traccia delle modifiche al codice, rivederle e collaborare senza problemi con i membri del team.

Tuttavia, dovresti sempre escludere determinati file, come file di configurazione, file IDE e file del sistema operativo. Ciò ridurrà le dimensioni del tuo repository e ti assicurerà di non perdere informazioni sensibili.