autocmplpop.vimを導入

AutoComplPop – Automatically opens popup menu for completions : vim online

デフォルトのままのVimでは、やの後に、
, とする事で入力候補をポップアップで表示させる事が出来ます
…が、ちょっとまどろっこしい。

これを自動的にポップアップしてくれるようにしてくれるのが
このAutoComplPopというプラグインです。
導入方法はディレクトリにコピーするだけなので割愛。

尚、当方のUbuntu環境ではl9.vimも必要とされました。
うまく動かなかったら一緒に導入してやりましょう。

L9 – Vim-script library : vim online

導入後の設定

以下が、導入後の設定を極めて分かりやすく紹介してくれている記事。

autocomplpop.vimでリアルタイムにキーワード補完 – ナレッジエース

以下、リンク先の記事より拝借・抜粋させて頂きます。

ポップアップ中でもEnterキーで候補決定しない様に設定

候補を無視して改行を入力したい場合もあるので、
ポップアップ中のEnterキーで決定しないようにします。
修正箇所は、autoload/acp.vimの192行目付近。

if pumvisible()
    " a command to restore to original text and select the first match
    return "\<C-p>"
endif

これだとEnterでポップアップが消えるだけで、その時はまだ改行は挿入されません。
私はこっちのほうが使いやすいのですが、改行を挿入したい場合はvimrcに下記を追記。

inoremap <expr> <CR> pumvisible() ? "\<C-y>\<CR>" : "\<CR>"

他にもTabで候補を巡回する為の設定等も掲載されていましたが、
私は無い方が使いやすかったので、割愛致します。詳しくはリンク先で！

『オプション ‘omnifunc’ は設定されていません』

…なんていうエラーが吐かれた場合の対処について。

当方の環境では挿入モードで「<」を入力中に上記のエラーが吐かれました。
omnifuncというのはオムニ補完、つまり入力補完のポップアップの事らしく、
これを設定してあげれば黙るかな？というわけで設定してみました。

setlocal omnifunc=syntaxcomplete#Complete

無事静かになってくれました。
参考：Ubuntu日本語フォーラム / vim autocomplpop エラーについて

ついでなのでPHPの辞書を突っ込んでおこう

異常に関数の多いPHPこそ入力補完が役に立ちますね。
辞書ファイルはただ改行で候補を連ねるだけなので、簡単に作成出来ます。

参考：Vim で PHP 関数の辞書を作成する方法についてのメモ

上記リンクより抜粋。多謝！
こちらのコードを走らせる事で辞書ファイルを生成出来ます。

<?php
$keywords = array(
    'if', 'else', 'elseif', 'endif', 'while', 'endwhile', 'do', 'as', 'for', 'endfor', 'foreach', 'endforeach',
    'break', 'continue', 'switch', 'endswitch', 'case', 'default', 'declare', 'enddeclare',
    'try', 'catch', 'return', 'exit', 'const', 'class', 'function',
    'require', 'include', 'require_once', 'include_once',
    'abstract', 'final', 'interface', 'private', 'protected', 'public', 'static',
    '__LINE__', '__FILE__', '__DIR__', '__FUNCTION__', '__CLASS__', '__METHOD__', '__NAMESPACE__'
);
$functions  = function_exists( 'get_defined_functions'   ) ? get_defined_functions()   : array();
$constants  = function_exists( 'get_defined_constants'   ) ? get_defined_constants()   : array();
$interfaces = function_exists( 'get_declared_interfaces' ) ? get_declared_interfaces() : array();
$classes    = function_exists( 'get_declared_classes'   ) ? get_declared_classes()  : array();

$arrays = array_merge(
    $keywords,
    $functions['internal'],
//  array_keys( $constants ),   // 定数を補完したい場合はこの行を有効にする
    $interfaces,
    $classes
);
sort( $arrays );
$arrays = array_unique( $arrays );
echo implode( "\n", $arrays );

