パーソナルツール

changelog.vim : チェンジログ入力補助

作者: 小見 拓 最終変更 2012年01月10日 01時48分

vimエディタ標準のファイルタイププラグインで、 チェンジログの入力を補助する機能を持っています。 ただし、ファイルタイププラグインなので、 特定のファイルタイプ(changelog)のファイルを開いた時のみ動作します。 (Windows, Mac)

概要

changelog.vim : generic Changelog file

vimエディタ標準のファイルタイププラグインで、
チェンジログの入力を補助する機能を持っています。

ただし、ファイルタイププラグインなので、
特定のファイルタイプ(changelog)のファイルを開いた時のみ動作します。

インストール方法

標準のファイルタイププラグインなので、特に作業は必要としません。

使用方法

ファイルタイプ「changelog」のファイルを開いている時に、ノーマルモードで

<Leader>o

を入力すると、ファイルにチェンジログのエントリが追加されます。
<Leader>はデフォルトの状態だと「 ¥ 」キーになるので、
通常は「 ¥ o 」とノーマルモードで入力すれば、チェンジログのエントリは追加されます。

追加されるチェンジログのエントリの書式は 設定 で変更可能です。

Mac OSX環境初期状態で追加されるエントリの例
2006-01-22  Foo  <foo@osxnote.local>

*

ファイルに、既にその日のエントリが追加されている場合は、
<Leader>oを入力するごとに項目が増えていきます。

2006-01-22  Foo  <foo@osxnote.local>

* AAA
* BBB
*

ファイルタイプが「changelog」になる条件

このプラグインは、ファイルを開いた時に、
そのファイルのファイルタイプが「changelog」の場合にしか動作しません。

ファイルタイプが「changelog」になる条件は、 ファイル名が、

  • ChangeLog
  • Changelog
  • changeLog
  • changelog

のどれかか、どれかから始まっていて、
「changelog.Debian」,または「changelog.dch」というファイル名ではなく、
かつ、ファイルの1行目に「; urgency=」という文字が無いことです。

これ以外のファイルで、このプラグインによるチェンジログエントリ追加機能を使用したい時は、

" 拡張子changelogのファイルを開いた時に、ファイルタイプをchangelogにする場合の設定例
:au BufNewFile,BufRead *.changelog setf changelog

のような設定をvimエディタの設定ファイルに追加してください。

設定

このプラグインイは、チェンジログのエントリの設定が用意されています。
変更したい場合は、下の設定をvimエディタの設定ファイルに追加してください。

設定 説明 設定例
g:changelog_timeformat チェンジログのエントリで追加される時間の書式 :let g:changelog_timeformat = "%Y-%m-%d"
g:changelog_username チェンジログのエントリで追加されるユーザー名の設定 :let g:changelog_username = "foo <foo@osxnote.local>"

g:changelog_timeformatで指定する
日付出力のフォーマットの定義例を表にしておきます。

フォーマット 出力例
%Y-%m-%d 2006-01-22
%c Sun Apr 27 11:49:23 1997
%Y %b %d %X 1997 Apr 27 11:53:25
%y%m%d %T 970427 11:53:55
%H:%M 11:55

注意事項など

似た機能をもつ spec.vim というプラグインがあります。

ドキュメントアクション
コメント
blog comments powered by Disqus