Wskazówki dotyczące używania wtyczek jQuery i ich zależności

Question

Wtyczki jQuery często mają zależności od zewnętrznych plików: biblioteka jQuery, arkusze stylów (CSS), obrazy, inne wtyczki itp. Jakie są wytyczne dotyczące używania (i pisania) wtyczek jQuery, które zająć się rozmieszczeniem zależności? Innymi słowy, gdzie powinny znajdować się wymagane pliki: pod głównymi folderami aplikacji (Img, Css, JS lub jakiekolwiek inne foldery, których używasz), pod folderem wtyczek (np. Wtyczki/MyPlugin/Img, wtyczki/MyPlugin/Css, itp.), albo coś innego?

Po dodaniu kilku wtyczek do projektu, obawiam się, że inni członkowie projektu będą mieli trudności z ustaleniem, które zależności są wymagane i które pliki powinny być tam, gdzie.

Co działało i nie działało dla Ciebie?

Answer 1

Osobiście, gdy buduję wtyczkę, staram się ją w jak najmniejszym stopniu uzależnić od innych zasobów, aby uniknąć tego problemu. Czasami nie można uniknąć używania zewnętrznych arkuszy stylów, w którym to przypadku zawsze umieszczałem je z innymi plikami CSS, nawet jeśli są one pierwotnie zawarte w tym samym folderze co wtyczki. Pozwala to uniknąć jakichkolwiek niejednoznaczności przy podejmowaniu decyzji, które arkusze stylów powinny znaleźć się w miejscu itp. Będziesz musiał ręcznie je uwzględnić. Jeśli wtyczka ma jakieś zależności, przechodzą do folderu JS, zorganizowanego w podobny sposób, jak inne wtyczki. Obrazy, w tym przypadku, byłyby następnie ze wszystkimi innymi obrazami.

Podczas budowania wtyczki można ją uelastycznić, umożliwiając użytkownikowi zdefiniowanie klas, które są stosowane do określonych obiektów, lub pozwolić użytkownikowi zdefiniować strukturę tego, co wtyczka będzie manipulować. Wszystko to można zrobić, nadając mu zestaw dobrych wartości domyślnych, a jednocześnie polegając na zasobach zewnętrznych w jak najmniejszym stopniu.

Jeśli chodzi o określenie najlepszych praktyk w tych sytuacjach, nie znalazłem jeszcze żadnych. Wskazówki dotyczące tworzenia wtyczek znalazłem tylko na stronie jQuery: http://docs.jquery.com/Plugins/Authoring.

EDIT:

Jako wyjaśnienie o organizację plugin zależność:

Kiedy powiedzieć masz jquery.x.js i jquery.y.js. Oba zależą od jquery.z.js. Zawsze umieszczam plik jquery.z.js w tym samym folderze co pliki jquery.x.js i jquery.y.js. Pozwala to uniknąć powielania i wszelkich nieporozumień związanych z łamaniem konwencji organizacyjnej. Więc:

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

normalnie organizować foldery, takie jak:

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