LoginSignup
3
0

【VScode】自作した拡張機能を公開する方法

Last updated at Posted at 2023-07-02

はじめに

前回に引き続き、今度は自作したVScode拡張機能の公開方法を記述します。

  • 作る ← 【前回
  • 公開する ← 【今回】

拡張機能の公開手順は以下の通りです。

  1. vsceのインストール
  2. Azure DevOpsアカウントを取得
  3. パーソナルアクセストークンを取得する
  4. パブリッシャーIDの確認
  5. package.jsonに追記
  6. vsceでpublisherにログイン
  7. 拡張機能の公開

1. vsceのインストール

拡張機能を公開するにはvsceをnpmでインストールする必要があります。
vsceとは、「Visual Studio Code Extensions」の略で、VScodeの拡張機能の、

  • パッケージ化
  • 公開
  • 管理

を実行するためのコマンドラインツールです。

Windowsでインストール
> npm install -g vsce
Linuxでインストール
$ sudo npm install -g vsce

2. Azure DevOpsアカウントを取得

Microsoft AzureGitHubアカウントでログインします。

3. パーソナルアクセストークンを取得する

パーソナルアクセストークンを取得するには、まずホーム画面の「Azure DevOps organizations」をクリックします。

VScodeの拡張機能のマーケットプレイスへの公開方法_01.png

プロファイルを作ったら、「新しい組織の作成」をクリックします。すると、https://dev.azure.com/プロファイル名/組織名のURLが発行されます。
ここでは、「test」という組織にしています。

VScodeの拡張機能のマーケットプレイスへの公開方法_02.png

右上の「User settings」アイコンをクリックして、「Personal access tokens」をクリックします。

VScodeの拡張機能のマーケットプレイスへの公開方法_03.png

+ New Token 」をクリックしパーソナルアクセストークンを作成します。
以下の2つの項目を記入して、「Create」を押します。

  • Name
    • パーソナルアクセストークンの名前
  • Marketplace
    • デフォルトでは項目が表示されていないため、下部の「Show all scopes」をクリックして展開します。
    • Acqire」と「Manage」をチェックします。

VScodeの拡張機能のマーケットプレイスへの公開方法_04.png

パーソナルアクセストークンが発行されます。
トークンは1度しか発行されないため、忘れずにコピーします。

VScodeの拡張機能のマーケットプレイスへの公開方法_05.png

4. パブリッシャーIDの確認

先程のhttps://dev.azure.com/プロファイル名/組織名に移動し、今度は右上のアイコンから「Browse marketplace」をクリックします。

VScodeの拡張機能のマーケットプレイスへの公開方法_03.png

右上の「Publish extensions」をクリック。

VScodeの拡張機能のマーケットプレイスへの公開方法_06.png

Ownerの箇所をマウスホバーすると、パブリッシャーIDが分かります。

5. package.jsonに追記

公開したい拡張機能のpackage.json"publisher":"パブリッシャーID"を追記します。

package.json
{
  "publisher": "パブリッシャーID",
}

それから「CHANGELOG.md」も編集します。

6. vsceでpublisherにログイン

vsce login パブリッシャーIDとすると、パーソナルアクセストークンを聞かれるため入力します。
すると、ログインできます。

vsceにログイン
$ vsce login パブリッシャーID
https://marketplace.visualstudio.com/manage/publishers/
Personal Access Token for publisher 'パブリッシャーID': **パーソナルアクセストークンを入力**

7. 拡張機能の公開

ログインした状態でvsce publishとすると、package.jsonに登録されたパブリッシャーIDでマーケットプレイスに拡張機能が公開されます。

マーケットプレイスへ公開
$ vsce publish

更新と非公開

更新方法は簡単。
package.json"version": を更新して、vsce publishするだけです。

拡張機能を更新する
{
  "version": "新しいバージョン",
}

一方、非公開にするには、vsce unpublish パブリッシャーID.拡張機能とします。

マーケットプレイスから削除
$ vsce unpublish パブリッシャーID.拡張機能
This will delete ALL published versions! Please type 'パブリッシャーID.拡張機能' to confirm: パブリッシャーID.拡張機能
 DONE  Deleted extension: パブリッシャーID.拡張機能!
3
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
3
0