@fed123/fe-cli-utils

fe-cli-utils

Usage no npm install needed!

<script type="module">
  import fed123FeCliUtils from 'https://cdn.skypack.dev/@fed123/fe-cli-utils';
</script>

README

fe-cli-utils

FE-CLI 以及相关的插件需要用到的 utils 方法及常量

Getting Started

  • $ npm install @fed123/fe-cli-utils --save

举个栗子：

import { WORKSPACE, getInfo } from '@fed123/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
NPM_REGISTRY_URL npm registry 地址 string 'http://registry.npm.taobao.org'
NPM_WEB_URL npm 地址 string 'http://web.npm.taobao.org'

version 版本号相关方法

  1. checkUpdate(registry: string, current: string): Promise<false | string> 检查是否需要更新，如果有新版本，则返回版本号

  2. needUpdate(registry: string, current: string): Promise<boolean> 是否有新版本，以及是否需要升级(控制台二次确认)

userinfo 用户信息相关方法

  1. getInfo(): Promise<UserConfig> 获取用户信息，如果没果，则会调用设置

  2. setInfo(isUpdate = false) 设置用户信息, isUpdate 表示强制更新

gitlab git相关方法

  1. gitlabFetch(api: string, options: GitlabRequestOption = {}) 调用 gitlab 开放 API，具体接口参考 https://docs.gitlab.com/ee/api/README.html#basic-usage

  2. checkUser(username: string): Promise<GitlabUser> 检查用户是否存在，如果有，则返回用户信息

  3. searchUser(keyword: string): Promise<GitlabUser[]> 通过邮箱、账号、昵称 关键字搜索用户

  4. getGroups(): Promise<GitlabGroupProps[]> 获取有 cffe 账号有权限的 namespace (group)

  5. createProject(options: CreateProjectOption) 创建一个项目仓库(以 cffe 的身份)

CHANGELOG

LICENSE

BSD-3-Clause License

Contact Us

chalecao(ch19900606@gmail.com)