【初心者向け】Node.jsインストールから始めるVSCode拡張機能開発入門|GitなしでHello Worldを動かすまで

VSCode(Visual Studio Code)は多彩な拡張機能を追加して自分好みにカスタマイズできる高機能エディタです。本記事では、VSCode拡張機能開発を始めたい方向けに、まずは必須環境のNode.jsのインストール方法から、Gitを使わずに拡張機能「Hello World」を作成して動かすまでの全手順をわかりやすく解説します。

Node.jsのインストール方法|まずは開発環境を整えよう

VSCode拡張機能はNode.jsの環境で動作し、npmというパッケージ管理ツールが使われます。最新の安定版(LTS版推奨)をインストールしましょう。

インストール手順

  1. Node.js公式ダウンロードページへアクセス
  2. 「推奨版(LTS)」のインストーラーをダウンロード
  3. インストーラーの指示に従いインストールを完了させる

インストール後、コマンドプロンプトかターミナルで以下を実行し、バージョンが表示されれば成功です。

node -v
npm -v

VSCode拡張機能開発のための前準備

Node.js環境が整ったら、拡張機能の下地となるプロジェクトを素早く作れるジェネレーター(Yeoman + generator-code)をインストール&起動します。

npm install -g yo generator-code

インストール済みであれば次のコマンドで直接起動します。

yo code

あるいは初回だけであればnpxを使いまとめて実行も可能です。

npx --package yo --package generator-code -- yo code

Gitなしでの拡張機能雛形作成ポイント

対話ウィザードでは以下のように入力してください。

  • 拡張機能の種類:「New Extension (TypeScript)」推奨
  • Gitリポジトリ初期化は「No」を選択(Gitなし)
  • バンドラーは「unbundled」か「webpack」が初心者におすすめ
  • パッケージマネージャは標準の「npm」が無難で扱いやすい

バンドラーとパッケージマネージャの選び方

種類特徴・用途選び方のポイント
unbundledバンドルしない。設定簡単・ビルド高速小規模シンプルなプロジェクトに適切
webpack定番バンドラー。多機能・多設定対応大規模で将来拡張したいなら無難な選択肢
esbuild超高速・軽量ビルド速度を最重視する場合に有効
npmNode.js標準パッケージマネージャ特にこだわらなければnpm推奨
Yarnキャッシュ・安定性が魅力チームで高速インストールしたい場合におすすめ
pnpmディスク効率がよく高速大規模開発向きだが拡張機能のパッケージングに要注意

プロジェクト作成後~サンプル拡張機能実行まで

  1. プロジェクトフォルダへ移動
cd プロジェクト名
code .
  1. 依存パッケージのインストール
npm install

(Yarnやpnpmを選択した場合はそれぞれのコマンド)

サンプル拡張機能の実行方法

  1. src/extension.ts(またはJavaScript版)に基本のコードが生成されています。
  2. VSCodeでデバッグを開始(F5キーを押すか、デバッグパネルから実行)。
  3. 新しく開いたExtension Development Hostウィンドウが開きます。
  4. Extension Development Hostでコマンドパレットを開きます。キーボードから
    • Windows/Linux:Ctrl + Shift + P
    • Mac:Cmd + Shift + P
      を押します。
  5. コマンドパレットに「hello」と入力すると、「Hello World」コマンドが表示されます。
  6. 矢印キーで選択し、Enterキーを押すか、マウスでクリックしてコマンドを実行します。
  7. 画面右上に「Hello World from プロジェクト名!」という通知ポップアップが表示されれば成功です。

よくある疑問:コマンドパレットでの「Hello World」実行とは

VSCodeの「コマンドパレット」は、あらゆるコマンドを瞬時に呼び出せる機能です。拡張機能のコマンドもここから起動します。

  • デバッグ起動したExtension Development Host上でコマンドパレットを開き、
  • 「hello」と入力し、表示される拡張機能由来の「Hello World」コマンドを選んで実行。
  • 成功すると通知が表示されて動作を目で確認できます。

まとめ

Node.jsのインストールから、GitなしでのVSCode拡張機能雛形作成、バンドラー・パッケージマネージャの選択、さらに「Hello World」コマンドの実行まで網羅しました。初心者でも安心してスタートできるシンプルな構成で解説しています。

本記事を参考に、ぜひオリジナルの拡張機能開発に挑戦してみてください。

【参考URL】
Node.js公式ダウンロードページ:https://nodejs.org/ja/download

にいやん

出身 : 関西 居住区 : 関西 職業 : 組み込み機器エンジニア (エンジニア歴13年) 年齢 : 38歳(2022年11月現在) 最近 業務の効率化で噂もありPython言語に興味を持ち勉強しています。 そこで学んだことを記事にして皆さんとシェアさせていただければと思いブログをはじめました!! 興味ある記事があれば皆さん見ていってください!! にほんブログ村