Work Documentation

Appearance

5. パッケージ化と公開 ​

vsce によるパッケージ化（.vsix ファイルの作成） ​

開発した拡張機能を他の人に配布したり、自分自身で日常的に使ったりするために、拡張機能をパッケージ化して .vsix ファイルを作成します。 パッケージ化には、VS Code 拡張機能公式の CLI ツールである @vscode/vsce を使用します。

まず、以下のコマンドを実行してツールをグローバルにインストールします。

bash
npm install -g @vscode/vsce

次に、拡張機能のプロジェクトルートディレクトリに移動し、以下のパッケージコマンドを実行します。

bash
vsce package

コマンドを実行すると、プロジェクトルートに my-first-extension-0.0.1.vsix のようなファイルが生成されます。 このファイルを VS Code にドラッグ＆ドロップするか、拡張機能サイドバーのメニューから「VSIX からのインストール」を選択することで、手動で拡張機能をインストールできます。

注意点として、パッケージ化を行う前に、package.json 内の publisher（公開者名）フィールドの設定や、README.md の編集（デフォルトのテンプレートテキストの削除）を行っておく必要があります。これらが未設定だとビルド時にエラーや警告が発生します。

Marketplace への公開手順 ​

世界中のユーザーが拡張機能をダウンロードできるようにするためには、VS Code Marketplace に公開する必要があります。 公開の大まかな手順は以下の通りです。

  • Azure DevOps アカウントの作成

    Marketplace の管理には Microsoft アカウントと Azure DevOps が使用されます。Azure DevOps にログインして組織（Organization）を作成します。

  • パーソナルアクセストークン (PAT) の取得

    Azure DevOps のユーザー設定から、Marketplace へのアクセス権限（Scopes: Marketplace (Publish)）を持った PAT を生成します。このトークンは後で認証に使用するため、厳重に保管してください。

  • 公開プロファイルの登録とログイン

    以下のコマンドを実行し、Marketplace に公開者（Publisher）を登録して、取得した PAT を使ってログインします。

    bash
    vsce login <publisher-name>

  • 拡張機能の公開

    ログインが成功したら、以下のコマンドを実行して Marketplace に公開します。

    bash
    vsce publish

これで、数分後に VS Code の拡張機能検索から、公開した拡張機能を検索してインストールできるようになります。