toolpic-cli

Toolpic CLI - embeding and serialization

Dieses Package ist in erster Linie ein Command Line Interface, welches wesentliche Prozesse und Konfigurationen für standardisierte toolpic-core Templates bereitstellt, die für die Nutzung als embeded Standalone Templates optimiert sind. Das Ziel ist es, die gesamte standardisierte Konfiguration für Templates in der Production hier bereitzustellen und Templates auch immer nur hiermit zu erstellen und zu updaten.

Was passiert?

Mit diesem CLI kann im Wesentlichen ein ready-to-deploy webpack Projekt konfigurieert werden, welches ein Toolpic Template so einbindet, dass es out of the box als embeded Template genutzt werden könnte. Technisch gesehen werden hier einfach nur standardisierte Vue und Webpack Konfigurationen erstellt, die bereits Schnittstellen für die Kommunikation mit der Website in einem embeded Environment bereitstellen und auch ein paar Probleme lösen, die auf der Webpack-Ebene gelöst werden müssen (Font Loading).

Installation

$ npm install -g toolpic-cli

Usage

$ toolpic-cli <command> [...args]

Aktuell gibt es zwei Command: create und update.

Create

Der wichtigste Command ist create. Hier wird im aktuellen Working Directory ein Webpack/Vue Projekt erstellt, es werden die benötigten Dependencies installiert und einige webpack und vue Konfigurationen festgelegt. Das erstellte Projekt ist ein valides Vue Projekt, was bedeutet dass es auch theoretisch auch über die das Vue UI managebar sein sollte. Er vereint auch das Erstellen und updaten eines Projektes.

Basic Usage

$ toolpic-cli create foo --core ^0.7

Der Command nimmt folgende Argumente an:

Argument	Beschreibung	Typ
name	Name des Projektes	Benötigt
core	Toolpic Core dependency	Benötigt
no-install	NPM install auslassen	Optional
serial	Serialisierte Template Basis	Optional
dependencies	Relativer Ursprung der Dependencies	Optional

name ist der Name dea Ordners, den wir erstellen und wird auch in der package.json geführt.

--core ist die zu installierende toolpic (Toolpic Core) Dependency, die installiert wird. Der Wert ist der Eintrag in der package.json Datei. Um toolpic direkt von NPM zu beziehen, würde beispielsweise ^0.7 funktionieren.

--no-install gibt an, ob das Installieren der npm Packages überprüngen werden soll. Das ist dann praktisch, wenn create nur zum Updaten benutzt werden soll und alle Dependencies installiert sind. In diesem Fall wird das gesamte Projekt von Grund auf neu konstruiert, nur wird kein frischer npm install ausgeführt. Effektiv ist das in Kombination mit dem serial Argument ein sehr performanter Update-Prozess.

--serial gibt eine seriale .json Datei an, die ein Template in unserem serialen Format beschreibt und diese anstelle des Standard-Template in .vue und eine Webpack Konfiguration kompiliert. Mehr zum serialen Format:

--dependencies: Wenn serial benutzt wird, nutzt der Webpack standardmäßig den Ordner, in der die angegebene JSON-Datei liegt um alle relativen Dependencies zu erreichen. Das Argument dependencies setzt diesen Ordner absolut. Das ist praktisch, wenn z.B. statt der ursprpünglichen JSON-Datei eine Kopie aus dem tmp eingelesen wird.

Update

Der update Command updated das Projekt initial vor einem Build oder Serve Prozess, um dabei einige Dinge zu optimieren. Im Grunde ist er eine potenzielle Schnittstelle, die im Projekt nochmal Dinge neu ordnen oder verändern kann.

Aktuell schreibt der Command nur die toolpicConfig aus der package.json Datei in eine seperate toolpic.config.json Datei innerhalb des public Ordners und ist den serve und build Befehlen vorgeschaltet. Im Grunde ist das keine wichtige Sache, wir könnten unsere toolpicConfig natürlich von Anfang an im public Ordner lassen, das ist nur meiner Ansicht nach nicht so schön wie als Teil der package.json.