basant307/AI_Governance_Project

1/**
2 * Creates a VSIX from the extension in the current working directory.
3 * @public
4 */
5export declare function createVSIX(options?: IPackageOptions): Promise<any>;
6
7/**
8 * @deprecated prefer IPackageOptions instead
9 * @public
10 */
11export declare type IBaseVSIXOptions = Pick<IPackageOptions, 'baseContentUrl' | 'baseImagesUrl' | 'githubBranch' | 'gitlabBranch' | 'useYarn' | 'target' | 'preRelease'>;
12
13/**
14 * @deprecated prefer IPackageOptions instead
15 * @public
16 */
17export declare type ICreateVSIXOptions = Pick<IPackageOptions, 'cwd' | 'packagePath'> & IBaseVSIXOptions;
18
19/**
20 * Options for the `listFiles` function.
21 * @public
22 */
23export declare interface IListFilesOptions {
24    /**
25     * The working directory of the extension. Defaults to `process.cwd()`.
26     */
27    cwd?: string;
28    /**
29     * The package manager to use. Defaults to `PackageManager.Npm`.
30     */
31    packageManager?: PackageManager;
32    /**
33     * A subset of the top level dependencies which should be included. The
34     * default is `undefined` which include all dependencies, an empty array means
35     * no dependencies will be included.
36     */
37    packagedDependencies?: string[];
38    /**
39     * The location of an alternative .vscodeignore file to be used.
40     * The `.vscodeignore` file located at the root of the project will be taken
41     * instead, if none is specified.
42     */
43    ignoreFile?: string;
44}
45
46/**
47 * Options for the `createVSIX` function.
48 * @public
49 */
50export declare interface IPackageOptions {
51    /**
52     * The destination of the packaged the VSIX.
53     *
54     * Defaults to `NAME-VERSION.vsix`.
55     */
56    readonly packagePath?: string;
57    readonly version?: string;
58    /**
59     * Optional target the extension should run on.
60     *
61     * https://code.visualstudio.com/api/working-with-extensions/publishing-extension#platformspecific-extensions
62     */
63    readonly target?: string;
64    /**
65     * Ignore all files inside folders named as other targets. Only relevant when
66     * `target` is set. For example, if `target` is `linux-x64` and there are
67     * folders named `win32-x64`, `darwin-arm64` or `web`, the files inside
68     * those folders will be ignored.
69     *
70     * @returns false by default
71     */
72    readonly ignoreOtherTargetFolders?: boolean;
73    /**
74     * Recurse into symlinked directories instead of treating them as files.
75     */
76    readonly followSymlinks?: boolean;
77    readonly commitMessage?: string;
78    readonly gitTagVersion?: boolean;
79    readonly updatePackageJson?: boolean;
80    /**
81     * The location of the extension in the file system.
82     *
83     * Defaults to `process.cwd()`.
84     */
85    readonly cwd?: string;
86    readonly readmePath?: string;
87    readonly changelogPath?: string;
88    /**
89     * GitHub branch used to publish the package. Used to automatically infer
90     * the base content and images URI.
91     */
92    readonly githubBranch?: string;
93    /**
94     * GitLab branch used to publish the package. Used to automatically infer
95     * the base content and images URI.
96     */
97    readonly gitlabBranch?: string;
98    readonly rewriteRelativeLinks?: boolean;
99    /**
100     * The base URL for links detected in Markdown files.
101     */
102    readonly baseContentUrl?: string;
103    /**
104     * The base URL for images detected in Markdown files.
105     */
106    readonly baseImagesUrl?: string;
107    /**
108     * Should use Yarn instead of NPM.
109     */
110    readonly useYarn?: boolean;
111    readonly dependencyEntryPoints?: string[];
112    readonly ignoreFile?: string;
113    readonly gitHubIssueLinking?: boolean;
114    readonly gitLabIssueLinking?: boolean;
115    readonly dependencies?: boolean;
116    /**
117     * Mark this package as a pre-release
118     */
119    readonly preRelease?: boolean;
120    readonly allowStarActivation?: boolean;
121    readonly allowMissingRepository?: boolean;
122    readonly allowUnusedFilesPattern?: boolean;
123    readonly allowPackageSecrets?: string[];
124    readonly allowPackageAllSecrets?: boolean;
125    readonly allowPackageEnvFile?: boolean;
126    readonly skipLicense?: boolean;
127    readonly signTool?: string;
128}
129
130/**
131 * Options for the `publish` function.
132 * @public
133 */
134export declare interface IPublishOptions {
135    readonly packagePath?: string[];
136    readonly version?: string;
137    readonly targets?: string[];
138    readonly ignoreOtherTargetFolders?: boolean;
139    readonly commitMessage?: string;
140    readonly gitTagVersion?: boolean;
141    readonly updatePackageJson?: boolean;
142    /**
143     * The location of the extension in the file system.
144     *
145     * Defaults to `process.cwd()`.
146     */
147    readonly cwd?: string;
148    readonly readmePath?: string;
149    readonly changelogPath?: string;
150    readonly githubBranch?: string;
151    readonly gitlabBranch?: string;
152    /**
153     * The base URL for links detected in Markdown files.
154     */
155    readonly baseContentUrl?: string;
156    /**
157     * The base URL for images detected in Markdown files.
158     */
159    readonly baseImagesUrl?: string;
160    /**
161     * Should use Yarn instead of NPM.
162     */
163    readonly useYarn?: boolean;
164    readonly dependencyEntryPoints?: string[];
165    readonly ignoreFile?: string;
166    /**
167     * Recurse into symlinked directories instead of treating them as files
168     */
169    readonly followSymlinks?: boolean;
170    /**
171     * The Personal Access Token to use.
172     *
173     * Defaults to the stored one.
174     */
175    readonly pat?: string;
176    readonly azureCredential?: boolean;
177    readonly allowProposedApi?: boolean;
178    readonly noVerify?: boolean;
179    readonly allowProposedApis?: string[];
180    readonly allowAllProposedApis?: boolean;
181    readonly allowPackageSecrets?: string[];
182    readonly allowPackageAllSecrets?: boolean;
183    readonly allowPackageEnvFile?: boolean;
184    readonly dependencies?: boolean;
185    readonly preRelease?: boolean;
186    readonly allowStarActivation?: boolean;
187    readonly allowMissingRepository?: boolean;
188    readonly allowUnusedFilesPattern?: boolean;
189    readonly skipDuplicate?: boolean;
190    readonly skipLicense?: boolean;
191    readonly sigzipPath?: string[];
192    readonly manifestPath?: string[];
193    readonly signaturePath?: string[];
194    readonly signTool?: string;
195}
196
197/**
198 * Options for the `publishVSIX` function.
199 * @public
200 */
201export declare type IPublishVSIXOptions = IPublishOptions & Pick<IPackageOptions, 'target'>;
202
203/**
204 * Options for the `unpublish` function.
205 * @public
206 */
207export declare interface IUnpublishOptions extends IPublishOptions {
208    id?: string;
209    force?: boolean;
210}
211
212/**
213 * Options for the `unpublishVSIX` function.
214 * @public
215 */
216export declare type IUnpublishVSIXOptions = IPublishOptions & Pick<IUnpublishOptions, 'id'>;
217
218/**
219 * Lists the files included in the extension's package.
220 * @public
221 */
222export declare function listFiles(options?: IListFilesOptions): Promise<string[]>;
223
224/**
225 * The supported list of package managers.
226 * @public
227 */
228export declare enum PackageManager {
229    Npm = 0,
230    Yarn = 1,
231    None = 2
232}
233
234/**
235 * Publishes the extension in the current working directory.
236 * @public
237 */
238export declare function publish(options?: IPublishOptions): Promise<any>;
239
240/**
241 * Publishes a pre-build VSIX.
242 * @public
243 */
244export declare function publishVSIX(packagePath: string | string[], options?: IPublishVSIXOptions): Promise<any>;
245
246/**
247 * Deletes a specific extension from the marketplace.
248 * @public
249 */
250export declare function unpublishVSIX(options?: IUnpublishVSIXOptions): Promise<any>;
251
252export { }
253