mirror of
https://github.com/kennethreitz/bake.git
synced 2026-06-05 23:00:17 +00:00
112 lines
2.8 KiB
TypeScript
112 lines
2.8 KiB
TypeScript
export interface ICreateVSIXOptions {
|
|
/**
|
|
* The location of the extension in the file system.
|
|
*
|
|
* Defaults to `process.cwd()`.
|
|
*/
|
|
cwd?: string;
|
|
/**
|
|
* The destination of the packaged the VSIX.
|
|
*
|
|
* Defaults to `NAME-VERSION.vsix`.
|
|
*/
|
|
packagePath?: string;
|
|
/**
|
|
* The base URL for links detected in Markdown files.
|
|
*/
|
|
baseContentUrl?: string;
|
|
/**
|
|
* The base URL for images detected in Markdown files.
|
|
*/
|
|
baseImagesUrl?: string;
|
|
/**
|
|
* Should use Yarn instead of NPM.
|
|
*/
|
|
useYarn?: boolean;
|
|
}
|
|
export interface IPublishOptions {
|
|
/**
|
|
* The location of the extension in the file system.
|
|
*
|
|
* Defaults to `process.cwd()`.
|
|
*/
|
|
cwd?: string;
|
|
/**
|
|
* The Personal Access Token to use.
|
|
*
|
|
* Defaults to the stored one.
|
|
*/
|
|
pat?: string;
|
|
/**
|
|
* The base URL for links detected in Markdown files.
|
|
*/
|
|
baseContentUrl?: string;
|
|
/**
|
|
* The base URL for images detected in Markdown files.
|
|
*/
|
|
baseImagesUrl?: string;
|
|
/**
|
|
* Should use Yarn instead of NPM.
|
|
*/
|
|
useYarn?: boolean;
|
|
}
|
|
/**
|
|
* The supported list of package managers.
|
|
*/
|
|
export declare enum PackageManager {
|
|
Npm = 0,
|
|
Yarn = 1
|
|
}
|
|
export interface IListFilesOptions {
|
|
/**
|
|
* The working directory of the extension. Defaults to `process.cwd()`.
|
|
*/
|
|
cwd?: string;
|
|
/**
|
|
* The package manager to use. Defaults to `PackageManager.Npm`.
|
|
*/
|
|
packageManager?: PackageManager;
|
|
/**
|
|
* 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.
|
|
*/
|
|
packagedDependencies?: string[];
|
|
}
|
|
export interface IPublishVSIXOptions {
|
|
/**
|
|
* The Personal Access Token to use.
|
|
*
|
|
* Defaults to the stored one.
|
|
*/
|
|
pat?: string;
|
|
/**
|
|
* The base URL for links detected in Markdown files.
|
|
*/
|
|
baseContentUrl?: string;
|
|
/**
|
|
* The base URL for images detected in Markdown files.
|
|
*/
|
|
baseImagesUrl?: string;
|
|
/**
|
|
* Should use Yarn instead of NPM.
|
|
*/
|
|
useYarn?: boolean;
|
|
}
|
|
/**
|
|
* Creates a VSIX from the extension in the current working directory.
|
|
*/
|
|
export declare function createVSIX(options?: ICreateVSIXOptions): Promise<any>;
|
|
/**
|
|
* Publishes the extension in the current working directory.
|
|
*/
|
|
export declare function publish(options?: IPublishOptions): Promise<any>;
|
|
/**
|
|
* Lists the files included in the extension's package.
|
|
*/
|
|
export declare function listFiles(options?: IListFilesOptions): Promise<string[]>;
|
|
/**
|
|
* Publishes a pre-build VSIX.
|
|
*/
|
|
export declare function publishVSIX(packagePath: string, options?: IPublishVSIXOptions): Promise<any>;
|