Move promptAddItem to extension API (#19423)

* Move addItem to extension API

* add noneDeployScripts
This commit is contained in:
Charles Gagnon
2022-05-19 11:25:10 -07:00
committed by GitHub
parent 97a4ecdfbb
commit f2b623b3b2
8 changed files with 111 additions and 82 deletions

View File

@@ -54,6 +54,32 @@ declare module 'sqldbproj' {
* @returns the generated sql project
*/
generateProjectFromOpenApiSpec(options?: GenerateProjectFromOpenApiSpecOptions): Promise<ISqlProject | undefined>;
/**
* Prompts the user to add a new item to the specified project
* @param project The project to add the item to
* @param relativeFilePath The relative path in the project where the item should be added
* @param itemType Optional - The type of item to add. If not specified the user will choose from a list of available types
*/
promptAddItem(project: ISqlProject, relativeFilePath: string, itemType?: string): Promise<void>;
}
/**
* The type of an item in a SQL Project
*/
export const enum ItemType {
script = 'script',
table = 'table',
view = 'view',
storedProcedure = 'storedProcedure',
dataSource = 'dataSource',
fileFormat = 'fileFormat',
externalStream = 'externalStream',
externalStreamingJob = 'externalStreamingJob',
folder = 'folder',
preDeployScript = 'preDeployScript',
postDeployScript = 'postDeployScript'
}
/**
@@ -125,15 +151,15 @@ declare module 'sqldbproj' {
*
* @param databaseSource Source of the database to add
*/
addDatabaseSource(databaseSource: string): Promise<void>;
addDatabaseSource(databaseSource: string): Promise<void>;
/**
* Removes database source from the DatabaseSource property element.
* If no sources remain, then property element will be removed from the project file.
*
* @param databaseSource Source of the database to remove
*/
removeDatabaseSource(databaseSource: string): Promise<void>;
/**
* Removes database source from the DatabaseSource property element.
* If no sources remain, then property element will be removed from the project file.
*
* @param databaseSource Source of the database to remove
*/
removeDatabaseSource(databaseSource: string): Promise<void>;
/**
* Excludes entry from project by removing it from the project file
@@ -188,6 +214,21 @@ declare module 'sqldbproj' {
* SqlCmd variables and their values
*/
readonly sqlCmdVariables: Record<string, string>;
/**
* Pre-deployment scripts in this project
*/
readonly preDeployScripts: IFileProjectEntry[];
/**
* Post-deployment scripts in this project
*/
readonly postDeployScripts: IFileProjectEntry[];
/**
* "None" scripts in this project (scripts ignored by the build)
*/
readonly noneDeployScripts: IFileProjectEntry[];
}
/**