jQuery プラグイン の 公開

0 件のコメント

GitHub for Windows を利用しながら、GitHub 上に作成した jQueryプラグイン を公開してみます。

  • jQueryプラグイン名の付け方
  • jQueryプラグインの公開手順

プラグイン名の付け方

基本ルールは次の通り。

  • 使える文字列は、英数字、ハイフン、ピリオド、アンダースコアのみです。
  • プラグイン名は全プラグイン(世界中で公開されているプラグイン)においてユニークな名称である必要があります。
  • プラグイン名とファイル名は一致させます。
    例えば hoge プラグイン なら jquery.hoge.js 。
  • 特定プロジェクトで使っているプレフィックスは利用できません。
    例えば jQuery UI の jquer.ui.* は使えません。

要するに、名前は早い者勝ちだそうです。 ただし、名前を先にとって中身がからっぽだと、警告無しに削除するそうです。

プラグインの公開

GitHub for Windows を使いながら jQueryプラグイン を公開していきます。

  1. GitHub で jQueryプラグイン 用のレポジトリを作成

    まずは、公開するプラグイン自体を準備します。 詳細は下記の記事または他のサイトをご参照ください。

  2. GitHub のレポジトリに Post-Receiveフック を設定

    ここでは、基本設定のみ(今回の目標に対して必要最低限のみ)を記載します。 以下の手順は GitHub のウェブページ上で行います。

    1. GitHub で公開したい jQueryプラグイン の レポジトリ を開きます
    2. "設定(Settings)" を開きます
    3. "サービスフック(Service Hooks)"をクリックします
    4. "WebフックURL(WebHook URLs)"をクリックします
    5. URL http://plugins.jquery.com/postreceive-hook を入力します
    6. 「更新(Update Settings)」をクリックします
  3. パッケージマニュフェストファイル を レポジトリ に追加

    jQuery Plugins Registry はレポジトリのルートディレクトリにある *.jquery.json という名前のファイルを探します。 jQueryプラグイン レポジトリ のルートディレクトリに、パッケージマニフェスト仕様書に従った yourplugin.jquery.json を作成、配置します。

    パッケージマニフェストファイル の サンプル

    {
        "name": "depend",
        "title": "Solution for the dependency problem",
        "description": "jQuery plugin for resolve of the dependency problem about client browser or/and client platform using userAgent string.",
        "keywords": [
            "browser",
            "platform",
            "detection",
            "html5",
            "mobile",
            "tablet",
            "support"
        ],
        "version": "1.0.0",
        "author": {
            "name": "garafu",
            "url": "https://github.com/garafu"
        },
        "licenses": [
            {
                "type": "MIT",
                "url": "https://github.com/garafu/jquery.depend/blob/master/MIT-LICENSE.txt"
            }
        ],
        "bugs": "https://github.com/garafu/jquery.depend/issues",
        "homepage": "https://github.com/garafu/jquery.depend",
        "docs": "https://github.com/garafu/jquery.depend/wiki",
        "download": "https://github.com/garafu/jquery.depend",
        "dependencies": {
            "jquery": ">=1.9.1"
        }
    }
    

    パッケージマニフェストファイルの検証は "Publishing Your Plugin" 中段にある "Validate Your Manifest File Here" を利用してください。

    パッケージマニフェストの仕様は "jQuery Plugin Package Manifest Specification" を参照してください。 (詳細は後日気が向いたときに記載…するかも…。。)

  4. 新規バージョンタグ を設定して jQueryプラグイン を発行

    Post-Recieve フック の設定、マニフェストファイルの作成が完了したら、いよいよ公開作業に入ります。 以下の手順は GitHub for Windows (+ PowerShell) 上で行います。

    1. GitHub for Windows で公開したい jQueryプラグイン の レポジトリ を右クリックします
    2. "シェルを起動(open a shell here)" をクリックします
    3. PowerShell が起動するので、以下のコマンドを実行します
      > git tag v1.0.0
      > git push origin --tags
      
      > git tag [バージョン] で指定する バージョン番号 と、パッケージマニュフェストで指定する バージョン番号 は 一致していないと登録できません。

      すでに発行済みのタグ(バージョン番号)を上書きすることはできません。

      きちんと登録できたかどうかは jQuery Plugins Registry エラーログ 末尾を確認します。

まとめ

jQueryプラグイン を公開する概略手順は次の通りです。

  1. GitHub で jQueryプラグイン 用のレポジトリを作成
  2. GitHub のレポジトリに Post-Receiveフック を設定
  3. パッケージマニュフェストファイル を レポジトリ に追加
  4. 新規バージョンタグ を設定して jQueryプラグイン を発行

参考にしたサイトは以下の通りです。