TOPシステム開発> 自作ライブラリをJSANで公開!
まるごとJavaScript&Ajax!
JSライブラリ・ラボ - これで君もライブラリ開発者だ!

第6回:自作ライブラリの公開とJavaScriptライブラリの今後
著者:川崎 有亮   2007/4/11
1   2  次のページ
自作ライブラリをJSANで公開!

   JSAN(JavaScript Archive Network、図7)は、2005年7月にオープンしたJavaScriptライブラリの共有・公開サイトです。ユーザー登録すれば、誰でも無料で自作JavaScriptライブラリをアップロード・公開することができます。
JSAN
図7:JSAN


   JSANはもともとPerlエンジニアを中心として、Perlモジュールの共有・公開サイトであるCPAN(Comprehensive Perl Archive Network)を参考に構築されました。JSANではJavaScriptソースコード本体に加えて、表6のようなファイルを添付した.tar.gz形式アーカイブとしてライブラリを配布します。

ファイル名 内容
JSAN-0.10/lib/JSAN.js JavaScriptライブラリ本体
JSAN-0.10/Changes 更新履歴
JSAN-0.10/MANIFEST アーカイブに含まれるファイル一覧
JSAN-0.10/META.yml 管理用メタファイル(YAML形式)
JSAN-0.10/README お読み下さい
JSAN-0.10/doc/html/JSAN.html ドキュメント
JSAN-0.10/tests/index.html テスト用Webページ
JSAN-0.10/tests/lib/Test/Builder.js テスト用JavaScriptライブラリ(JSANで公開されているもの)
JSAN-0.10/tests/lib/Test/Harness.js
JSAN-0.10/tests/lib/Test/Harness/Browser.js
JSAN-0.10/tests/lib/Test/Harness/Director.js
JSAN-0.10/tests/lib/Test/More.js
JSAN-0.10/tests/lib/Test/Simple.js

表6:JSAN配布用パッケージの構成ファイル例

   JavaScriptソースファイル本体は、アーカイブのlibディレクトリ内に配置します。ライブラリの正式名称やバージョン番号、作者連絡先などはリスト11のようなメタファイルに記述します。このMETA.ymlはYAML形式のテキストファイルで、ライセンスや他ライブラリの依存関係なども記載できます。

リスト11:META.ymlファイルの例
---
name: JSAN
version: 0.10
author:
   - Casey West <casey@geeknest.com>
abstract: JavaScript Archive Network
license: artistic
build_requires:
   Test.Simple: 0.11
provides:
   JSAN:
      file: lib/JSAN.js
      version: 0.10
generated_by: Module::Build version 0.2701
keywords:
   - jsan
   - use
   - import
   - libraries

   JSANでは、テスト用のJavaScriptライブラリが提供されている点も大きな特徴です。少々使い方にクセがありますが、自作ライブラリを公開する前にテストできるのはライブラリ作者としても不具合や副作用の心配がなく、ライブラリ利用者にとっても安心でしょう。

   また現在のJSAN仕様では、ライブラリ使用方法などのドキュメントをJavaScriptソースファイル中にPOD形式(Perlモジュールのドキュメント記述書式)で記述するのが標準です。ただし、実際にはPODを利用していないライブラリも多いですし、形式にはこだわらずにHTMLなど記述しやすいフォーマットで分かりやすいドキュメントファイルが添付されていれば良いのではないでしょうか。


ユーザー登録とライブラリのアップロード

   自作したJavaScriptライブラリをJSANで公開するには、ユーザー登録が必要です。JSANのサイト上の表記は英語のみで日本語メニューなどは用意されていませんが、手順は簡単ですからぜひトライしてみてください。まずは、トップページ左側の「Contribute」のリンクをクリックし、「Register」からユーザー登録を行います。

   JAUSE ID欄には、自分につけるユーザー名を入力します。筆者は「kawasaki」というIDを利用しています(注11)。


   Password・Verify Password欄は、認証用パスワードを入力します。

   Name欄は名前を入力します。ローマ字で記述した方が無難です。加えてEmail Address欄、Website URL欄を入力したら、「Create」ボタンを押すだけでユーザー登録が完了します。

   「Login」メニューから登録したJAUSE IDおよびパスワードを入力してログインしてください。

   最後に「Upload」メニューでJavaScriptライブラリの.tar.gz形式の配布アーカイブをアップロードすれば、ライブラリがJSAN上で公開されます。

   なお、執筆時点のJSANでは、ユーザー登録やアップロード関係の画面でSSL証明書の警告が表示されます。少々不安感はありますが、気にせずそのまま進めてください。

   また、JSANのシステム自体にバグがあるのか、アップロードライブラリが即時には公開されずにサーバー内部で留まってしまう事例も多数報告されています。数日待っても公開されない場合は、メーリングリストで問い合わせてみるのが良いでしょう。

1   2  次のページ

川崎 有亮
著者プロフィール
川崎 有亮
1977年東京生まれ。AjaxなどWeb技術のアーキテクト。株式会社かっぺを経て、現在は株式会社リクルート事業開発室に所属。技術評論社「Ajax/実装のための基礎テクニック」(共著)など書籍・雑誌記事の執筆も多数。

Kawa.net xp:http://www.kawa.net/


INDEX
第6回:自作ライブラリの公開とJavaScriptライブラリの今後
自作ライブラリをJSANで公開!
  Kawa.net XPで公開されるJavaScriptライブラリの裏側