Skip to content

README_de.md

Latest commit

 

History

History
180 lines (118 loc) · 6.68 KB

README_de.md

File metadata and controls

180 lines (118 loc) · 6.68 KB
Raw

Scripting-App-Befehlszeilentool

Willkommen beim scripting-cli, dem Befehlszeilentool für die Integration mit der Scripting-App. Dieses Tool ermöglicht es Ihnen, Ihre Skripte in Echtzeit zu synchronisieren und während der Entwicklung mit Ihrem bevorzugten Desktop-Editor (VSCode, Cursor, Windsurf, Zed, WebStorm, Vim und mehr) anzuzeigen.

English | 中文 | 日本語 | Français | Italiano

Voraussetzungen

Bevor Sie scripting-cli verwenden, stellen Sie sicher, dass die folgenden Anforderungen erfüllt sind:

  1. Node.js: Stellen Sie sicher, dass eine aktuelle Version von Node.js installiert ist. Überprüfen Sie Ihre aktuelle Version mit:

    node -v

  2. Scripting-App: Die Scripting-App muss installiert sein, um eine Verbindung mit dem lokalen Dienst herzustellen, der von scripting-cli gestartet wird.

Installation

Es ist keine globale Installation von scripting-cli erforderlich. Führen Sie es einfach mit npx aus:

npx scripting-cli <command>

Verwendung

1. Arbeitsverzeichnis erstellen

Erstellen Sie ein Verzeichnis, in dem Ihre Scripting-App-Skripte gespeichert werden. Zum Beispiel:

mkdir my-scripting-project
cd my-scripting-project

2. Lokalen Dienst starten

Führen Sie im Arbeitsverzeichnis den folgenden Befehl aus, um den lokalen Entwicklungsdienst zu starten:

npx scripting-cli start

Standardmäßig wird der Dienst auf Port 3000 gestartet. Um einen anderen Port anzugeben, verwenden Sie die Option --port:

npx scripting-cli start --port=4000

Um Bonjour-Unterstützung zu aktivieren, sodass die Scripting-App den lokalen Dienst automatisch erkennt, fügen Sie das Flag --bonjour hinzu:

npx scripting-cli start --bonjour

3. Scripting-App verbinden

Sobald der Dienst läuft, öffnen Sie die Scripting-App und verbinden Sie sich mit dem gerade gestarteten lokalen Dienst. Dadurch wird eine Verbindung zwischen der App und Ihrem Arbeitsverzeichnis hergestellt.

4. Code debuggen und synchronisieren

Nach der Verbindung wählen Sie das Skriptprojekt aus, das Sie debuggen möchten. Die Scripting-App synchronisiert den Code dieses Projekts automatisch mit Ihrem Arbeitsverzeichnis.

5. Echtzeit-Code-Synchronisierung

Wenn Sie Skripte in Ihrem Desktop-Editor (z. B. VSCode) schreiben und speichern, werden die Änderungen automatisch mit der Scripting-App synchronisiert und in Echtzeit ausgeführt, was die Entwicklung und das Debugging erheblich erleichtert.

Editor-Auswahl und Konfigurationsdatei

scripting-cli ist nicht mehr an VSCode gebunden. Beim ersten Ausführen von npx scripting-cli start werden Sie aufgefordert, den Editor auszuwählen, den Sie tatsächlich verwenden. Ihre Auswahl wird in scripting.config.json im Projektstamm gespeichert, sodass die Abfrage nicht erneut erscheint.

Unterstützte Editoren

VSCode, VSCode Insiders, VSCodium, Cursor, Windsurf, Trae, Zed, WebStorm, IntelliJ IDEA, Fleet, Sublime Text, Nova, Vim, Neovim, Emacs sowie custom (beliebiger anderer Befehl) und none (automatisches Öffnen deaktivieren).

Editoren, die in Ihrem PATH erkannt werden, sind mit ✓ markiert und stehen ganz oben.

