Skip to main content

​
Was ist die squarecloud.ignore-Datei?

Die squarecloud.ignore-Datei listet die Dateien und Ordner auf, die beim Hochladen oder Committen einer Anwendung weggelassen werden. Die Square Cloud-CLI (upload, commit und zip) und die Square Cloud-Erweiterung für VS Code lesen dieselbe Datei, mit denselben Regeln und denselben Standardwerten, sodass ein Projekt von beiden gleich verpackt wird. Sie verwendet die .gitignore-Syntax: Kommentare, Platzhalter, Regeln nur für Ordner oder nur für den Projektstamm und !, um eine Datei zurückzuholen.

​
Datei erstellen

Erstelle eine Datei namens squarecloud.ignore im Projektstamm.
Die Datei muss genau squarecloud.ignore heißen. .gitignore wird nicht an ihrer Stelle gelesen: Dort stehen oft Dateien, die die Anwendung zum Ausführen braucht, etwa .env.

​
Immer ausgeschlossen

Diese Pfade werden vor deinen eigenen Regeln ignoriert, du musst sie also nicht aufführen:
  • node_modules
  • .git, .github und .vscode
  • package-lock.json, pnpm-lock.yaml und yarn.lock
Hole jeden davon mit einer !-Regel zurück.

​
Lock-Dateien

Lock-Dateien bleiben standardmäßig außerhalb der ZIP-Datei, sodass Square Cloud deine Abhängigkeiten anhand der Versionsbereiche in der package.json installiert. Wenn du genau die Versionen brauchst, die deine Lock-Datei festlegt, hole sie zurück:

​
Syntax

Jede Zeile ist eine Regel. Eine passende Datei oder ein passender Ordner wird beim Upload weggelassen. So werden die Regeln angewendet:
  • Die letzte passende Zeile gewinnt, setze !-Regeln also hinter die Regeln, die sie aufheben.
  • Eine Datei in einem ignorierten Ordner kann nicht zurückgeholt werden. Um eine einzelne Datei eines Ordners zu behalten, ignoriere den Inhalt des Ordners (logs/*) statt des Ordners selbst (logs/) und füge dann !logs/keep.log hinzu.
  • Beim Abgleich wird die Groß-/Kleinschreibung ignoriert: Dist/ trifft auch auf dist zu.
  • Von einer Regel werden nur Leerzeichen am Ende entfernt, niemals Tabs. Maskiere ein Leerzeichen am Ende, das erhalten bleiben soll, mit \ .
Verwende / als Trennzeichen für Ordner in Mustern, auch unter Windows.

​
Häufige Beispiele

Schließe Entwicklungstools und erzeugte Dateien aus und behalte alles, was die Anwendung zum Ausführen braucht:
Ignoriere keine Datei, die deine Anwendung zur Laufzeit liest. Wenn dein Code Geheimnisse aus einer .env-Datei lädt und du .env hier aufführst, startet die Anwendung ohne sie, und ein Bot scheitert mit einem ungültigen Token. Übertrage diese Werte zuerst in die Umgebungsvariablen der Anwendung; danach kannst du .env gefahrlos aus dem Upload weglassen.

​
Anwendung

Die CLI und die VS Code-Erweiterung lesen squarecloud.ignore, wenn sie die Dateien für den Upload oder Commit vorbereiten. Dateien, die einer Regel entsprechen, werden nicht in das an Square Cloud gesendete ZIP aufgenommen.
  • Ein symbolischer Link auf eine Datei wird als die Datei hochgeladen, auf die er zeigt. Links auf Ordner und defekte Links werden übersprungen.
  • Die CLI liest weiterhin die älteren Namen (.squareignore, .squarecloudignore und square.ignore), wenn squarecloud.ignore fehlt, und bittet dich, die Datei umzubenennen.
Bewahre zur Laufzeit benötigte Dateien, etwa die in MAIN deiner Konfigurationsdatei festgelegte Datei, außerhalb ignorierter Pfade auf. Der Upload im Dashboard liest diese Datei nicht: Wenn du die ZIP-Datei selbst erstellst, lass diese Dateien dort weg.