プレーンテキストだってVSCodeでアウトラインを作りたい

ざっくりまとめ

　Visual Studio Code略してVSCodeの拡張機能を作りました。

　プレーンテキストでも、たとえば行頭記号を目印に見出しとみなしてアウトラインを表示することができます。

　拡張機能をインストールしてもVSCodeには英語のREADMEしか表示されません。
　GitHubのほうに日本語版があります。
　正確な機能はこちらを参照してください。

　READMEには書いてませんが、JSONを一行に圧縮するには以下のようなWebサービスを利用すれば簡単にできます。

なんで作ったの

　仕事の都合でVSCodeを使うことになりました。
　WZ Editorやサクラエディタにはプレーンテキストであっても行頭記号で見出しとみなしてアウトラインを表示する機能があります。
　世界中の人が使っているVSCodeさんなら、それくらい余裕でやってくれるだろう……と思ったら、どうもダメみたいでした。

　くわえて趣味でtpac記法という独自の仕様を作っていました。
　独自の仕様ですから、自分がやらないかぎり誰もこれをアウトライン表示してくれる拡張機能なんて作ってくれないわけです。

　ネット検索してみると日本語での解説記事がけっこうみつかり（感謝！）これなら自分でも作れるかと感じました。

　時間は計っていなかったんですが、感覚的には仕事として（つまり一日あたり八時間労働で）やっていたら、軽く一週間近く（もちろん五営業日ってことですよ）はかかったんじゃないかなー。

こぼれ話

　以下、脈絡なくこぼれ話をして終わります。

可変長の設定はできないっぽい

　恐らくREADMEを読んだ人みんながツッコむのは「なんで設定がJSONなんだよ！」でしょうか。
　これはですね……俺が悪いんじゃない（開き直り）。

　ファイルの拡張子毎に見出しのルールを設定したかったんです。
　あと見出しのレベルも必要に応じて何段階でも指定できるようにしたかったんです。
　設定できる拡張子やレベルの数の上限を決めない、いわば可変長の設定がどうもできないっぽいんですよね。
　公式サイトの記述をしっかり読めばどこかにやり方が書いてあるかもしれませんが……英語という高い壁がありまして。

　苦肉の作でJSONによる指定にしたわけです。
　悪しからず。

正規表現ってなに

　まあ、システムエンジニアとかでなければ「正規表現ってなに？」ですよね……。

　恐らく行頭記号を目印に見出しとしたい人が大半でしょう。
　だから行頭記号あるいは正規表現で指定できます、としたほうが間口は広がりますね。

　じゃあ、なんで正規表現での指定オンリーかといえば、そりゃもちろん、面倒くさかったからです。
　気が向いたら改善するとしましょう。

見出しのレベルをスキップしたとき

　VSCodeのアウトラインはツリー形式で表示されます。
　したがって、本来ならH1の次はH2、H2の次はH3と、見出しのレベルはひとつずつ大きくならなければなりません。

　ところがぎっちょん。
　上記の画面キャプチャの「▼３－１」あたりを見てもらえばわかりますが、H1の次にH3が来てもアウトラインに表示されます。

　そもそもアウトラインの目的のひとつは、表示位置の移動を楽にすることです。
　テキストがまだ作成の途中であっても、見出しであればアウトラインに表示したいわけで。
　レベルをスキップしても表示されるようにしています。

見出しのアイコンを選べない

　これも、気にする人はいないだろうと思ってREADMEに書かなかったこと。
　アウトラインには見出し毎にアイコンも表示されます。
　これはソースコードのほうでは SymbolKindで指定するんですが、以下のとおりClassとかFunctionとかソースコードを想定したものばかり。
　HTMLのH1みたいに文書を想定したものがないんですよね。

　しょうがないのでファイル先頭/終端やレベル１～３のアイコンだけ種類を変えて、レベル４以上は一律同じアイコンとしました。

• ファイル先頭/終端：SymbolKind.File
• レベル１：SymbolKind.Package
• レベル２：SymbolKind.Class
• レベル３：SymbolKind.Method
• レベル４以上：SymbolKind.Variable

　ネット検索すると、どうもアイコンを改造する手段がなくもないようですが……英語がね……。