vscode-vsce/README.md
2015-10-07 12:00:22 +02:00

1.5 KiB

VSCode Extension Manager

This tool assists in publishing Visual Studio Code extensions.

npm install -g vsce

Manifest files

Every Visual Studio Code extension needs a manifest file: package.json. Make sure it has at least the following fields:

  • name
  • version
  • publisher
  • engines.vscode

Example:

{
	"name": "uuid",
	"version": "0.0.1",
	"publisher": "joaomoreno",
	"engines": {
		"vscode": "*"
	}
}

Publishing

Before publishing it is good practice to list the files that will be included in your extension's package:

$ vsce ls
hello.js
package.json

If that looks good, you can now publish your extension:

$ vsce publish
Publishing uuid@0.0.1...
Successfully published uuid@0.0.1!

The extension should now appear in the gallery.

Configuration

.vsceignore

You can create a .vsceignore 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

Pre-publish step

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

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

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