Composer/Tutorial: Extension für Composer fit machen: Unterschied zwischen den Versionen
Aus Contao Community Documentation
Tril (Diskussion | Beiträge) |
Tril (Diskussion | Beiträge) (→Die composer.json) |
||
| Zeile 8: | Zeile 8: | ||
=Grundlagen= | =Grundlagen= | ||
| − | =Die composer.json= | + | {{Hinweis|In Composer redet man von '''Paketen''', nicht von '''Erweiterungen''' - weil ein '''Composer Paket''' nicht an ein CMS / System gebunden ist. Aber ein '''Composer Paket''' kann auch eine '''Contao Erweiterung''' sein.}} |
| + | |||
| + | =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><vendor>/<name></code>. | ||
=Beispiele= | =Beispiele= | ||
Version vom 21. Juni 2014, 20:05 Uhr
 |
Unvollständiger Artikel: dieser Artikel ist noch nicht sauber bearbeitet.
Bitte erweitere ihn und entferne erst anschliessend diesen Hinweis. |
Inhaltsverzeichnis
Grundlagen
 |
Hinweis: In Composer redet man von Paketen, nicht von Erweiterungen - weil ein Composer Paket nicht an ein CMS / System gebunden ist. Aber ein Composer Paket kann auch eine Contao Erweiterung sein. |
Die composer.json
Die composer.json 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 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 composer.json muss auf der obersten ebene im Repository hinterlegt werden.
Die die Dateiendung bereits verrät, handelt es sich dabei um eine JSON Datei.
Fangen wir mal mit den Basics an:
{ "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+" }
Mit name wird der Name des Pakets festgelegt. Hierbei ist zu beachten, dass sich der Name aus 2 Teilen zusammen setzt: <vendor>/<name>.
