@tuzki/cli
Version:
🐇 lowcode-cli is an efficient cli tool for Rabbitpre plugin component secondary development. ❤️
71 lines (70 loc) • 1.83 kB
TypeScript
import { CliConfig } from '@tuzki/scaffold-types';
/**
* 获取配置,主要包含本地配置和 .env 配置
* 优先级:.env > local > default
*
* @export
* @return {*} {Promise<CliConfig>}
*/
export declare function getConfig(): CliConfig;
/**
* 获取 .env 环境配置
*
* @export
* @param {ENV} env
* @return {*}
*/
export declare function getDotenvConfig(): CliConfig;
/**
* 获取本地配置
* @returns
*/
export declare function getLocalConfig(): CliConfig;
/**
* 查看某一配置
* @param name 配置名称
* @returns
*/
export declare function getConfigByName(name: string): any;
/**
* 设置配置到本地文件
* @param localConfig 需要写到本地的配置
* @returns
*/
export declare function setLocalConfig(localConfig: CliConfig): Promise<unknown>;
/**
* 根据name value设置本地配置
*
* @export
* @param {string} name 配置名称
* @param {string} value 配置值
*/
export declare function setLocalConfigByName(name: string, value: string): Promise<void>;
/**
* 删除本地配置
*
* @export
* @param {(string | string[])} name 删除配置名称, 不传则删除所有
*/
export declare function unsetLocalConfig(name?: string | string[]): Promise<void>;
export declare const isLogin: () => Promise<boolean>;
/**
* 根据传入的环境字符串, 更新当前配置
* @param inputEnv
*/
export declare const injectConfigEnv: () => Promise<void>;
/**
* 更新配置
* @param configOpt
*/
export declare const updateConfig: (configOpt: Partial<CliConfig>) => void;
/**
* 获取所有配置,包含 cli option 对配置的修改,优先级最高
* @returns
*/
export declare const getCliConfig: () => CliConfig;
/**
* 暴露出代理配置对象, 目前不支持直接打印
*/
declare const _default: CliConfig;
export default _default;