読者です 読者をやめる 読者になる 読者になる

けんぼーは留年生

Twitterに書ききれないこととか

きっと!きっとやるから!~Kitコマンドの仕様~

 Kitコマンドについては昨日書いたのですが、深夜テンションに任せて適当に書いたものだったから内容に不満があったのと、とりあえず意図した動きをするようになった気がするのでもう一度記事として書きなおして投稿します。

https://github.com/kembo-net/Kit
 KitコマンドはGitコマンドを拡張し、プロジェクトをより進めやすくするための物です。従来のGitのように作業後にメッセージを書くのではなく、事前にこれを宣言することで現状把握をしやすくします。

インストール方法

 インストーラーはまだ出来ていません。自分でコンパイルし、~/binの下にkitというファイル名にして突っ込んで下さい。

コマンド詳細

initコマンド

$ kit init
$ kit init project_name

 initコマンドはkitを利用するための準備をするコマンドです。もし、あなたがGitリポジトリの中にいるなら.kitstackというファイルを生成します。もし、Gitリポジトリにいなければこのコマンドはgit initと同じ動作をしてからその作ったリポジトリの中に.kitstackを用意します。

doコマンド

$ kit do "commit message"
$ kit do after "commit message"
$ kit do after [0-9]* "commit message"
$ kit do [0-9]* "commit message"

 このコマンドがKitコマンドの中核となるものです。doの後ろに付けたコミットメッセージを.kitstackに積み上げます。stackと書かれているように通常は予定は後に宣言されたものを先に実行するものとして上に予定を積んでいきますが、afterオプションを付けた場合は逆に下に挿入されます。また番号を指定した場合は一番上を0として数えた番目の所に挿入します。予定が追加されたことはgitに記録されます。

doneコマンド

$ kit done [0-9]* (file_name1 file_name2 ...)

 doneコマンドはdoの次に大切なコマンドです。doによって.kitstackに積まれた予定を実行します。通常は一番上の予定を全てのファイルを対象にコミットします。番号を指定した場合はその番号の予定を、ファイル名を指定した場合は(複数可)そのファイルだけを対象に実行します。

removeコマンド

$ kit remove [0-9]*

 .kitstackに積んだ予定を削除するコマンドです。数のオプションを付けなければ一番上の予定を、付けた場合はその番号の予定を削除します。削除したことはgitに記録されます。

editコマンド

$ kit edit [0-9]* "commit message"

 .kitstackに積んだ予定を編集するコマンドです。数のオプションを付けなければ一番上の予定を、付けた場合はその番号の予定を編集します。編集したことはgitに記録されます。

now,listコマンド

$ kit now
$ kit list

 これらは現状を確認するためのコマンドです。nowは.kitstackの一番上の予定を表示します。listは全ての予定をインデックス付きで表示します。他のコマンドで番号を指定する場合listコマンドでどの予定がどの番号だったか確認しておくと良いでしょう。

-nオプション

 予定を追加したり削除したりした場合は標準ではそのことが記録されますが、記録したくない場合は-nをコマンドの直後に付けることで回避出来ます。

その他のコマンド

 その他ここに書かれていないコマンドが実行された場合kitコマンドはgitコマンドのエイリアスとして動作します。