Visual Studio Extension 'ioBroker.javascript'

Ich habe eine Visual Studio Code (VS Code) Extension geschrieben um Skripte für den javascript Adapter entwickeln zu können:

Hintergrund
In meiner ioBroker Installation habe ich inzwischen viele Javascript/Typescript-Skripte, welche ich schon länger in VS Code schreibe, mit Git versioniere und seither bei jeder Änderung von Hand in das Webinterface kopiert habe. Um mir die Skriptentwicklung etwas zu vereinfachen (und weil ich einfach mal eine VS Code Extension schreiben wollte ) , habe ich die letzten Tage die hier vorgestellte Extension entwickelt.

Wie installiere ich die Extension?
Die Extension ist im Marketplace zu finden und kann wie jede andere VS Code Extension auch direkt über VS Code installiert werden: Link zur Extension

Gibt es eine Dokumentation?
Ja, aber nur auf Englisch: Dokumentation

Ich habe einen Fehler gefunden
Am besten direkt einen Issue in GitHub schreiben. Alternativ hier im Thread antworten.

Das hier ist die erste Version, die ich veröffentliche und ich habe noch einige Ideen, die ich gerne umsetzen möchte.

Ich freue mich über Feedback und Anregungen.

Zum Schluss nochmal die wichtigen Links:
VS Code Marketplace: https://marketplace.visualstudio.com/items?itemName=nokxs.iobroker-javascript
GitHub: https://github.com/nokxs/iobroker-javascript-vs-code-extension

Hallo zusammen,

es geht um folgendes:

TL;DR;
Nachdem ich nichts passendes gefunden habe, habe ich angefangen ein kleines Framework zum automatierten Testen von ioBroker Skripten zu schreiben. Links am Ende des Posts.

Hintergrund:
Inzwischen habe ich einige Skripte und immer wieder mache ich ausversehen etwas kaputt, da ich zu faul bin immer alles manuell zu testen. Aus diesem Grund habe ich nach einer Möglichkeit gesuchts Tests zu schreiben, welche mir automatisiert Rückmeldung über den aktuellen Zustand geben. Ich verwalte meine Skripte in einem Git-Repository bei Azure DevOps und wollte deren kostenlosen CI Dienst nutzen. Zudem habe ich ein Möglichkeit gesucht Fehler in Skripten bequem über einen Debugger (in meinem Fall Visual Studio Code) debuggen zu können.

TestIo - ioBroker JavaScript Test Framework
Aus diesem Grund habe ich das Framework TestIo geschrieben, welches es ermöglicht die ioBroker spezifischen JavaScript Funktionen zu mocken und testbar zu machen. Aktuell ist das alles in einem sehr einfachen Zustand, wobei die meisten ioBroker-Skripte zumindest rudimentär tesbar sein sollten.

Github: https://github.com/nokxs/TestIo
NPM: https://www.npmjs.com/package/iobroker-test-io

Geplant sind in nächster Zukunft

• Tests für das Framwork, welche auch gleichzeitig dokumentieren, wie dieses zu verwenden ist
• TypeScript Unterstützung
• Validierung der Funktions-Parameter

P.S.: Da ich neu hier im Forum bin: Falls dies der falsche Ort für diesen Post war, bitte an den richtigen verschieben.

@feuersturm @Gargano Ich habe das Problem bei ioBroker (current script) gefunden: Wenn die Skripte direkt im root lagen, gab es ein Fehler. Mit der neusten Version sollte der Fehler behoben sein:

https://github.com/nokxs/iobroker-javascript-vs-code-extension/releases/tag/v0.7.2

@obitobi Falls ich das umsetze, muss man es aktiv irgendwo aktivieren und im Standard wird es aus sein. Bei mir würde das vermutlich auch nur zu Chaos führen.

@arteck

Mein Test-Code sieht genau so aus wie im Beispiel, mit dem Unterschied, dass ich keine User angegeben habe:

sendTo('telegram.0', 'ask', {
    text: 'Are you sure?',
    reply_markup: {
        inline_keyboard: [
            // two buttons could be on one line too, but here they are on different
            [{ text: 'Yes!',  callback_data: '1' }], // first line
            [{ text: 'No...', callback_data: '0' }]  // second line
        ]
    }
}, msg => {
    console.log('user says ' + msg.data);
});

Im Code des Adapters gibt es folgende Stelle (main.js:2040):

adapter.config.answerTimeoutSec = parseInt(adapter.config.answerTimeoutSec, 10) || 60;
adapter.config.answerTimeoutSec *= 1000;