生成した辞書ファイルをvimrcで登録しておけば完了です。

autocmd FileType php :set dictionary=~/.vim/dict/php.dict

Windowsの場合は下記のような感じ。
“$VIM”はgVim.exeがインストールされているパスです。

autocmd FileType php :set dictionary=$VIM/vimfiles/dict/php.dict

辞書は必要に応じて追加していきましょう。
ActionScriptなんかも欲しいなぁ…

ひとまずこんな感じで、Win/Linux共にまともに動いてくれています。
オムニ補完はバッファの中身のみならず、
辞書を設定しておけば辞書内からも候補を表示してくれる優れもの。
Linxではパスの入力もこれでかなり楽になりますね。

ノートでのコーディングがとても快適になりました！すごいやVim！

JSDoc Toolkitについて

JSDoc ToolkitはJavaScript用のドキュメンテーションツールです（二回目）。
公式： jsdoc-toolkit – Project Hosting on Google Code
「JSDoc」というPerlスクリプトもあるそうですが、
それとはまた別物で、JSDoc Toolkitの方はJavaで書かれています。

コマンドラインでJavaScriptのソースを指定して走らせる事で、
記述されたコメントを元にドキュメントをHTML形式で吐き出してくれます。

Windowsでの例：

java -jar jsrun.jar app\run.js c:\home\myproject\example.js -t=templates\jsdoc ^
-d=c:\home\myproject\jsdoc -a

出来上がるのは、こんな感じのドキュメントファイルです。
テンプレートを弄ればデザインを変更する事も出来ます。

こちらのWebサイトがインストールからドキュメント生成まで、
非常に詳しく解説してくれています。多謝！丸投げ！
JsDoc Toolkitを使う！
コマンドタグやコマンドラインオプションも邦訳して詳しく書かれていますよ。

Notepad++で使ってみる

一々コマンド打つのも面倒ですし、
作業中のファイルからサックリとドキュメントを生成したいので
Notepad++からNppExecでJSDoc Toolkitを呼び出してみます。

プラグイン>NppExec>Executeでコマンドを記述して「OK」で実行/「Save」で保存。
これは一例ですが、最小構成で書いてみました。

set P=c:\Program Files\jsdoc-toolkit\
set D=$(CURRENT_DIRECTORY)
java -jar "$(P)jsrun.jar" "$(P)app\run.js" $(D) -t="$(P)templates\jsdoc" -d="$(D)\jsdoc" -v

上のコマンドを実行すると、
作業中のファイルと同ディレクトリにあるjsファイルのドキュメントを
同ディレクトリのjsdocフォルダ内に生成してくれます。

上で使われている物以外にも、辿るディレクトリの階層を指定する「-r」等
便利なコマンドラインオプションが存在するので、是非ご一読を。

JsDoc Toolkitを使う！ – コマンドラインオプション
CommandlineOptions – jsdoc-toolkit – Overview including commandline options.（公式）

JSLintを使う

JSLint, The JavaScript Code Quality Tool

使い方は至ってシンプルで、
テキストエリアにJSコードをペーストして「Lint」ボタンをクリックするだけ。
よろしくない書き方をしていると、下に連連とエラーを吐いてくれます。

オプションは多数用意されていますが、
よくわからない時、面倒な時は「The Good Parts」ボタンで
一般的なオプションを一括選択してくれます。

cf) YouTube – Using JSLint （動画）

テキストエディタから直接利用する

一々ブラウザでアクセスしてコピー＆ペーストするのは面倒。
そんな人の為はGitHubからソースをダウンロードしてきて、
バッチファイルで使えるようにしましょう。

• douglascrockford/JSLint – GitHub

利用の仕方はエディタによって違ってきますが、
Notepad++でのインストール方法が、Stack Overflowで紹介されていました。
当時から状況も多少変わっているので、要所のみ紹介しておきます。

