技術書典6 - VSCode Extension Start Book の紹介
4月14日(日)に開催される技術書典6にて、 「Visual Studio Code Extension Start Book」 という本を頒布します。配置は「き36」です。
本エントリにて、どのような本か、どのレベルの読者を想定して執筆したかを紹介していきます。 サンプルはこちらの記事に上げてありますのでよしなに。
時間がない方は「想定読者」をお読みいただければ、 なんとなくのレベル感がお分かりいただけるかと思います。
想定読者
前提として、次のような経験をお持ちの方を想定しています。 なお、筆者は VSCode を1月中旬ごろから使いだしたので、未経験でも全く問題ないと思います。
- VSCode 及び拡張機能を使ったことがある
- TypeScript または JavaScript を書いたことがある
- Node.js なんとなくわかる、使っている
- JSON なんとなくわかる
そのうえで、
- とりあえず拡張機能を作ってみたいけど、ドキュメントが英語多すぎでしんどい方
- マイナー言語を書いてみたいけど、ハイライトが提供されてなくてしんどい方
- 拡張機能で OAuth 認証を通し、VSCode から直接コンテンツを投稿したい方(※筆者)
- この記事も拡張機能使って投稿していたりします(投稿後ブラウザで微修正)
このような要望を満たせればと思い、執筆を行いました。
本書のレベル感
作って公開するまでの全体の流れを重視し、1冊に収めた本になります。 初心者及び、作ってみたいけどドキュメント読むのしんどい方向けで執筆しておりますので、
「あんな API やこんな API を使って、高性能な拡張機能をエレガントに作りましょう~~~!」
みたいな内容を期待されますと、ちょっと筆者がつらくなってしまいます。
本の内容
本書では、次のことについて実装と解説を行っています。
- 開発環境の構築
- コマンド主体の拡張機能の開発
- シンタックスハイライト拡張機能の開発
- 拡張機能のコンパイルとマーケットプレイスへの公開
- はてなブログの OAuth 認証を VSCode 上で実行する(付録)
また、次については詳しい解説を記載しておりません。 ご了承ください。
執筆の動機、経緯など
技術書典5から書き始めたはてなブログにて、
「シンタックスハイライトも効かないし自動補完もされないしタブもつらいンゴ……」
と思ったのがきっかけでした。
調べると、はてなブログでは OAuth 認証が用意されており、 Markdown テキストをサードパーティアプリから投稿できそうでした。 これはもう拡張機能あるやろ!と思って調べたのですが───( ^ω^)無い??
正確に言えば、無いことはないんですが、OAuth 認証は使わずに API キーを直接拡張機能に打ち込む形式のようだったので、コレジャナイと。
……よし、作るか!
こんな感じで拡張機能について調べ始め、奇しくも書典6の申込締切と重なっていたため、 このネタに決定しました。人間締切があればなんとかなるものです。
執筆状況や最新情報
Twitter アカウントて、技術書典関係は「#技術書典」を付けてつぶやいています。 執筆状況といっても、本日中(3月31日)には入稿しようと思っております。
興味持っていただけた方は、会場でぼくと握手!