Skip to content

Latest commit

 

History

History
181 lines (115 loc) · 7.77 KB

vse命令行工具.md

File metadata and controls

181 lines (115 loc) · 7.77 KB
Order Area TOCTitle ContentId PageTitle DateApproved MetaDescription
1
tools
Publishing Tool
3F05F31A-FD66-4635-9BA2-F1799E795EA7
vsce Publishing Tool - Publishing your Visual Studio Code Extensions
4/14/2016
Find out how to publish an extension to the Visual Studio Code Extension Marketplace.

vsce - Publishing Tool Reference

vsce is the command line tool you'll use to publish extensions to the Extension Marketplace. You can also load extensions locally and share them via email or a UNC drive.

Installation

Make sure you have node.js installed. Then simply run:

npm install -g vsce

Usage

You'll use the vsce command directly from the command line. For example, here's how you can quickly publish an extension:

$ vsce publish
Publishing [email protected]...
Successfully published [email protected]!

For a reference on all the available commands, run vsce --help.

Publishing Extensions

Visual Studio Code leverages Visual Studio Team Services for its Marketplace services. This means that authentication, hosting and management of extensions is provided through that service.

vsce can only publish extensions using Personal Access Tokens. You need to create at least one in order to publish an extension.

Get a Personal Access Token

First, login to or sign up for Visual Studio Team Services.

Then, from your account's home page https://ACCOUNT.visualstudio.com, go to the My Profile page:

My Profile page

Switch to the Security tab and Add a new Personal Access Token:

Add personal access token

Give the Personal Access Token a nice description, optionally extend its expiration date to 1 year and make it access every account:

Personal access token details

The next screen will display your newly created Personal Access Token. Copy it, you'll need it to create a publisher.

Create a Publisher

A publisher is an identity who can publish extensions to the Visual Studio Code Marketplace. Every extension needs to include a publisher name in its package.json file.

Once you have a Personal Access Token, you can create a new publisher using vsce:

vsce create-publisher (publisher name)

vsce will remember the provided Personal Access Token for future references to this publisher.

Login to a Publisher

If you already created a publisher before and simply want to use it with vsce:

vsce login (publisher name)

Similarly to the create-publisher command, vsce will ask you for the Personal Access Token and remember it for future commands.

You can also enter your Personal Access Token as you publish with an optional parameter -p <token>.

vsce publish -p <token>

Auto-incrementing the Extension Version

You can auto-increment an extension's version number when you publish by specifying the SemVer compatible number to increment: major, minor, or patch.

For example, if you want to update an extension's version from 1.0.0 to 1.1.0, you would specify minor:

vsce publish minor

This will modify the extension's package.json version attribute before publishing the extension.

You can also specify a complete SemVer compatible version on the command line:

vsce publish 2.0.1

Packaging Extensions

You may want to simply package extensions without publishing them to the store. Extensions will always be packaged into a .vsix file. Here's how:

vsce package

This will package your extension into a .vsix file and place it in the current directory. It's possible to install .vsix files into Visual Studio Code. See Installing Extensions for more details.

Advanced Usage

Marketplace Integration

You can customize how your extension looks in the Visual Studio Marketplace. See the Go extension for an example.

Here are some tips for making your extension look great on the Marketplace:

  • Any README.md file at the root of your extension will be used to populate the extension's Marketplace page's contents. vsce can fix this for you in two different ways:
  • Likewise, any LICENSE file at the root of your extension will be used as the contents for the extension's license.
  • If you add a repository field to your package.json and if it is a public GitHub repository, vsce will automatically detect it and adjust the links accordingly.
  • You can override that behavior and/or set it by using the --baseContentUrl and --baseImagesUrl flags when running vsce package. Then publish the extension by passing the path to the packaged .vsix file as an argument to vsce publish.
  • You can set the banner background color by setting galleryBanner.color to the intended hex value in package.json.
  • You can set an icon by setting icon to a relative path to a squared 128px PNG file included in your extension, in package.json.

Also see Marketplace Presentation Tips.

.vscodeignore

You can create a .vscodeignore file to exclude some files from being included in your extension's package. This file is a collection of glob patterns, one per line.

For example:

**/*.ts
**/tsconfig.json
!file.ts

You should ignore all files not needed at runtime. For example, if your extension is written in TypeScript, you should ignore all **/*.ts files, like in the previous example.

Note: Development dependencies listed in devDependencies will be automatically ignored, you don't need to add them to the .vscodeignore file.

Pre-publish step

It's possible to add a pre-publish step to your manifest file. The command will be called every time the extension is packaged.

{
    "name": "uuid",
    "version": "0.0.1",
    "publisher": "joaomoreno",
    "engines": {
        "vscode": "0.10.x"
    },
    "scripts": {
        "vscode:prepublish": "tsc"
    }
}

This will always invoke the TypeScript compiler whenever the extension is packaged.

Next Steps

Common Questions

Q: I get 403 Forbidden (or 401 Unauthorized) error when I try to publish my extension?

A: One easy mistake to make when creating the PAT (Personal Access Token) is to not select all accessible accounts in the Accounts field dropdown (instead selecting a specific account). You should also set the Authorized Scopes to All scopes for the publish to work.

Q: I can't unpublish my extension through the vsce tool?

A: You may have changed your extension ID or publisher name. You can also manage your extensions directly on the Marketplace by going to the manage page. You can update or unpublish your extension from your publisher manage page.