Richtlinien für die Verwendung von jQuery Plugins und deren Abhängigkeiten

Question

jQuery Plugins haben oft Abhängigkeiten zu externen Dateien: jQuery-Bibliothek, Stylesheets (CSS), Bilder, andere Plugins, usw. Was sind die Richtlinien für die Verwendung (und Schreiben) von jQuery-Plugins die Platzierung der Abhängigkeiten adressieren? Mit anderen Worten, wo sollen die benötigten Dateien hingelangen? Unter den Haupt-App-Ordnern (Img, Css, JS oder welche Ordner auch immer), unter Plugin-Ordner (zB Plugins/MyPlugin/Img, Plugins/MyPlugin/Css, etc) oder etwas anderes?

Nachdem ich mehrere Plugins in das Projekt aufgenommen habe, mache ich mir Sorgen, dass andere Projektmitglieder es schwer haben herauszufinden, welche Abhängigkeiten benötigt werden und welche Dateien wohin gehen sollen.

Was funktioniert und hat nicht für Sie funktioniert?

Answer 1

Persönlich, wenn ich ein Plugin erstelle, versuche ich es so wenig wie möglich von anderen Ressourcen abhängig zu machen, um dieses Problem zu vermeiden. Manchmal kann man nicht vermeiden, externe Stylesheets zu verwenden. In diesem Fall habe ich sie immer in meine anderen CSS-Dateien eingefügt, selbst wenn sie ursprünglich in demselben Ordner wie die Plugins enthalten sind. Dies vermeidet jede Mehrdeutigkeit bei dem Versuch, zu entscheiden, welche Stylesheets wohin gehen sollen usw. Sie müssen sie trotzdem manuell einfügen. Wenn das Plugin irgendwelche Abhängigkeiten hat, gehen sie in den JS-Ordner, der ähnlich wie die anderen Plugins organisiert ist. Bilder würden in diesem Fall dann mit allen anderen Bildern gehen.

Wenn Sie ein Plugin erstellen, können Sie es flexibler gestalten, indem Sie dem Benutzer erlauben, die Klassen zu definieren, die auf bestimmte Objekte angewendet werden, oder den Benutzer die Struktur dessen definieren lassen, was das Plugin manipuliert. All dies kann getan werden, während man ihm eine Reihe von guten Vorgaben gibt, denen man folgt, während man sich so wenig wie möglich auf externe Ressourcen verlässt.

Ob Best Practices für diese Situationen definiert wurden, habe ich noch nicht gefunden. Ich habe nur die Authoring-Richtlinien für das Plugin auf der jQuery-Site gefunden: http://docs.jquery.com/Plugins/Authoring.

EDIT:

Wie über Plugin Abhängigkeits Organisation zu klären:

Wenn Sie sagen, jquery.x.js und jquery.y.js haben. Beide hängen von jquery.z.js ab. Ich habe jquery.z.js immer in den gleichen Ordner wie jquery.x.js und jquery.y.js gestellt. Dies vermeidet Doppelarbeit und jegliche Verwirrung im Zusammenhang mit der Verletzung der organisatorischen Konvention. Also:

• ./jquery.x.js
• ./jquery.y.js
• ./jquery.z.js

ich normalerweise meine Ordner als solche organisieren:

• ./js/jquery-xxxjs
• ./js/plugins/jquery.x.js
• ./js/plugins/jquery.y.js
• ./js/plugins/jquery.z.js