[動画あり] Visual Studio の強力な JavaScript インテリセンス機能の活用 - WSHスクリプトエディタに最適!

21世紀の WSH

Windows OS の次世代スクリプティング環境は PowerShell ... のはずだが、皆さんいかがお過ごしだろうか。

未だに、WSH、すなわち、Windows Scripting Host ベースでのスクリプトを書いていたりしません?

自分は PowerShell は苦手意識が強いのだが、その代わり次世代スクリプティングは F# スクリプトだ、などと吹聴している。

にも関わらず、実業務では .js や .wsh による WSH スクリプトを書くことがいまだにある。

というのも、F# スクリプト環境は、(近代の)すべての Windows OS にはじめから入っている、わけではないからだ。

JavaScript + Visual Studio

WSH といえば VBScript、という方が多勢かもしれないが、自分は Web アプリケーションが主たる業務であることもあり、JavaScript ( 厳密には JScript? ) で書いている。

そこで大変役に立つのが Visual Studio、だ。

「スクリプトのいいところはエディタひとつで簡単に書けることでは? そこへもって、なんであんな巨大な IDE を使うのか?」というご意見はごもっとも。

たしかにそうなのだが、にもかかわらず、Visual Studio を立ち上げるのは他ならない、"インテリセンス" のためだ。

もともと、Visual Studio は、ASP.NET Web アプリケーション開発の効率化のために、JavaScript に対するインテリセンス機能を代々強化・進化し続けてきた。

その成果が、JavaScript による WSH スクリプト記述にも大変役に立つのだ。

とは言っても、WSH のために機能強化されてきたためではないため、WSH 環境下で提供される WScript オブジェクトや、Scripting.FileSystemObject COM コンポーネントなどに対するインテリセンス機能が、なにもしなくても手に入るわけではない。

WSH 用のインテリセンス機能を提供する WSH-vsdoc.js

ということで、WSH JavaScript の記述にあたってインテリセンスが機能するように、1つ、JavaScript ファイルを作成し、GitHub で公開を始めた。

https://github.com/jsakamoto/WSH-vsdoc

能書きはともかく、どれくらい Visual Studio のインテリセンス機能が強力か、以下の動画をご覧頂いた方が話は早いかもしれない。



いかがだろうか。

WScript オブジェクトのインテリセンスが機能しているのは当たり前。

加えて new ActiveXObject("Scripting.FileSystemObject") が返した COM オブジェクトに対して、ちゃんと GetFolder などのメソッドが候補に表示される。

さらに、Files などのコレクションプロパティに対して Enumerator を new して item() を取ると、ちゃんと File オブジェクトのメンバが候補に表示されるのだ。

また、同じ ActiveXObject であっても、コンストラクタ引数に "WScript.Shell" を渡した場合は、ちゃんと WScript.Shell オブジェクトとして振る舞い、Run などのメソッドが候補に表示されるようになる。

また、Run メソッドのパラメータヒントを見れば、「うーん、外部プロセス起動時の、ウィンドウスタイルで最小化を指定するには何を指定するんだっけ?」という疑問もすぐにわかる。

自分は WSH スクリプトを日常的に書いているわけではないため、多くを覚えずに済むこのようなインテリセンス機能は大変ありがたい。

使い方おさらい

WSH-vsdoc.js の使い方は、上記動画のとおりなのだが、念のため、テキストでもおさらいしておく。

1. 上記 GitHub の WSH-vsdoc リポジトリから、WSH-vsdoc.js を入手し、適当なフォルダに配置しておく。
2. Visual Studio で .js や .wsh、.hta などのファイルを開く。
3. 開いたファイルの JavaScript セクションの最初の1行に、
   「/// <reference path="...."/>」
   として、先ほど入手・配置した WSH-vsdoc.js のフルパスを記述する。
   （※パス中のバックスラッシュはエスケープする必要はない）

たったこれだけで、Visual Studio による WSH 用各種オブジェクト類のインテリセンスが機能するようになる。

だがしかし WSH-vsdoc.js は作りかけ :P

しかしながら、この WSH-vsdoc.js、誠に残念ながら、すべてのメンバを網羅していないのだ。

自分が最近使ったメンバだけを記載してある。

今後もリファレンスを引く羽目になったメンバだけ、少しずつ、この WSH-vsdoc.js に書きためていくつもりだ。

なお、GitHub 公開しているので、fork ご自由に。
なにかメンバ追加されたら是非 pull request を送っていただければ幸いである。

この調子で Excel-vsdoc.js も!?

この調子で、誰かが Excel-vsdoc.js 作ったらおもしろいかもしれない。

var excelApp = new ActiveXObject("Excel.Application");

とやって、

excelApp.W

とまでタイプしたら、"Workbooks" が候補に現れるような。
　
ん?
いつまで WSH を使い続けるのか?
　
うーん... Windows 8 でも WSH 使えるんですよね?
だったらまだ当面暫くは、でしょうかねぇ。