2009-08-11 20 views
9

jQueryプラグインは、多くの場合、外部ファイル(jQueryライブラリ、スタイルシート(CSS)、画像、その他のプラグインなど)に依存します。依存関係の配置に対処する?つまり、プラグインフォルダ(例:Plugins/MyPlugin/Img、Plugins/MyPlugin/Cssなど)の下にあるメインアプリケーションフォルダ(Img、Css、JSなどのフォルダ)または、他の何か?jQueryプラグインとその依存関係を使用するためのガイドライン

プロジェクトにいくつかのプラグインを追加した後、他のプロジェクトメンバーは、どの依存関係が必要か、どのファイルをどこに置くべきかを判断するのに苦労します。

あなたはうまくいけませんでしたか?

+0

何のガイドラインはありません!ファイルをどのように整理するかは、単に優先事項です。 –

答えて

6

個人的には、私はプラグインをビルドするときに、この問題を回避するために他のリソースにできるだけ依存しないようにしています。時には、外部スタイルシートの使用を避けることはできません。その場合は、もともとプラグインと同じフォルダに含まれていても、他のCSSファイルに入れてしまいます。これは、どのスタイルシートをどこに置くべきかを決定しようとするときに曖昧さを避けます。あなたは手動でそれらを含める必要があります。プラグインに依存関係がある場合、プラグインはJSフォルダに入り、他のプラグインと同様に構成されます。この場合、イメージは他のイメージのすべてと一緒に行きます。

プラグインをビルドするときに、ユーザーが特定のオブジェクトに適用されるクラスを定義できるようにするか、プラグインが操作する構造をユーザーが定義できるようにすることで柔軟にすることができます。これらのすべては、外部リソースにできるだけ頼らずに従うべき適切なデフォルトのセットを与えながら実行できます。

このような状況でベストプラクティスが定義されているかどうかは、まだわかりません。私は、jQueryサイトのプラグインオーサリングガイドライン:http://docs.jquery.com/Plugins/Authoringしか見つけられませんでした。

EDIT:依存関係団体のプラグインについて明確にしたよう

をあなたはjquery.x.jsとjquery.y.jsを持っていると言うとき。どちらもjquery.z.jsに依存しています。私はいつもjquery.z.jsをjquery.x.jsとjquery.y.jsと同じフォルダに入れています。これにより、組織コンベンションの崩壊に関連する重複や混乱を避けることができます。だから、:

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

私は普通のような私のフォルダを整理します

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

良い提案。 1つの質問:プラグインZに依存するプラグインXとYがあるとします.XとYの下でJSフォルダにZを配置すると、プロジェクトでXとYを使用すると、重複や競合の可能性はありますか?あなたはXまたはYのフォルダから一度だけそれを含めますか?あなたはスタンドアロンのプラグインとしてZを含めるだけで参照のコピーを保持しますか?他に何か? –

+0

@Alek、あなたのコメントに答えるために投稿を更新しました。 – Tres

+0

クール、ありがとうトレス。これはいい。 –

関連する問題