|
|
# Quiqqer Developer Tools
|
|
|
|
|
|
## Allgemeines
|
|
|
|
|
|
Quiqqer hält diverse Standards ein.
|
|
|
Um es Entwicklern zu erleichtern standardkonform zu arbeiten, wurden diverse Hilfen geschaffen.
|
|
|
|
|
|
#### Inhalt:
|
|
|
|
|
|
##### Scripts
|
|
|
- qcommit : Erleichtert den Commit-vorgang.
|
|
|
- qcreate : Erleichtert die Projekterstellung
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
Die Installation erfolgt über Composer.
|
|
|
Ein für Composer entwickeltes Plugin automatisiert den Installationsprozess.
|
|
|
|
|
|
Man benötigt nur eine globale Installation von Composer.
|
|
|
|
|
|
Aufgrund des frühen Entwicklungsstandes der Tools setzen wir zuerst die "minimum-stability" auf "dev".
|
|
|
|
|
|
composer global config minimum-stability dev
|
|
|
|
|
|
Gefolgt von
|
|
|
|
|
|
composer global require pcsg/devwizard:dev-dev
|
|
|
|
|
|
Anschliessend führen wir die Installationsroutine des Plugins aus
|
|
|
|
|
|
composer global pcsg-install
|
|
|
|
|
|
Wenn alles glatt läuft erstellt dieses Plugin alle nötigen Verknüpfungen und erstellt einen "bin/" Ordner im Home verzeichnis, indem alle mitgelieferten Scripte für den Benutzer global ausführbar gemacht werden.
|
|
|
|
|
|
> Der bin/ Ordner im Homeverzeichnis wird durch die " \~ /.profile" in die $PATH Umgebungsvariable hinzugefügt. Dadurch sucht das Betriebssystem dort auch nach ausführbaren Scripten. Die "~/profile" wird beim Einloggen ausgeführt. Da der bin/ Ordner nicht standardmäßig existiert, kann es sein, dass man sich erneut in Linux einloggen muss, um die Scripte global ausführbar zu erhalten.
|
|
|
|
|
|
|
|
|
## Anwendung
|
|
|
|
|
|
#### QCommit
|
|
|
|
|
|
- In das Verzeichnis wechseln, in welchem das .git Repository liegt, welches commited werden soll.
|
|
|
|
|
|
- Qcommit aufrufen `qcommit "<nachricht>"`
|
|
|
|
|
|
- Anweisungen folge leisten
|
|
|
|
|
|
|
|
|
**Zusätzliche Parameter**
|
|
|
|
|
|
-- verbose (-v) : Zeigt zusätzliche Debugmessages an
|
|
|
-- add (-a) : Führt vor dem Commit ein `git add .` aus. ( Mit Vorsicht geniessen ! )
|
|
|
|
|
|
#### QCreate
|
|
|
|
|
|
- Man wechselt in einen leeren Ordner auf dem Filesystem, indem das Project erstellt werden soll.
|
|
|
|
|
|
- Man führt QCreate aus und folgt den Anweisungen.
|
|
|
|
|
|
- Fertig.
|
|
|
|
|
|
|
|
|
> Den Accesstoken von Gitlab findet man in der Accountverwaltung. https://dev.quiqqer.com/profile/account
|
|
|
|