@sap/generator-fiori
Version:
Create an SAPUI5 application using SAP Fiori elements or a freestyle approach
38 lines • 1.88 kB
TypeScript
import type { AppWizard } from '@sap-devx/yeoman-ui-types';
import type { FioriAppGeneratorOptions, Floorplan } from '@sap-ux/fiori-app-sub-generator';
import { type ILogWrapper } from '@sap-ux/fiori-generator-shared';
import type { TileChoiceOptions, TileSelectQuestion } from '../types';
/**
* Load the `@sap-ux/fiori-app-sub-generator` i18n texts and return the supported template/floorplan map.
*
* @returns A map of floorplan choices with their respective properties
*/
export declare function getTemplateChoices(): Promise<Record<Floorplan, TileChoiceOptions>>;
/**
* Get the floorplan questions.
* The applicationType prompt will only be shown when necessary. i.e. When there are more than 1 category of floorplan
*
* @param generatorVersion, the version to appear in the prompt hint
* @param floorplans, floorplans which will be prompted, or all if undefined
* @returns
*/
export declare function getFloorplanPrompt(floorplans?: Floorplan[] | undefined): Promise<TileSelectQuestion>;
/**
* Get workspace folders from vscode object, set cwd if CLI
* @param vscode vscode object passed to the generator
* @returns array of folders/paths
*/
export declare function getWorkspaceFolders(vscode: any, logger: ILogWrapper): Promise<string[]>;
/**
* Shows an app wizard (Yeoman UI) message.
*
* @param message the message to display on the navigation footer and the severity to determine the icon, default severity is 'information'
* @param appWizard a reference to the app wizard instance
*
*/
export declare function showWizardMessage(message: FioriAppGeneratorOptions['wizardMessage'], appWizard: AppWizard): void;
/**
* Initializes Fiori AI by checking for prerequisites and setting up the AppWizard banner.
*/
export declare function setBanner(vscode: any, appWizard: AppWizard, logger?: ILogWrapper): Promise<void>;
//# sourceMappingURL=utils.d.ts.map