Template Extension-Pack Repository

This is a template repository.

This repo is used by create-local-ext-pack to scaffold new local-use extension packs.

Package.json Fields

The package.json file is read by vsce as the extension's 'manifest file'. Information here addresses this manifest in terms of interaction with the setup and install scripts.

Further information:
Extension Manifest Documentation

displayName

As implied, this is the value displayed as the extension's title in the sidebar and web interfaces.

Engines

The engine vscode must be specified.

extensionPack

In the case of an extension pack, the only content-declaring field is extensionPack, which must be assigned an array of ID strings corresponding to the pack's constituents.

dependencies, devDependencies

When vsce packages the extension as a .vsix file, any properties declared on the dependencies object are interpreted as dependencies of the extension, which is most likely not desired. Any packages added during extension configuration should be added with --dev.

config.vscode

This array contains exactly one or both of code and/or code-insiders, as these are the two exectubales installed by the respective vscode versions. During setup by the create-local-ext-pack script, the value is assigned to either:

a) the sole value found within the environment, or b) in the case both are present, one or both value(s) may be chosen by the user.

When invoking ./bin/install.js, the script will install the .vsix to each executable in the array.