Ignorieren Sie die Datei Package-Lock.JSON in Git

Ignorieren Sie Die Datei Package Lock Json In Git



Egal, ob Sie gerade erst mit Git beginnen oder ein erfahrener Profi sind, eine der grundlegendsten Funktionen, die Sie verwenden werden, ist „Gitignore“.

Es kommt häufig vor, dass Dateien und Verzeichnisse vertrauliche Informationen wie API-Schlüssel, Passwörter, Konfigurationsdateien usw. enthalten. Eine der am häufigsten verwendeten Dateien für Webentwickler ist die Datei package-lock.json.

Glücklicherweise verfügt Git über die Funktion „gitignore“, mit der wir Git anweisen können, diese Dateien und Verzeichnisse nicht in das Repository aufzunehmen.







In diesem Tutorial werden wir die Grundlagen der „Gitignore“-Funktion untersuchen und wie wir sie verwenden können, um bestimmte Dateien und Verzeichnisse von der Verfolgung durch Git auszuschließen.



Anschließend konzentrieren wir uns auf die Verwendung der „Gitignore“-Funktion, um die berüchtigte Datei „package-lock.json“ zu ignorieren.



Was ist die Package-Lock.JSON-Datei?

Die Datei package-lock,json ist eine Datei, die das JSON-Format verwendet, um die Abhängigkeiten in einem Node.js-Projekt zu verwalten. Die Datei ist deterministisch und konsistent, was die Verwaltung der Abhängigkeiten sehr nützlich und einfach macht.





Die Datei wird automatisch vom Paketmanager wie npm und Yarn generiert, sobald wir die Pakete in einem bestimmten Projekt installieren oder aktualisieren.

Obwohl es im Projekt nützlich ist, ist es gegenüber den tatsächlichen Paketen, die zum Ausführen des in package.json definierten Projekts erforderlich sind, redundant. Daher ist die Aufnahme in ein Repo nicht unbedingt erforderlich.



Gitignore-Funktion

In Git ist „Gitignore“ eine grundlegende Funktion, die es uns ermöglicht, die Dateien und Verzeichnisse zu konfigurieren, die von der Versionskontrollverfolgung ausgeschlossen sind.

Es handelt sich lediglich um eine Textdatei mit Einträgen für die Namen von Verzeichnissen und Dateien, die wir ausschließen möchten. Wir können der Datei auch Muster hinzufügen, um die Dateien zu bestimmen, die ausgeschlossen werden sollen.

Erstellen einer Gitignore-Datei

Bevor wir uns mit der Konfiguration der „Gitignore“-Datei befassen, müssen wir sicherstellen, dass die Datei im Ziel-Repository vorhanden ist.

Navigieren Sie zunächst zum Stammverzeichnis des Git-Repositorys. Angenommen, wir haben ein Repository namens „hello_world“.

Wir können das folgende Verzeichnis erstellen oder dorthin navigieren:

$ CD ~ / src / Hallo Welt

Erstellen Sie im Stammverzeichnis eine neue Datei mit dem Namen „.gitignore“. Hier speichern wir alle Einträge für alle Dateien und Verzeichnisse, die das Versionskontrollsystem ignorieren soll.

$ berühren .gitignore

Einträge zu den Gitignore-Dateien hinzufügen

Sobald wir die „gitignore“-Datei erstellt haben, können wir fortfahren und die Dateien und Verzeichnisse hinzufügen, die wir einschließen möchten.

Sie können dies tun, indem Sie die Datei „gitignore“ mit einem Texteditor öffnen. Fügen Sie als Nächstes die Muster hinzu, um die zu ignorierenden Dateien und Verzeichnisse anzugeben.

Jedes Muster sollte in einer separaten Zeile stehen. Angenommen, wir arbeiten in einem Python-basierten Repository und möchten den mit Python kompilierten Bytecode und die Verzeichnisse der virtuellen Umgebung ausschließen.

Wir können die Einträge wie folgt hinzufügen:

__pycache__ /
venv /

Dies sollte sicherstellen, dass Git keine „pycache“-Dateien und keine Dateien verfolgt, die im „venv“-Verzeichnis gespeichert sind.

Ignorieren von Package-Lock.JSON in Git

Um Git anzuweisen, die Datei package-lock.json zu ignorieren, können wir den Eintrag in der Datei „gitignore“ hinzufügen, wie im folgenden Beispiel gezeigt:

Bearbeiten Sie zunächst die Datei „.gitignore“ und fügen Sie ein Muster hinzu, um die Dateien „.env“ zu ignorieren.

package-lock.json

Dies sollte Git dazu zwingen, die angegebene Datei zu ignorieren.

Entfernen der bereits enthaltenen Dateien

In einigen Fällen haben Sie die Datei möglicherweise bereits hinzugefügt, bevor Sie sie zum „Gitignore“ hinzugefügt haben. Daher ist es ratsam, sie aus dem Versionskontrollsystem zu entfernen.

Wir können dies mit dem Befehl „git rm“ wie folgt tun:

git rm --cached package-lock.json

Dadurch sollten die bereits enthaltenen Dateien aus „Git Tracking“ entfernt werden.

Abschluss

In diesem Tutorial haben wir eines der gebräuchlichsten und leistungsstärksten Tools in Git namens „Git Tracking“ kennengelernt, mit dem wir verhindern können, dass Git bestimmte Dateien verfolgt.