Logo for jsDocs.io

vsce

  • Version 2.15.0
  • Published
  • 150 kB
  • 20 dependencies
  • MIT license

Install

npm i vsce
yarn add vsce
pnpm add vsce

Overview

VSCode Extension Manager

Index

Functions

Interfaces

Enums

Type Aliases

Functions

function createVSIX

createVSIX: (options?: IPackageOptions) => Promise<any>;

  • Creates a VSIX from the extension in the current working directory.

function listFiles

listFiles: (options?: IListFilesOptions) => Promise<string[]>;

  • Lists the files included in the extension's package.

function publish

publish: (options?: _IPublishOptions) => Promise<any>;

  • Publishes the extension in the current working directory.

function publishVSIX

publishVSIX: (
    packagePath: string | string[],
    options?: IPublishVSIXOptions
) => Promise<any>;

  • Publishes a pre-build VSIX.

Interfaces

interface IListFilesOptions

interface IListFilesOptions {}

    property cwd

    cwd?: string;

    • The working directory of the extension. Defaults to process.cwd().

    property ignoreFile

    ignoreFile?: string;

    • The location of an alternative .vscodeignore file to be used. The .vscodeignore file located at the root of the project will be taken instead, if none is specified.

    property packagedDependencies

    packagedDependencies?: string[];

    • A subset of the top level dependencies which should be included. The default is undefined which include all dependencies, an empty array means no dependencies will be included.

    property packageManager

    packageManager?: PackageManager;

    • The package manager to use. Defaults to PackageManager.Npm.

    Enums

    enum PackageManager

    enum PackageManager {
        Npm = 0,
        Yarn = 1,
        None = 2,
    }

    • The supported list of package managers.

    member None

    None = 2

      member Npm

      Npm = 0

        member Yarn

        Yarn = 1

          Type Aliases

          type IBaseVSIXOptions

          type IBaseVSIXOptions = Pick<
              IPackageOptions,
              | 'baseContentUrl'
              | 'baseImagesUrl'
              | 'githubBranch'
              | 'gitlabBranch'
              | 'useYarn'
              | 'target'
              | 'preRelease'
          >;

          • Deprecated

            prefer IPackageOptions instead

          type ICreateVSIXOptions

          type ICreateVSIXOptions = Pick<IPackageOptions, 'cwd' | 'packagePath'> &
              IBaseVSIXOptions;

          • Deprecated

            prefer IPackageOptions instead

          type IPublishOptions

          type IPublishOptions = _IPublishOptions;

            type IPublishVSIXOptions

            type IPublishVSIXOptions = IPublishOptions & Pick<IPackageOptions, 'target'>;

              Package Files (1)

              Dependencies (20)

              Dev Dependencies (26)

              Peer Dependencies (0)

              No peer dependencies.

              Badge

              To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

              You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/vsce.

              • Markdown
                [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/vsce)
              • HTML
                <a href="https://www.jsdocs.io/package/vsce"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>