Notepad++の場合、現在ではプラグインが提供されているそうです。
JSLint Plugin for Notepad++ – Browse Files at SourceForge.net
kntさんより情報頂きました。

2012/12/19現在
Notepad++のjslintはPlugin Managerでインストール出来るようになっています。

kntさんより情報頂きました。

1. GitHubから“fulljslint.js”をダウンロードする。

2. fulljslint.jsファイルの最後に以下のように追記する。

(function() {
    if(!JSLINT(WScript.StdIn.ReadAll(),{passfail:false})) {
        var e;
        for(var i in JSLINT.errors) {
                e=JSLINT.errors[i];
                WScript.StdOut.WriteLine('Lint at line '+(e.line+1)+' character '+(e.character+1)+': '+e.reason);
                WScript.StdOut.WriteLine('  '+(e.evidence||'').replace(/^s*(S*(s+S+)*)s*$/,"$1"));
        }
        WScript.Quit(1);
    }
}());

このコードは、JSLintをWindowsScriptingHost経由で使えるようにする為の物です。

3. NotePadのnppExecから呼び出す用のバッチファイルを作成する

仮にfulljslint.jsを、「c:Program FilesJSLint」に保存したと仮定します。
次のようなバッチファイルを作成し、
同じディレクトリに「jslint.bat」のような名前をつけて保存しておきましょう。

@echo off
setlocal
set P=c:Program Filesjslint
@copy /b "%P%config.txt"+%1 "%P%lastoutput.txt"
@cscript /NoLogo "%P%fulljslint.js" < "%P%lastoutput.txt"
endlocal
:end

何をしているかというと、conf.txtの内容（後述）と、
エディタで編集中のJavaScriptの内容を結合した
「lastoutput.txt」という一時ファイルを生成し、
それをfulljslint.jsに「検査してくださーい」と投げているわけですね。

4. 設定用のconf.txtを作成する

Webの「OPTION」同様に様々なオプションを設定する為の設定ファイルを作成します。
JSLintのWebツールでオプションを選択すると、
オプションの下部に次のようなコメントが表示されます。

/*jslint white: true, onevar: true, undef: true, nomen: true, eqeqeq: true, plusplus: true, bitwise: true, regexp: true, newcap: true, immed: true, strict: true */

これをそのままコピー＆ペーストすればOKです。
ちなみに上記のものは「The Good Parts」をクリックした時のものです。

5. Notepad++のNppExecで実行する

デフォルト設定ならば、F6でNppExecのダイアログが表示されます。
（もしくは「プラグイン」→「NppExec」→「Exec」）
そこに、次のように入力して「OK」しましょう。

"c:Program FilesJSLintjslint.bat" "$(FULL_CURRENT_PATH)"

設定が上手くいっていれば、エディタの下にコンソールが表示されてエラーを吐いてくれるはずです。
いつでも使えるように「Save」しておきましょう。

他の環境の場合は？

マクロや外部ツールが扱えるようなエディタなら導入できるはずです。
VIMをお使いのひとには、プラグインもあるみたい]です。（試してません！）
WSHがない環境ではSpiderMonkeyやらnode.jsやらを利用するみたいですね。

• hallettj/jslint.vim – GitHub

まとめ

つい「動けばいーや」的なスタンスで書いてしまいがちなJavaScriptですが（主に私が）、
より上質なスクリプティングを目指すためには、ぜひ導入しておきたいですね。

ちなみに過去のスクリプトをJSLintにかけると、軽く落ち込めますよ。（オススメ！）

2010/12/29

WSHのURLがリンク切れになっています。

2011/01/03

ソースがGitHubに移動していたのを機会にバッチファイル等を書き直しました。

2012/09/12

kntさんにNotepad++版プラグインを教えて頂いたので追記しました。

2012/12/12

kntさんにNotepad++のPlugin Managerに関する情報を頂いたので追記しました。