Überschreibung pro Ausführung

# Cursor nur für diese Ausführung verwenden (ändert scripting.config.json nicht)
npx scripting-cli start --editor=cursor

# Die interaktive Auswahl erneut ausführen und die gespeicherte Auswahl überschreiben
npx scripting-cli start --reconfigure

Konfigurationsdatei

scripting-cli sucht in dieser Reihenfolge nach der ersten gefundenen Konfigurationsdatei:

scripting.config.ts
scripting.config.mts
scripting.config.cts
scripting.config.js
scripting.config.mjs
scripting.config.cjs
scripting.config.json

Die Standarddatei ist JSON, damit der npx-Ablauf installationsfrei bleibt. TypeScript- und JavaScript-Dateien werden über jiti geladen.

// scripting.config.json
{
  "editor": "cursor",          // siehe unterstützte Editoren oben
  "editorCommand": "cursor",   // optional, überschreibt den Standardbefehl
  "editorArgs": [],            // optional, zusätzliche CLI-Argumente
  "port": 3000,
  "autoOpen": true,
  "generateTsConfig": true,    // auf false setzen, wenn Sie tsconfig.json selbst verwalten
  "logLevel": "info"           // "silent" | "error" | "warn" | "info" | "debug"
}

CLI-Flags haben Vorrang vor der Konfigurationsdatei.

Typvervollständigung (TypeScript-Konfiguration)

Um Autovervollständigung in scripting.config.ts zu erhalten, installieren Sie scripting-cli als Entwicklungsabhängigkeit:

npm i -D scripting-cli

Anschließend:

// scripting.config.ts
import { defineConfig } from 'scripting-cli'

export default defineConfig({
  editor: 'cursor',
  port: 4000,
})

Sie können .ts auch ohne Installation des Pakets verwenden – npx scripting-cli start lädt es weiterhin über jiti. Sie erhalten nur keine IDE-Typhinweise.

Beispiel-Workflow

  1. Lokalen Dienst starten:

    npx scripting-cli start

  2. Öffnen Sie Ihren Editor und schreiben Sie Ihr Skript.

  3. Speichern Sie die Skriptdatei.

  4. Der aktualisierte Code wird automatisch mit der Scripting-App synchronisiert und ausgeführt.

Zusätzliche Informationen

  • Der Standardport ist 3000. Wenn dieser bereits verwendet wird, geben Sie mit der Option --port einen anderen an.

  • Verwenden Sie das Flag --no-auto-open, um zu verhindern, dass das Tool automatisch index.tsx oder widget.tsx öffnet:

    npx scripting-cli start --no-auto-open

  • Verwenden Sie --editor=<key>, um den konfigurierten Editor für eine einzelne Ausführung zu überschreiben, oder --reconfigure, um die interaktive Editor-Auswahl erneut auszuführen.

  • Um den Bonjour-Dienst zu nutzen, stellen Sie sicher, dass Ihr System diese Funktion unterstützt. Unter Windows müssen Sie Bonjour möglicherweise manuell installieren. Verwenden Sie dann die Option --bonjour, um den Dienst zu aktivieren.

  • Dieses Tool funktioniert mit jedem Desktop-Editor und bietet eine nahtlose Code-Synchronisierung und Debugging mit der Scripting-App.

Fehlerbehebung

Wenn Sie auf Probleme stoßen, stellen Sie sicher, dass:

  • Sie Node.js Version 20 oder höher verwenden.
  • Die Scripting-App korrekt mit dem lokalen Dienst verbunden ist.
  • Der von Ihnen gewählte Port nicht von einem anderen Prozess verwendet wird.
  • Sie das Tool immer mit npx scripting-cli <command> ausführen und sicherstellen, dass das Paket auf dem neuesten Stand ist.

Viel Spaß beim Verwenden von scripting-cli in Ihrem Scripting-App-Entwicklungsworkflow! Viel Erfolg beim Codieren!