Toolbox Extension Template

English description

Link zur deutschen Beschreibung

• Create a new git repository and copy all the files from this template to it.
• Run npm install first time to install the dependencies(Chioro Standard Library).
• To add a new tool edit extension.js. There is an example tool called niceFunction. The tools are written in JavaScript. For a detailed description of the sample code refer to the next section.
• After the functions are written, run npm test to run all the tests and make sure everything is working properly.

Anatomy of a tool

1. Here is the function itself. JavaScript is fully available, tools from the base package can be used with a prefix base.. In this example upperCaseText and lowerCaseText from the base package are used. With return the calculated value is returned.

2. Following is the information for chioro to manage the function:

   id and impl are the name of the function and must match the name in javascript

   aliases are the names of the function in the respective language. These names are displayed in the toolbox.

3. args are the input variables in the respective language.

4. tags any tags can be added. Tags are optional.

5. tests any number of tests can be added. With npm test the validity of the function is checked.

Deutsche Beschreibung

• Erstellen Sie ein neues git Repository und kopieren Sie alles aus dieser Vorlage dorthin.
• Führen Sie npm install einmalig aus um die Abhängigkeiten zu laden (Basic-Paket)
• Um ein neues Werkzeug hinzuzufügen, editieren Sie einfach extension.js. Es gibt ein Beispielwerkzeug namens niceFunction. Die Werkzeuge sind in JavaScript geschrieben. Eine detaillierte Beschreibung des Beispielcodes finden Sie im nächsten Abschnitt.
• Nachdem die Funktionen geschrieben wurden, führen Sie npm test aus, um alle Tests durchzuführen und sicherzustellen, dass alles richtig funktioniert.

Anatomie eines Werkzeugs

1. Hier steht die Funktion selber. JavaScript steht in vollem Umfang zur Verfügung, Werkzeuge aus dem Basis-Paket können mit einem vorangestellten base. verwendet werden. In diesem Beispiel werden upperCaseTextund lowerCaseText aus dem Basis-Paket verwendet. Mit return wird der berechnete Wert zurückgegeben.

2. Es folgen die Informationen für chioro um die Funktion zu verwalten:

   id und impl enthalten den Namen der Funktion und müssen dem Namen in Javascript entsprechen

   aliases sind die Namen der Funktion in der jeweiligen Sprache. Diese Namen werden in der Toolbox angezeigt.

3. args sind die Eingabe-Variablen in der jeweiligen Sprache

4. tags beliebige Tags können hinzugefügt werden. Tags sind optional.

5. tests Es können beliebig viele Tests hinzugefügt werden. Mit npm test wird die Gültigkeit der Funktion überprüft.