Veröffentlichen und Pflegen Sie Ihre TER TYPO3 Extensions mit Composer + Git + Packagist

Unser App Store heißt TER - und er ist kostenlos! ~ TYPO3 GmbH

Gemäß dem aktuellen Trend der Produkt- und Erweiterungsentwicklung ist der Composer eine der beliebtesten Abhängigkeitstechniken in PHP Open Source, die Ihnen helfen wird, Ihre Erweiterung einfach zu entwickeln, zu veröffentlichen und zu warten.

Vorteile wie: Release-Management, genaue Abhängigkeiten, einfache Installation und Upgrades, etc,

Heutzutage werden die meisten OpenSource CMS und Frameworks als "ideales Modell" verwendet.

Möchten Sie, dass Ihre TYPO3 Extension einfach mit dem magischen Composer-Befehl installiert werden kann?

Keine Notwendigkeit, TER Website zu gehen, laden Sie die Erweiterung, installieren Sie von Extension Manager, usw., Schreiben Sie einfach Befehl zB,

composer require nitsan/ns-news-comments

Sobald Sie Ihre Erweiterung mit gut QA-Tests und Code-Review abgeschlossen haben. Richten Sie composer.json im Stammverzeichnis Ihrer Erweiterung ein.

Sie müssen die folgenden wichtigsten Dinge beachten:

• Name: Hersteller-Name/Erweiterungs-Name
• Type: typo3-cms-extension
• Muss Voraussetzung sein: Stellen Sie sicher, dass Sie genaue Abhängigkeiten Ihrer Extension definieren, z.B. TYPO3 CMS core, andere TER-Extensions, PHP-Versionsabhängigkeiten, etc,
• Autoload: Es ist sehr empfehlenswert, dies einzurichten, da Ihre Erweiterung auch ohne Composer-Modus laufen soll. VendorName\\ExtensionsName (Sie können die genauen Wörter aus Ihrer beliebigen Controller-Datei aus dem Ordner \Controller\ finden.

Beispiel composer.json unseres beliebten TYPO3 EXT:ns_news_comments. Composer unter Schritt-für-Schritt-Anleitung zum TYPO3 Composer und der speziellen TYPO3-Seite.

Verbinden von Code mit Git

Lassen Sie uns nun das Git-Repository in Ihrer lokalen Umgebung einrichten und den Code nur über "Git" pflegen und hochladen.

# Globale Git-Konfiguration

git config --global user.name "YOUR_USERNAME"
git config --global user.email "your_email_address@example.com"

# Klonen Sie Ihr Repository

 git clone  https://github.com/nitsan-technologies/ns_news_comments/issues

# Auschecken, ziehen und einen Status sehen

git checkout master
git pull origin master
git status

# Push your code

Verschieben Sie den Code Ihrer Erweiterung in den Repository-Ordner git this.

git diff
git add.
git commit -m "Initial TYPO3 alpha version"
git push origin master/develop

Jetzt haben Sie ein aktuelles Repository in Ihrem lokalen und in Github. Pflegen Sie nun weiterhin Code und Änderungen zwischen Ihrem lokalen Git und Github.

Wenn Sie einige Fehler erhalten, dann überprüfen Sie Ihre composer.json in Ihrem Git-Repository.

Schritt 5: Jetzt werden Sie auf die Landing Page Ihres Pakets weitergeleitet, z.B. https://packagist.org/packages/nitsan/ns-news-comments. Hier können Sie sehen, dass alle Informationen aus der composer.json-Datei von Github geholt werden.

Hurra!

Ihre TYPO3 Extension kann nun mit einem einfachen Composer-Befehl z.B. installiert werden,

composer req nitsan/ns_ext_compatibility

Kennen Sie Semantische Versionierung?

Beispiel Erweiterungsversion: 1.1.2.

Geben Sie eine Versionsnummer MAJOR.MINOR.PATCH an, erhöhen Sie die:

• MAJOR-Version, wenn Sie inkompatible API-Änderungen vornehmen,
• MINOR-Version, wenn Sie Funktionalität abwärtskompatibel hinzufügen, und
• PATCH-Version, wenn Sie abwärtskompatible Fehlerbehebungen vornehmen.

Zusätzliche Bezeichnungen für Vorabveröffentlichungen und zum Erstellen von Metadaten sind als Erweiterungen des Formats MAJOR.MINOR.PATCH verfügbar.

Lesen Sie mehr Details unter https://semver.org/ 

Abhängigkeitsmanagement

Eines der wichtigsten Dinge ist, dass wir bei jedem Release unserer Erweiterung die Abhängigkeiten erstellen und gut definieren müssen. Es könnte mehrere Abhängigkeiten geben wie:

1. TYPO3-Kernversion
2. Andere TYPO3-Erweiterungen
3. PHP version

In ext_emconf.php

Richten Sie die richtigen Abhängigkeitsversionen bei Einschränkungen ein, indem Sie die Version von TYPO3 und anderen Erweiterungen definieren.

'constraints' => array(
 'depends' => array(
  'typo3' => '6.2.0-9.5.5',
  'news' => '3.0.0-7.1.0',
  ),
  'conflicts' => array(
  ),
  'suggests' => array(
  ),
),

In composer.json

Auf ähnliche Weise müssen Sie Abhängigkeiten in composer.json definieren

"require": {
 "typo3/cms-core": ">=6.2.0 || <=9.5.5",
 "georgringer/news": ">=3.0.0"
},

Lesen Sie mehr über die Versionsverwaltung von Abhängigkeiten mit Composer unter https://getcomposer.org/doc/articles/versions.md​​​​​​​ 

Lokale Umgebung einrichten

Um TYPO3-Extensions zu initiieren und zu entwickeln, empfehlen wir die folgenden Tools und Techniken;

• Praxis mit Docker und DDEV
• Composer installieren
• Git einrichten
• PHPStorm IDE verwenden

TYPO3 Extension Entwicklung

Um der TYPO3-Community die beste Qualität der Extensions zu bieten, sollten Sie Ihr Bestes tun, um TYPO3-Extensions nach allen Industriestandards zu entwickeln:

• Lesen und durchlaufen Sie die Erstellung einer ersten Extension aus den TYPO3-Dokumenten.
• Um Ihre Erweiterung schnell in Betrieb zu nehmen, können Sie den beliebtesten EXT:extension_builder verwenden.
• Lesen Sie das ExtbaseFluid-Buch aus den TYPO3-Dokumenten.
• Modernes Arbeiten und Code-Review mit Industriestandards wie PHP PSR-Standards, Unit-Testing, etc,

Wie Sie wissen, ist "TER" unser App-Store, also lassen Sie uns unser Bestes tun, um ihn gesund zu halten und der Community etwas zurückzugeben - lassen Sie uns unser Bestes tun, um unsere TYPO3-Extensions gut zu entwickeln, reibungslos zu veröffentlichen und gesund zu pflegen.

Hier ist die kurze Zusammenfassung:

• Verstehen Sie die Bedeutung sowie die Leistungsfähigkeit des Composers. Nutzen Sie ihn weiterhin für die Community und Ihre privaten Projekte.

• Entwickeln und testen Sie Ihre Arbeit und Ihren Code gut.

• Verstehen Sie Versionierung und Abhängigkeiten.

• composer.json einrichten

• Initiieren Sie Git und pushen Sie es zu Ihrem bevorzugten Git-Tool wie Github, Gitlab, BitBucket, etc,

• Erstellen einer Verbindung zwischen Packagist und Git

• Erweiterung im TER veröffentlichen

• Seien Sie stolz auf Ihren Beitrag und trinken Sie ein Bier, um ihn zu feiern :)

Viel Spaß beim Coding und tragen Sie weiterhin zur großen TYPO3 Community bei!

Menschen zum Programmieren inspirieren!