Dort wird der Timeout gelesen, allerdings habe ich wie @dslraser keine Stelle gefunden diesen zu konfigurieren. Deshalb habe ich versucht direkt beim Objekt des Adapters über den Expert-Mode dieses Datum zu setzen, allerdings hat das auch nicht funktioniert.

Mit VS Code 1.52.1 sollte es prinzipiell laufen. Das sollte schon mal nicht das Problem sein.

Ich habe die Extension gerade auf einem zweiten Rechner installiert und dort hab ich die gleichen Probleme wie du.

Ich schau mir das heute Abend nach der Arbeit mal an und melde mich dann nochmal hier.

@Feuersturm Danke fürs Raussuchen der Werte. Das Problem ist auf jeden Fall die Groß-/Kleinschreibung. Ich werde den Vergleich ändern, damit die Groß-/Kleinschreibung ignoriert wird.

@rosi8818 Ich bin dankbar für jeden Tester und ich freue mich auch, wenn meine Arbeit auch anderen zugute kommt . Auch finde ich es super möglichst viele verschieden "Arten" von Anwender zu haben, sprich auch Neulinge sollen mit der Extension zurecht kommen und einen Mehrwert durch diese haben. Nur so wird das irgendwann mal eine runde Sache .

Es macht übrigens erst einmal gar nichts aus, den .iobroker Ordner zu löschen. Wenn der Ordner allerdings gelöscht ist, wird eine Autovervollständigung der ioBroker Funktionen (z.B. setState(...)) auf keinen Fall mehr funktionieren.

@patrickbs96 Ich werde mir das als nächstes mal anschauen und bekomme die Intellisense hoffentlich stabil zum Laufen

Für alle interessierten: Ich hab gerade ein neues Release der Extension veröffentlicht: https://github.com/nokxs/iobroker-javascript-vs-code-extension/releases/tag/v0.9.0

Intern hat sich in diesem Release sehr viel verändert. Unter anderem werden die Namen der Skripte jetzt anders ausgelesen, da es bei Skripten mit Sonderzeichen wie zB. "_" zu Problemen gekommen ist.

Ich empfehle die Skripte lokal zu löschen und neue herunterzuladen, damit zukünftige Probleme vermieden werden.

@feuersturm Ich kann das Problem bei mir nachvollziehen. Es ist bei mir so, dass das Skrip zwar nach einem Klick gestartet/gestoppt, der Status im Script Explorer aber nicht richtig aktualisiert wird. Ich hab hierfür einen neuen Issue in GitHub angelegt: https://github.com/nokxs/iobroker-javascript-vs-code-extension/issues/31

nokxs created this issue in nokxs/iobroker-javascript-vs-code-extension

closed Script status is not updated correcly in script explorer #31

Hallo,

folgendes Szenario:

Ich habe zwei globale Skripte:

global/Room.ts:

export enum Room {
    LivingRoom,
    Kitchen
}

global/TemperatureSensor.ts:

class TemperatureSensor {
    constructor(room: Room) {
       // Do something with room
    }
}

class TemperatureSensors {
    public static mySensor = new TemperatureSensor(Room.Kitchen);
}

Das ganze funktioniert bei mir nicht, da der Compiler mit folgender Meldung den Dienst quittiert:

