@Satoh_D no blog

大分にUターンしたので記念に。調べたこととか作ったこととか食べたこととか

自作したSublime TextのプラグインをPackage Controlに登録してみる

昨日公開したCloseCommentTagをPackage Controlへ登録してもらおうと依頼してみました。
以前から自作したパッケージを登録してみたかったのと、Pull Requestの初挑戦も兼ねてです。
その時の内容をメモします。

Package Control ChannnelリポジトリをForkする

Pull Requestを送るにあたり、リポジトリをForkして自分のリポジトリにコピーしなければいけません。

まずはFork元となるpackage_control_channelを開きます。
右上にある「Fork」と書かれたボタンをクリックします。

しばらく待つと自分のリポジトリリポジトリがコピーされます。

Forkしたリポジトリを編集する

Forkが完了したら、そのリポジトリをcloneして編集します。

git clone git@github.com:Satoh-D/package_control_channel.git

repository ディレクトリに入り、登録したいパッケージの頭文字に該当するjsonを開きます。
※今回は「CloseCommentTag」を登録したいので c.json を開きます。

アルファベット順に他の方のリポジトリが並んでいるので、その順序を壊さないように登録したい情報を入力します。 下記の様に入力すればとりあえずは問題無いと思います。

{
  "name": "プラグイン名", // Package Control上で表示されるプラグイン名
  "details": "リポジトリのURL",
  "releases": [
    {
      "sublime_text": "対応バージョン", // ST2だけに対応: "<3000", ST3だけに対応: ">2999", 特に無し: "*"
      "details": "masterのURL" 
    }
  ]
}

CloseCommentTagはこのように入力しました。

{
  "name": "CloseCommentTag",
  "details": "https://github.com/Satoh-D/CloseCommentTag",
  "releases": [
    {
      "sublime_text": "*",
      "details": "https://github.com/Satoh-D/CloseCommentTag/tree/master"
    }
  ]
}

編集が完了したら内容をcommitし、リモートにpushします

git add repository/c.json
git commit -m "Adding Close Comment Tag Package"
git push origin master

pushが完了したらForkしたリポジトリのページに戻ります。

Pull Requestを送ってみる

ファイル一覧の右上にある小さな文字で書かれた「Pull Request」をクリックします。

Pull Request作成画面が表示されます。
「Create pull Request」ボタンをクリックします。

Pull Requestのタイトルと、編集した内容を書いて「Create pull request」ボタンをクリックします。

これで相手にPull Requestが送られました。
あとは登録されるかどうかを待ちます。ただひたすら待ちます。

これでPackage Controlの登録依頼は完了です。
初めての登録依頼&Pull Request...色々とドキドキしました。
無事に登録されるといいなぁ...いいなぁ。

今回参考にしたページ