1.0.0 • Published 1 year ago
m-fe-cli-utils v1.0.0
m-fe-cli-utils
FE-CLI 以及相关的插件需要用到的 utils 方法及常量
Getting Started
$ npm install m-fe-cli-utils --save
举个栗子:
import { WORKSPACE, getInfo } from 'm-fe-cli-utils';
getInfo().then(userInfo => {
console.log('>> Your name: ', userInfo.name);
});
API
consts 静态常量
name | desc | type | value |
---|---|---|---|
WORKSPACE | 当前的执行目录,即 process.cwd() | string | |
CONFIG_PATH | 全局配置根目录 ~/.feconfig | string | |
PLUGIN_PATH | 全局插件根目录 ~/.feconfig/lib/node_modules | string | |
USER_PROFILE | 用户信息配置文件 ~/.feconfig/profile.json | string | |
FNPM_REGISTRY_URL | fnpm registry 地址 | string | 'http://registry.npm.cfuture.cc' |
FNPM_WEB_URL | fnpm 地址 | string | 'http://npm.cfuture.cc' |
version 版本号相关方法
checkUpdate(registry: string, current: string): Promise<false | string>
检查是否需要更新,如果有新版本,则返回版本号needUpdate(registry: string, current: string): Promise<boolean>
是否有新版本,以及是否需要升级(控制台二次确认)
userinfo 用户信息相关方法
getInfo(): Promise<UserConfig>
获取用户信息,如果没果,则会调用设置setInfo(isUpdate = false)
设置用户信息, isUpdate 表示强制更新
config 获取工作区配置
getWorkspaceConfig(): Promise<WorkspaceConfig>
获取当前工程目录的配置,包含 git 相关信息
interface WorkspaceConfig extends Record<string, any> {
/** 配置类型,一般是 builder */
type: string;
/** 项目构建插件名 (fnpm 包名) */
builder: string;
/** 项目相关信息 */
projectInfo?: {
group: string;
project: string;
version: string;
gitBranch: string;
remote: string;
};
}
helper 生成 helper 信息相关方法
createHelperInfo(options)
创建 helper 字符串
CHANGELOG
- 1.2.0:init
1.0.0
1 year ago