javascript.1 (1510) script.js.global.TemperatureSensor: TypeScript compilation failed: constructor(room: Room) { ^ ERROR: Cannot find name 'Room'. public static mySensor = new TemperatureSensor(Room.Kitchen); ^ ERROR: Cannot find name 'Room'. constructor(room: Room) { ^ ERROR: Parameter 'room' of constructor from exported class has or is using private name 'Room'.

Gibt es einen Trick, wie ich Typen aus einem globalen Skript in einem anderen globalen Skript verwenden kann?

@scrounger Drück Mal Strg + . nachdem du das erste Zeichen in dem String, also die "0" geschrieben hast. Zumindest in der VS Code Standardeinstellung sollte dann das IntelliSense Pop-up aufgehen.

@scrounger Ich hatte gerade sowiso an einem neuen Release für die Extension gearbeitet (v1.2.0), da hab ich das gleich miterledigt. Ich hab deine Anfrage in zwei Config-Werte aufgeteilt:

1. Automatisches Hochladen des Skripts. Config-Wert autoUpload
2. Autoamtsiches starten eines Skripts nach dem Hochalden: Config-Wert scriptAutoRun

Passt das so für dich?

Die zwei anderen neuen Features, die ich eingebaut habe finde ich auch ganz cool.

1. Wert anzeigen, welcher hinter einer State-Id steckt, wenn man über den entsprechden String hovert:
   
2. IntelliSense (Auto Completion) für State Ids:
   

PS: Als Unterstützung für das Projekte freue mich immer, wenn ich bei GitHub einen Stern bei dem Projekt bekomme

@obitobi Falls ich das umsetze, muss man es aktiv irgendwo aktivieren und im Standard wird es aus sein. Bei mir würde das vermutlich auch nur zu Chaos führen.

@scrounger Stand jetzt gibt es das nicht. Es wäre glaub ich aber gar nicht so kompliziert umzusetzen. Wenn du dir das wünscht kannst du gerne einen GitHub Issue mit ein paar Details wie du dir es genau vorstellst schreiben

@legro Freut mich, dass es inzwischen funktioniert. Falls du rausfinden solltest, was bei dir die Probleme waren wäre es gut, wenn du die mir mitteilst. Ich kann den Versuchen die Extension robuster zu machen, sodass andere nicht in die gleichen Probleme reinlaufen.

@patrickbs96 Für das Admin6 Thema hab ich mal einen Issue angelegt: https://github.com/nokxs/iobroker-javascript-vs-code-extension/issues/105. Aktuell ist es aber egal, ob man Admin5 oder Admin6 einstellt. Im Hintergrund passiert genau das gleiche

@legro Öffne mal den Ordner in VS Code, in welchem die Skripte später landen sollen:

Danach probier es nochmal mit dem Wizard. Wenn das bei dir nicht klappt lege in dem von dir geöffneten Ordern von Hand die .iobroker.config an, wie von @patrickbs96 vorgeschlagen.

Mit deiner Admin Version sollte es keine Probleme geben, da ich auch die 6.2.23 verwende und es bei mir funktioniert.

nokxs created this issue in nokxs/iobroker-javascript-vs-code-extension

closed Add Admin6 to Wizard #105

@legro Sorry, dass ich für die Antwort so lange brauche, hatte aber schon länger hier nicht mehr reingeschaut.

Erst mal zur Klarstellung: Die Extension baut eine Verbindung über Websocket direkt mit dem ioBroker Admin auf. Mit SSH hat das ganze nichts zu tun. Daher ist es schon richtig den ioBroker Benutzer und dessen Passwort zu verwenden.

@legro verwendest du https um auf deine ioBroker Instanz zuzugreifen? Wenn ja, musst du das auch so in der .iobroker.config angeben. Diese ist im Root-Verzeichnis deines VS-Code Workspaces zu finden, nachdem du den initialen Wizard einmal durchgemacht hast. Solltest du Probleme mit dem Wizard haben, kannst du die .iobroker.config auch von Hand anlegen. Eine Beispieldatei findest du hier: https://github.com/nokxs/iobroker-javascript-vs-code-extension/blob/main/doc/.iobroker-config.json

Die verfügbaren Optionen sind hier beschrieben: https://github.com/nokxs/iobroker-javascript-vs-code-extension#available-settings

@fastfoot Ich hab jetzt deinen Vorschlag umgesetzt, die Zeile gepatcht und es funktioniert .

Falls ich etwas Zeit finde baue ich die Konfiguration in die GUI ein und mache einen Pull Request .

Danke für die schnelle Hilfe.

@arteck

Mein Test-Code sieht genau so aus wie im Beispiel, mit dem Unterschied, dass ich keine User angegeben habe:

sendTo('telegram.0', 'ask', {
    text: 'Are you sure?',
    reply_markup: {
        inline_keyboard: [
            // two buttons could be on one line too, but here they are on different
            [{ text: 'Yes!',  callback_data: '1' }], // first line
            [{ text: 'No...', callback_data: '0' }]  // second line
        ]
    }
}, msg => {
    console.log('user says ' + msg.data);
});

Im Code des Adapters gibt es folgende Stelle (main.js:2040):

adapter.config.answerTimeoutSec = parseInt(adapter.config.answerTimeoutSec, 10) || 60;
adapter.config.answerTimeoutSec *= 1000;

Dort wird der Timeout gelesen, allerdings habe ich wie @dslraser keine Stelle gefunden diesen zu konfigurieren. Deshalb habe ich versucht direkt beim Objekt des Adapters über den Expert-Mode dieses Datum zu setzen, allerdings hat das auch nicht funktioniert.