Die Wahl der Hilfsmittel

Wir haben uns im Team dazu entschieden, dass wir unsere Projekte gemeinsam auf der selben Testinstanz umsetzen.

Das hat den Vorteil, dass wir damit sehr nah mit unseren Kunden arbeiten können. Diese können ab einem bestimmten Stand den Fortschritt des Projekts mitverfolgen und mitgestalten.

Natürlich kann es dadurch zu Problemen kommen, weil ja mehrere Menschen zeitgleich arbeiten. Das heißt, dass man schon mal gemeinsam an einer Datei arbeitet und es erst bemerkt, wenn man seine Arbeit hochladen möchte. Dass man an ein und der selben Datei gleichzeitig arbeitet, kommt vielleicht zwei mal im Jahr vor. Dennoch:

Daher haben wir intern einige Vorkehrungen getroffen, damit es zu keinen allzu großen Problemen kommt. Im folgenden erkläre ich, wie uns eine IDE dabei hilft, uns nicht gegenseitig in die Quere zu kommen.

Wir verwenden hierfür PHPStorm von JetBrains. Daher bezieht sich der folgende Artikel auch auf diese IDE. Daneben sind noch Sublime Text und Visual Studio Code zu nennen, die sich großer Beliebtheit in der Webentwickler-Branche erfreuen.

Automatisches Hochladen des Projekts

Für diesen Artikel gehe ich davon aus, dass wir ein Theme/Plugin direkt auf einem Testserver entwickeln.

Das heißt, wir wollen den Code unseres Projekts regelmäßig mit dem Code des Servers abgleichen. Der Server soll immer auf dem aktuellsten Stand sein.

Die IDE hilft uns!

Wir lassen uns von der IDE helfen und setzen die für uns notwendigen Einstellungen unter „Tools / Deployment / Options“

Hierfür setzen wir für das Deployment folgende Einstellungen:

  • Confirm deleting remote files (damit wir nicht aus versehen eine Datei am Server löschen)
  • Prompt when overwriting or deleting local items (damit wir nicht aus versehen eine lokale Datei löschen)
  • Upload changed files automatically to the default server setzen wir auf On explicit save
    • Besonders dieser Punkt ist wichtig, weil dadurch kein automatischer Sync vom lokalen Rechner mit dem Server gestartet wird.
    • Wenn wir hier Always verwenden, werden auch Dateien, die nicht von uns bearbeitet worden sind, am Server überschrieben werden!
Das Bild zeigt den Weg zu den Deployment-Einstellungen in PHPStorm. Wir navigieren im Hauptmenü von "Tools" über "Deployment" zu "Options".
Der Weg zu den Deployment-Einstellungen in PHPStorm.
Das Bild zeigt die Deployment-Einstellungen in einer möglichst sicheren Konfiguration. Markiert sind die Einstellungen, dass wir benachrichtigt werden, wenn wir Dateien auf einem entfernten Server löschen, wenn wir lokale Dateien überschreiben oder entfernen würden und wann wir automatisch die Dateien auf den entfernten Server hochladen wollen. Die Einstellung zum automatischen Hochladen steht auf "On explicit save action" - also nur, wenn wir es aktiv anstoßen mit z.B. "Strg + S".
Deployment-Einstellungen in einer möglichst sicheren Konfiguration

Einstellung je nach Zusammenarbeit

Beim Setzen der Einstellungen kommt es darauf an, ob wir das Projekt ganz alleine durchziehen, oder in einem Team daran arbeiten.

Wenn wir ganz alleine und immer vom selben Rechner aus daran arbeiten, können wir bei der Einstellung „Upload changed files automatically to the default server“ beruhigt auf „Always“ stellen.

Das Bild zeigt eine weitere Option für das automatische Hochladen unserer Dateien auf einen externen Server. Hier wurde "Always" gewählt. Diese Einstellung kann dadurch Änderungen von anderen Kollegen überschreiben!

Sobald wir aber mit anderen daran arbeiten, könnte das dazu führen, dass wir dadurch ständig die Arbeit unserer Kollegen beeinträchtigen, weil wir ständig ihre Arbeit überschreiben, solange deren Änderungen nicht auch lokal bei uns Einzug finden.

Um auf der sicheren Seite zu sein, lässt sich diese Einstellung („Upload to Default Server“) zusätzlich mit einer Tastenkombination absichern, die immer nur die aktuell geöffnete Datei hochlädt.

Das Bild zeigt die Einstellungen für die Tastenkombinationen der IDE PHPStorm. Markiert ist die Option "Upload to Default Server", der auch eine Tastenkombination zugewiesen wurde. Hiermit wird immer nur die aktuell geöffnete Datei hochgeladen.
Eine mögliche Einstellungen für die Tastenkombinationen zum Hochladen der aktuell geöffneten Datei

Doppelte Sicherheit durch die IDE!

Für die ganz paranoiden unter uns, können wir uns bei heiklen Aufgaben vor dem Speichern noch ansehen, welche Änderungen an der aktuell am Server gespeicherten Datei vorgenommen werden, wenn wir diese hochladen.

Diese Option heißt „Compare Local File with Deployed Version“ und lässt sich zum einfachen Gebrauch auch wieder einer Tastenkombination zuordnen.

Das Bild zeigt die Einstellung der Tastenkombination für das Vergleichen der lokalen Datei mit der Datei am Server. Die Option heißt "Compare Local File with Deployed Verseion".
Anlegen einer Tastenkombination für das Vergleichen der lokalen Datei mit der Datei am Server

Kurz zu den Alternativen

Weil ich oben kurz die beliebten alternativen Editoren erwähnt hatte, möchte ich auch hier kurz etwas dazu sagen.

Für Sublime Text steht das Plugin SFTP zur Verfügung mit dem man ähnliche Einstellungen treffen kann.

Das Bild zeigt eine mögliche Konfiguration für Sublime Text mit dem Plugin "SFTP". Hier gibt es z.B. ähnliche Einstellungen wie bei PHPStorm. Zu beachten sind z.B. "upload_on_save", "sync_down_on_open", "confirm_downloads" oder "confirm_sync"
Hier sehen wir eine mögliche Konfiguration für Sublime Text mit dem Plugin „SFTP“

Visual Studio Code habe ich selber noch nicht intensiv genug verwendet, um konkrete Aussagen dazu treffen zu können. Aber ich bin mir sicher, dass es hier eine ähnliche Möglichkeit gibt! Die ersten Treffer auf dem Plugin-Marktplatz lassen zumindest diesen Schluss zu.