Frage aus der Praxix: Scriptbibliotheken

drfoots

Hallo,

ich hab mal eine Frage.

Wie geht ihr in Eurer Praxis damit um, wenn Ihr Scripte mit wiederkehrenden Funktionen habt?

Habt Ihr eine Scriptdatei mit vielen Funktionen drin und ladet die dann in das aktuelle Script per #include ein oder kopiert Ihr jedes mal die passende Funktion in das neue Script?

Lohnt sich der Aufbau einer Gesamtbibliothek (im Stil von z.B. jquery) auf für Indesign Scripte oder hat das eher Nachteile?

Wie geht Ihr damit um?

Viele schöne Grüße und bleibt gesund
drfoots

WernerPerplies

Moin,

Das hängt wohl davon ab, wie komplex Deine Skripte sind.

Ich schreibe sehr umfangreiche Skripte und habe diverse Funktionen, Klassen und Meldungsdateien, da geht dann nichts mehr mit Copy und Paste.

Ich habe deshalb ein Grundgerüst, neudeutsch wohl Framework :-) und füge notwendige Dateien per include hinzu.

Vor Auslieferung erzeuge ich dann per Skript eine Gesamtdatei.

Die Anfangsversion dieses Skriptes kannst Du hier finden:
WpsIncludesInCludes

drfoots

Moin Werner,

danke für die Rückmeldung.

Als Skriptanfänger ist alles über 20 Zeilen schon komplex und dann noch die Kommentare dazu, damit man es später auch noch nachvollziehen kann was und warum man gemacht hat.

Wollte daher einfach mal hören, wie andere das machen und was man möglichst von Anfang an besser, einfacher oder richtiger machen kann.

Besten Dank und beste Grüße
drfoots

TMA

Moin,
da wir hier mehrere hundert Scripte im Einsatz haben, kommt man um Libraries nicht herum.

Die Libs sind so aufgeteilt das z.B. allgemeine Funktionen eine eigene 'mainLib' haben. Für Photoshop, InDesign, SQL, etc. gibt es auch jeweils eine eigene Lib. Jede enthält bis zu ca. 3.500 Zeilen Code.

Die letzte große Umstellung bei den Applescripten war die Umstellung von der Nutzung der Satimage.osax auf ASOC.
Auch für Javascript nutzen wir Bibliotheken.

Dank der Libs war die Umstellung recht einfach und ging zügig vorran. Die einzelnen Handler/Functions/Methods konnte ich vom Namen und der Übergabeparamter größtenteils so lassen. Somit brauchte ich später in den eigentlichen Scripten nur die neue ASOC-Lib einbinden und schon lief alles wie gewohnt.

Gruß
TMA

Gerald_Singelmann

Fürs eigene Haus sind Bibliotheken durchaus praktisch.

Aber ich hatte noch keinen Kunden, der damit klar kam.
Letztlich habe ich mir einen einfachen Bundler schreiben müssen, um Scripte an Kunden als eine Datei auszuliefern.

WernerPerplies

Moin Herr Singelmann,

Das ist genau das, was mein WpsIncludesInCludes macht,
aber in der von mir verwendeten Version erzeugt es auch noch daraus ein Binärskript und verpackt dann dieses Skript in ein Installationskript, dass sich um die Einrichtung aller notwendigen Dateien und Verzeichnisse kümmert.

drfoots

Danke für die vielen Antworten.

Gibt es denn auch irgendwelche Nachteile bei der Arbeitsweise mit Bibliotheken?

z.B. Laufzeitverlängerungen, höhere Gefahr von Abstürzen oder ähnliches oder kann man das ganz problemlos machen?

Mal abgesehen von einfachen Problemen wie doppelt vergebenen Variablen.

Viele Grüße
drfoots

WernerPerplies

Aus meiner Sicht gibt es keinen Nachteil, aber es hängt natürlich davon ab, wie Du Deine Bibliothek organisierst.

Sofern Du alle Deine Funktionen im globalen Bereich definierst und Sie dann auch alle in eine Datei speicherst und einbindest, ist natürlich das Chaos garantiert.

Ich habe meine Module recht klein organisiert und stelle sie dann mit Include zu einer Gesamtfunktion zusammen.

Das sieht dann beispielsweise so aus:
// DESCRIPTION wpsGetVersionPath

// Dateiname: wpsGetVersionPath.jsx

// © 2018 - 2019 by Werner Perplies, EDV-Anwendungsberatung,

// https://www.weepee.de, email: werner.perplies@weepee.de

// modified: 201905091202

// modified: 201905090809

// created: Sat Jan 20 2018 09:17:11 GMT+0100

// lastFileProps: {"date":"201905091202","scriptVersion":2.13,"size":785,"checkSum":"13a5de5d","time":"1557396129404","scriptDate":"201808020846"}

// #include "C:/Users/WernerPerplies/Source/Workspaces/Singles/InDesigns/FileHandling/wpsGetVersionPath.jsx";

// [end of header]



#include "C:/Users/WernerPerplies/Source/Workspaces/Singles/ErrorHandling/wpsErrorClass.jsx"

#include "C:/Users/WernerPerplies/Source/Workspaces/Singles/wpsGetInddVersion.jsx";



/*Folder*/function wpsGetVersionPath()

{

    try

    {

        var /*String*/scriptPath = "", basePath = Folder.userData.fullName+"/"+"Werner Perplies, EDV-Anwendungsberatung/",

            /*String*/inddVersion = wpsGetInddVersion(app.version, true);

            

        basePath += inddVersion.substr(0, inddVersion.indexOf(".")) + "/";       

        return Folder(basePath);

    }

    catch (error)

    {

        wpsHandleError(error, $.stack, "wpsGetVersionPath");

    }

    return null;

}
An diesem Beispiel kannst Du auch sehen, das Du Includes schachteln kannst. Beachten musst Du nur, dass sich im gleichen Adressraum mehrfach geladene Module überschreiben und dann das zuletzt geladene Modul ausgeführt wird.

Bei vielen tiefgeschachtelten Includes kann sich die Ladezeit eines Skriptes erheblich erhöhen, deshalb füge ich am Schluss alle benötigten Module in einer Datei zusammen und speichere sie als ab.

Solange Du Deine Variablen sauber deklarierst (var!) und die Sichtbarkeit von Variablen und Objekten beachtest, sollte das kein Thema sein.

drfoots

Moin Werner,

danke für das Beispiel.
Dann werd ich mal schauen wie ich Deine und Eure Hinweise umsetzen kann. :)

Viele schöne Grüße und bleibt gesund
drfoots

Peda

Danke, drfoots, für die interessante Frage.
Ich habe hier sehr neugierig mitgelesen.