Quelltext der Seite Composer/Tutorial: Extension für Composer fit machen

[[Category:Composer]]
{{DISPLAYTITLE:Tutorial - Extension für Composer fit machen}}

{{stub}}

__TOC__

=Grundlagen=

{{Hinweis|In Composer redet man von '''Paketen''', nicht von '''Erweiterungen''' - weil es sich dabei um ein generelles '''PHP Paket''' handelt.}}

=Die <code>composer.json</code>=

Die <code>composer.json</code> ist die zentrale Konfigurationsdatei für Composer.
In dieser werden Name, Beschreibung, Typ, Lizenz, Author, und viel mehr hinterlegt.
Eine vollständige Schema-Beschreibung kann man auf der [https://getcomposer.org/doc/04-schema.md Composer Website] finden.
An dieser Stelle werden erst ein mal nur auf die wichtigsten Einträge erörtert.

{{Hinweis|Mit '''Repository''' ist das git/svn/hg Repository gemeint.}}

Die <code>composer.json</code> muss auf der obersten ebene im Repository hinterlegt werden.
Die die Dateiendung bereits verrät, handelt es sich dabei um eine [http://json.org/ JSON] Datei.

Fangen wir mal mit den Basics an:

<source lang="javascript">
{
    "name": "me/my-extension",
    "description": "A very usefull extension.",
    "keywords": ["contao", "extension", "usability"],
    "type": "contao-module",
    "homepage": "http://my-homepage.me/my-extension",
    "license": "LGPL-3.0+"
}
</source>

Mit <code>name</code> wird der Name des Pakets festgelegt. Hierbei ist zu beachten, dass sich der Name aus 2 Teilen zusammen setzt: <code>&lt;vendor&gt;/&lt;name&gt;</code>.
'''<code>&lt;vendor&gt;</code>''' ist der Name des Entwicklers, es empfiehlt sich den Personen/Organisations-Namen den man auf github verwendet zu benutzen.
'''<code>&lt;name&gt;</code>''' ist der Name des Pakets, es empfiehlt sich den Namen des Repositories auf github zu verwenden.

{{Hinweis|Der Paketname wird normalisiert. Es sind ausschließlich '''kleine Buchstaben''', '''Zahlen''', '''Unterstriche''' und '''Bindestriche''' erlaubt!<br>
'''Gut''': my-name/my-extension-name<br>
'''Schlecht''': my_name/my_extension_name<br>
'''Ungültig''': MyName/MyExtensionName}}

=Beispiele=

==Repository mit TL_ROOT==

==Repository mit system/modules/my_extension==

==Repository das bei system/modules/my_extension startet==

==Neue Struktur==