a2r/utils/settings.d.ts

A2R Framework

import { SolutionInfo, PackageJson, ServerInfo } from '../model';
/**
 * Sets settings file name
 * @param fileName File name
 */
export declare const setFileName: (fileName: string) => Promise<void>;
/**
 * Default dev server info
 */
export declare const defaultDevServer: Required<Pick<ServerInfo, 'name' | 'env'>>;
/**
 * Default server info
 */
export declare const defaultServer: Required<Pick<ServerInfo, 'name' | 'env'>>;
/**
 * Gets `package.json` content from main project path
 * @param projectPath Main project path
 */
export declare const getPackageJson: (projectPath?: string | undefined) => Promise<PackageJson>;
/**
 * Gets project settings
 */
export declare const getSettings: () => Promise<SolutionInfo>;
/**
 * Writes given info as project settings
 * @param info Info to save
 * @param projectPath Main project path
 */
export declare const saveSettings: (info: SolutionInfo, projectPath?: string | undefined) => Promise<SolutionInfo>;
/**
 * Adds component project to solution
 * @param info Project info
 */
export declare const addProject: (info: SolutionInfo['projects'][0]) => Promise<SolutionInfo>;
/**
 * Sets up initial project settings
 * @param projectPath Main project path
 * @param settings Initial settings
 */
export declare const setupSettings: (projectPath: string, settings: SolutionInfo) => Promise<void>;
export default setupSettings;