Mozilla Add-on Builderから Add-on SDKデスクトップ環境への移行方法

予てから告知があったとおり、2014年1月7日に Mozilla Add-on Builder(クラウドサービス)がリードオンリーモードに変更されました。
それに伴い、Firefoxの拡張機能の開発は Add-on SDKをインストールして PC上で行うことになりました。
もちろん、いままで Add-on Builderで開発してあった拡張機能を Add-on SDKのデスクトップ環境に移行する必要があります。

しかし、例によって移行方法はドキュメントが準備されていませんでしたので、移行方法をまとめておきます。



【準備】
1. Python 2.xのインストール
Add-on SDKのビルドツールは Pythonで記述されています。
Pythonのダウンロードページ(英語) http://www.python.org/download/releases/ から Python 2.xの最新版をダウンロードしてインストールしてください。
2014年1月13日現在、最新版は 2.7.6 となっています。

2. Add-on SDKのインストール
Mozillaの Add-on Developer HUB https://addons.mozilla.org/ja/developers/builder からAdd-on SDKをダウンロードしてください。
Add-on SDKは ZIP圧縮されていますから、ZIPを展開して任意の場所に置いてください。
2014年1月13日現在、最新版は 1.15となっています。
注: Add-on SDK 1.15で作成した拡張機能は Firefoxのバージョン20およびそれ以前のバージョンでは動作しません。

3. UTF8を読み書きできるテキストエディターの用意
Add-on SDKのソースコードは UTF8(BOMなし)のテキストファイルを使用していますので、UTF8を読み書きできるテキストエディターを用意してください。




【ソースコードのダウンロード】
リードオンリーモードになってしまった Add-on Builder https://builder.addons.mozilla.org/ にログインして、作成してあった拡張機能のソースコードをダウンロードしてください。
(画面上部に「XPIのダウンロード」と「ソースコードのダウンロード」のボタンが用意されています)

ソースコードは ZIP圧縮されていますから、ZIPを展開して任意の場所に置いてください。
(残念ながらいまのところ、開発した拡張機能をまとめてダウンロードする方法はありません。1個ずつ手作業でダウンロードなさってください。)

尚、下記のようなフォルダ構成にしておくといいでしょう。
C:\addons
+---addon-sdk-1.15 ← Add-on SDK
| +---app-extension
| +---bin ← ビルドツールが入っているフォルダ
| +---doc
| +---examples
| +---lib
| +---python-lib
| \---test
+---my-addon ← ダウンロードしたソースコード
| \---lib
\---packages ← 各拡張機能で参照するパッケージ(ライブラリ)を置いておくフォルダ




【XPIのビルド】
拡張機能のパッケージ(XPI)をビルドするのは、基本的にダウンロードしてZIPを展開したソースコードのフォルダでビルドツール cfx を実行するだけです。
上記のようなフォルダ構成になっていると仮定するとビルド手順は次のようになります。
  1. コマンドプロンプトを開く
  2. ソースコードのフォルダに cd(チェンジディレクトリ)する
  3. ..\addon-sdk-1.15\bin\activate を実行して、ビルド環境を初期化する
  4. cfx xpi を実行すると拡張機能のパッケージファイル(XPI)が生成される
もし、Add-on Builderで開発した拡張機能がライブラリを使用していた場合は、ソースコードに含まれているライブラリのフォルダを packagesに移動させてから
cfx xpi --package-path=..\packages と実行してください。

判ってしまえばどうってことないんですが、
  1. ダウンロードしたソースコードで cfxをそのまま実行できる
  2. ライブラリは packagesに置く
ということがドキュメント化されていないのでちょっと苦労しました




【おまけ】
ネットワークツール "wget" と拡張機能 "Extension Auto-Installer"を利用すると、ビルドした拡張機能のインストールが簡単になります。
(バッチコマンド化することで、ビルドとインストールをまとめて実行することもできます)

"wget"はお使いのPC環境に合ったものを拾ってきてください。
拡張機能 "Extension Auto-Installer"は AMO https://addons.mozilla.org/ja/firefox/addon/autoinstaller/ からインストールできます。



【参考】
Mozilla Developer Networkに Add-on SDKの使用方法があります。(英語)
Installation
https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Installation

Getting Started With cfx
https://developer.mozilla.org/en-US/Add-ons/SDK/Tutorials/Getting_Started_With_cfx

cfx
https://developer.mozilla.org/en-US/Add-ons/SDK/Tools/cfx





[2014/01/23 追記]
【準備】に「UTF8を読み書きできるテキストエディターの用意」の項を追記しました。

ブログ気持玉

クリックして気持ちを伝えよう!

ログインしてクリックすれば、自分のブログへのリンクが付きます。

→ログインへ

なるほど(納得、参考になった、ヘー)
驚いた
面白い
ナイス
ガッツ(がんばれ!)
かわいい

気持玉数 : 0

この記事へのコメント

この記事へのトラックバック