VSCode(Visual Studio Code)は多彩な拡張機能を追加して自分好みにカスタマイズできる高機能エディタです。本記事では、VSCode拡張機能開発を始めたい方向けに、まずは必須環境のNode.jsのインストール方法から、Gitを使わずに拡張機能「Hello World」を作成して動かすまでの全手順をわかりやすく解説します。
VSCode拡張機能はNode.jsの環境で動作し、npmというパッケージ管理ツールが使われます。最新の安定版(LTS版推奨)をインストールしましょう。
インストール後、コマンドプロンプトかターミナルで以下を実行し、バージョンが表示されれば成功です。
node -v
npm -v
Node.js環境が整ったら、拡張機能の下地となるプロジェクトを素早く作れるジェネレーター(Yeoman + generator-code)をインストール&起動します。
npm install -g yo generator-code
インストール済みであれば次のコマンドで直接起動します。
yo code
あるいは初回だけであればnpxを使いまとめて実行も可能です。
npx --package yo --package generator-code -- yo code
対話ウィザードでは以下のように入力してください。
種類 | 特徴・用途 | 選び方のポイント |
---|---|---|
unbundled | バンドルしない。設定簡単・ビルド高速 | 小規模シンプルなプロジェクトに適切 |
webpack | 定番バンドラー。多機能・多設定対応 | 大規模で将来拡張したいなら無難な選択肢 |
esbuild | 超高速・軽量 | ビルド速度を最重視する場合に有効 |
npm | Node.js標準パッケージマネージャ | 特にこだわらなければnpm推奨 |
Yarn | キャッシュ・安定性が魅力 | チームで高速インストールしたい場合におすすめ |
pnpm | ディスク効率がよく高速 | 大規模開発向きだが拡張機能のパッケージングに要注意 |
cd プロジェクト名
code .
npm install
(Yarnやpnpmを選択した場合はそれぞれのコマンド)
src/extension.ts
(またはJavaScript版)に基本のコードが生成されています。Ctrl + Shift + P
Cmd + Shift + P
VSCodeの「コマンドパレット」は、あらゆるコマンドを瞬時に呼び出せる機能です。拡張機能のコマンドもここから起動します。
Node.jsのインストールから、GitなしでのVSCode拡張機能雛形作成、バンドラー・パッケージマネージャの選択、さらに「Hello World」コマンドの実行まで網羅しました。初心者でも安心してスタートできるシンプルな構成で解説しています。
本記事を参考に、ぜひオリジナルの拡張機能開発に挑戦してみてください。
【参考URL】
Node.js公式ダウンロードページ:https://nodejs.org/ja/download