hl-todo 20161102.1337(in MELPA)
highlight TODO and similar keywords

概要

hl-todo.el は、特定のキーワードに色をつけて目立つようにします。

プログラム開発中においてTODOやFIXMEなどの
注目キーワードを書くことがよくあります。

これらを別な色にして目立たせることで、見逃しを防止します。

なお、このコードは実質50行くらいの短いコードなので、
font-lock関連のコードを書く際においての手頃な資料になります。

類似品に

  • fic-mode
  • fic-ext-mode
  • fixme-mode
  • fixmee

などがあります。

これらと比較検討するのもおもしろいでしょう。

<2014-12-28 Sun>追記
一方で、任意のシンボルを永続的にハイライトする
hl-anything.el(レビュー)もあります。

インストール

パッケージシステムを初めて使う人は
以下の設定を ~/.emacs.d/init.el の
先頭に加えてください。

(package-initialize)
(setq package-archives
      '(("gnu" . "http://elpa.gnu.org/packages/")
        ("melpa" . "http://melpa.org/packages/")
        ("org" . "http://orgmode.org/elpa/")))

初めてhl-todoを使う方は
以下のコマンドを実行します。

M-x package-install hl-todo

アップグレードする方は、
以下のコマンドでアップグレードしてください。
そのためにはpackage-utilsパッケージが必要です。

M-x package-install package-utils (初めてアップグレードする場合のみ)
M-x package-utils-upgrade-by-name hl-todo

設定 141227030115.hl-todo.1.el(以下のコードと同一)

;;; キーワードの色を設定する
;;; ただし、hl-todo.elを読み込む前あるいはcustomizeで設定すること
(setq hl-todo-keyword-faces
  '(("HOLD" . "#d0bf8f")
    ("TODO" . "#cc9393")
    ("NEXT" . "#dca3a3")
    ("THEM" . "#dc8cc3")
    ("PROG" . "#7cb8bb")
    ("OKAY" . "#7cb8bb")
    ("DONT" . "#5f7f5f")
    ("FAIL" . "#8c5353")
    ("DONE" . "#afd8af")
    ("FIXME" . "#cc9393")
    ("XXX"   . "#cc9393")
    ("XXXX"  . "#cc9393")
    ("???"   . "#cc9393")))
;;; global-hl-todo-modeで有効にするメジャーモード(derived-mode)
(setq hl-todo-activate-in-modes
      '(prog-mode ruby-mode enh-ruby-mode))
(global-hl-todo-mode 1)

実行方法

$ wget http://rubikitch.com/f/141227030115.hl-todo.1.el
$ emacs -Q -f package-initialize -l 141227030115.hl-todo.1.el

20141227031333.png
Fig1: 緑背景

20141227031339.png
Fig2: 白背景

本サイト内の関連パッケージ


本日もお読みいただき、ありがとうございました。参考になれば嬉しいです。