fie-api

3.1.12 • Public • Published

fie-api

NPM version David deps Known Vulnerabilities npm download

fie 对外 api 集合

Installation

npm install fie-api --save

使用

fie-api 是一个 object 对象集合,集成了所有FIE的依赖包,其下面挂截着多个对象, 每个对象都包含着一类操作:

const fieApi = require('fie-api');
const { log, cache } = fieApi;

log.info('啦啦啦');
cache.set('ff', 'ee');
cache.get('ff');

API 列表

fie-api

cache

fie 数据缓存模块, 可以用来存储用户常用数据,支持有效期设置

get(key)

获取缓存内容,如果不存在或已过期则返回 null

  • key {string} 缓存的键值
  • return: {mix} 缓存内容

set(key, value, options)

修改fie配置文件内容

  • key {string} 缓存键值
  • value {mix} 缓存内容,可以为字符串,数字或json对象
  • options {object}
  • options.expires {number} 缓存时间,毫秒为单位,如: 1小时 => 3600000

clear

清除所有缓存

const api = require('fie-api');
const cache = api.cache;

// 将abc这个key的对象写入fie缓存文件。(该缓存文件一般在 ~/.fie/fie.cache.json 中)
cache.set('abc',{ data : 1 });

// 从fie缓存中获取 abc 这个key的内容。
cache.get('abc');
// => return { data : 1 }

//清空fie的缓存内容
cache.clear();

config

fie.config.js 文件操作模块, 可以对 fie.config.js 文件进行读写等操作

get(key, cwd)

获取fie配置文件(fie.config.js)的内容,如果不存则返回 null

  • key {string} 配置的键
  • cwd {string} 配置文件所在的路径, 默认为 process.cwd()
  • return: {mix} 配置内容
//fie.config.js文件
module.exports = {
	toolkit: 'fie-toolkit-dev',
	go : {
	   projectId: 85932,
	   assetsId: 21443
	}
};
const api = require('fie-api')
const config = api.config;
//获取配置文件中go字段的内容
config.get('go');
// => 返回 { projectId : 85932, assetsId : 21443 }

set(key, value, cwd)

修改fie配置文件内容

  • key {string} 配置的键
  • value {mix} 配置的值,可以为字符串,数字或json对象
  • cwd {string} 配置文件所在的路径,默认为 process.cwd()
//原始fie.config.js文件
module.exports = {
  // abc 插件
  abc: {
    xyz: 22
  },
  // 任务列表
  tasks: {
    start: [{
      command: 'echo 33'
    }]
  }
};
const api = require('fie-api')
const config = api.config;
//set 设置一个对象
config.set('abc', {xyz: 23});

//set 设置一个带注释的字符串对象
config.set('gg',
			`
//这是一行注释
{
  "good" : "yes"
}
      `);
      
//set 设置一个带.的字符串
config.set('xx.yy','123');
config.set('tasks.build',[{
			command: 'echo 44'
		}]);
//最终修改输出后的fie.config.js文件
module.exports = {
    // abc 插件
    abc: { xyz: 23 },
    // 任务列表
    tasks: {
        start: [{ command: 'echo 33' }],
        build: [{ command: 'echo 44' }]
    },
    gg: //这是一行注释
    { 'good': 'yes' },
    xx: { yy: 123 }
};

exist(cwd)

判断 fie.config.js 文件是否存在

  • cwd {string} 配置文件所在的路径,默认为 process.cwd()
  • return: {boolean} 是否存在

getToolkitName(cwd)

获取配置文件里面配置的 toolkit 的名字

  • cwd {string} 配置文件所在的路径,默认为 process.cwd()
  • return: {string} toolkit 的名字, 若不存在返回 null
//fie.config.js文件
module.exports = {
	toolkit: 'fie-toolkit-dev',
	go : {
	   projectId: 85932,
	   assetsId: 21443
	}
};
const api = require('fie-api')
const config = api.config;
const toolkit = config.getToolkitName();
// =>  toolkit = fie-toolkit-dev

env

fie内外网环境设置及判断

setExtranetEnv()

设置FIE的运行环境为外网环境

const api = require('fie-api');
const fieEnv = api.env;
fieEnv.setExtranetEnv();

setIntranetEnv()

设置FIE的运行环境为内网环境

const api = require('fie-api');
const fieEnv = api.env;
fieEnv.setIntranetEnv();

isIntranet()

是否是内网环境

优先判断process.env.FIE_ENV变量,值为intranet,则返回true process.env.FIE_ENV 为枚举类型,取值为: intranet / extranet

const api = require('fie-api');
const fieEnv = api.env;
fieEnv.setIntranetEnv();

const resultEnv = fieEnv.isIntranet();
console(resultEnv);  //==> true

fieEnv.setExtranetEnv();
const resultEnv2 = fieEnv.isIntranet();
console(resultEnv2);  //==> false

process.env.FIE_ENV = 'intranet';
const resultEnv3 = fieEnv.isIntranet();
console(resultEnv3);  //==> true

hasConfigFile()

判断FIE环境配置文件(fie.env.json)是否存在,可用做FIE环境是否已初始化的判断

const api = require('fie-api');
const fieEnv = api.env;
fieEnv.setExtranetEnv();
fieEnv.hasConfigFile();  //=> true

removeConfigFile()

删除FIE环境配置文件(fie.env.json)

const api = require('fie-api');
const fieEnv = api.env;
fieEnv.removeConfigFile();
fieEnv.hasConfigFile();  //=> false

fs

fie 文件及文件夹操作模块,一般用于套件中的模板生成及变量替换

copyDirectory(options)

复制目录, 支持 underscore 模板引擎, 标签开始和结束符是: <{% %}>

  • options object
  • options.src string 绝对路径
  • options.dist string 绝对路径
  • options.data object 需要替换变量的数据
  • options.ignore array 数组, 类似 gitignore 的写法
  • options.templateSettings object, 默认是 { evaluate: /<{%([\s\S]+?)%}>/g, interpolate: /<{%=([\s\S]+?)%}>/g, escape: /<{%-([\s\S]+?)%}>/g }
const api = require('fie-api');
const fieFs = api.fs;

fieFs.copyDirectory({
  src: dirSrc,
  dist: dirDist,
  data: {
    name: 'test',
  },
  ignore: ['zzz.js'],
  filenameTransformer(filename) {
    if (filename === 'xxx.js') {
      return 'yyy.js';
    }
    return filename;
  }
});

copyTpl(options)

复制文件, 支持 underscore 模板引擎, 标签开始和结束符是: <{% %}>

  • options object
  • options.src string 绝对路径
  • options.dist string 绝对路径
  • options.data object 需要替换变量的数据
  • options.stringReplace 数组 , 将文件里面匹配到的字符串替换掉,如 [{ placeholder: 'PLACEHOLDER', value: 'theReplaceValue' }]
const api = require('fie-api');
const fieFs = api.fs;

fieFs.copyTpl({
  src: copySrc,
  dist : dist,
  data: {
    name: 'test',
  }
});

rewriteFile(options)

重写文件内容, 该方法不提供读写文件能力,

  • options object
  • options.hook string 判断需要插入行的标记
  • options.insertLines array 数组类型, 每一项为新行
  • options.place string before / after(默认)
  • options.noMatchActive string top / bottom / null(默认)
// src.js
module.exports = {
  name: 'hook',
  description: 'la la la',
};
const content = rewriteFile({
  src : 'src.js',
  hook: 'noHookOfThis',
  insertLines: ['// yiii'],
  noMatchActive: 'top',
});

函数执行后content变量值为:

// yiii
module.exports = {
  name: 'hook',
  description: 'la la la',
};

更多用法可参考: https://github.com/fieteam/fie/blob/master/packages/fie-fs/test/rewrite-file-spec.js

move(srcPath, distPath)

移动文件

  • srcPath string 源文件,绝对路径
  • distPath string 目标文件,绝对路径

remove(file)

删除文件或目录

  • file string 需要删除的文件路径

home

获取 FIE 及模块的相关路径,不建议插件直接对 fie 家目录里面的内容直接进行操作

getHomePath()

获取 FIE 的 home 路径

  • return: {string} 路径字符串

getModulesPath()

获取 FIE 的模块安装路径

  • return: {string} 路径字符串

initHomeDir()

初始化 FIE 的 home 路径

cleanHomeDir()

清空 FIE 的 home 路径

log

以不同颜色在控制台上输出log

fie-log 返回的是一个方法, 调用该方法可以直接返回一个对象, 并进行调用, 大概操作如下:

const log = require('fie-log')('test');

// 普通字符串
log.info('啦啦啦'); // 将紫红色打印:  [test] 啦啦啦
log.cli.info('啦啦啦'); // 仅当前插件或套件做为入口模块时,才以紫色打印:  [test] 啦啦啦
log.func.info('啦啦啦'); // 仅当前插件或套件不是入口模块时,才以紫色打印:  [test] 啦啦啦

// 使用占位符
log.info('字符串:%s 数字:%d ', 'ssss', 33); // 会打印: [test] 字符串:ssss 数字:33
log.info('对象:%o', {a: 1}); // 打打印: [test] 对象:{a: 1}

以下提供的 info success warn error debug 方法均支持了 printf-style 格式化. 支持的格式化方式有:

Formatter Representation
%O 多行打印对象
%o 单行打印对象
%s 字符串
%d 数字
%j JSON
%% 打印 ('%'). 并不代表任何占位符

info(msg)

以品红色打印

  • msg {string} 需要打印的内容

success(msg)

以品绿色打印

  • msg {string} 需要打印的内容

warn(msg)

以品黄色打印

  • msg {string} 需要打印的内容

error(msg)

以品红色打印

  • msg {string} 需要打印的内容

debug(msg)

只有在环境变量 DEBUG 匹配到传入 fie-log 函数时的那个参数时才打印出来, 可参见 debug

  • msg {string} 需要打印的内容

cli

cli 为一个对象, 该对象具用跟上面声明的 info success warn error 用法一样的方法 唯一不同的就是 cli 下面的方法调用后只有当前插件或套件做为入口模块时 , 才打印对应的内容

const log = require('fie-log')('test');

log.cli.info('啦啦啦');
log.cli.error('啦啦啦');
log.cli.warn('啦啦啦');
log.cli.success('啦啦啦');

func

func 为一个对象, 该对象具用跟上面声明的 info success warn error 用法一样的方法 唯一不同的就是 func 下面的方法调用后只有当前插件或套件不是入口模块时 , 才打印对应的内容

const log = require('fie-log')('test');

log.func.info('啦啦啦');
log.func.error('啦啦啦');
log.func.warn('啦啦啦');
log.func.success('啦啦啦');

module

fie 模块的获取、安装及卸载

get(name)

Generator 函数, 获取 fie 模块, 需要运行插件和套件都用这个方法来先获取, 如果本地尚示安装, 会自动进行安装,然后返回模块

  • name {string} 模块名, 若需要获取 package.json 信息可以直接在模块名后面跟上 /package.json
  • return: {object} modInfo 模块对象, modInfo.mod 模块对象, modInfo.options 模块的设置项.
// 名字会自动补齐
const blue = yield fieModule.get('toolkit-blue');
// blue 为blue套件时是一个对象,下面挂载几个命令对应的函数
yield blue.build(fieObj, {
  clientArgs: ['index']
});

// 获取模块手 package.json 信息
const pkg = yield fieModule.get('toolkit-blue/package.json');
console.log(pkg.fieOptions);

install(name)

Generator 函数, 安装 FIE 模块

  • name {string} 模块名, 若需要指定版本号直接在名字后面跟上即可,如: gulp@1.0.0

unInstall(name)

Generator 函数, 卸载 FIE 模块

  • name {string} 模块名

update(name)

Generator 函数, 更新 FIE 模块

  • name {string} 模块名

localList(options)

获取本地已安装的 FIE 插件和套件列表

  • options {object} 可选项
  • options.type {string} 类型,可以是 plugin 或 toolkit, 不传获取全部列表
  • return: {array} 模块列表

onlineList(options)

Generator 函数, 获取线上的 FIE 插件和套件列表

  • options {object} 可选项
  • options.type {string} 类型,可以是 plugin 或 toolkit, 不传获取全部列表
  • return: {array} 模块列表

localExist(name)

判断本地是否已安装对应的 FIE 模块了

  • name {string} 模块名
  • return: {boolean} 是否存在

onlineExist([type])

Generator 函数, 判断线上是否已存在对应的 FIE 模块了

  • name {string} 模块名
  • return: {array} 模块列表

fullName(name)

根据传入的插件或套件名称缩写,生成对应的全称

  • name {string} 缩写的名称
  • return: {string} 全称

pluginFullName(name)

根据传入插件名称缩写,生成对应的插件全称

  • name {string} 缩写的名称
  • return: {string} 全称

toolkitFullName(name)

根据传入套件名称缩写,生成对应套件全称

  • name {string} 缩写的名称
  • return: {string} 全称

npm

npm 操作模块,用于安装,卸载,判断是否存在对应的 npm 模块, 会根据当前用户的配置来判断是要拉取阿里内网还是外网.

install(pkg, options)

Generator 函数,安装一个 npm 包

  • pkg {string} 需要进行操作的包名
  • options {object} 可选项
  • options.registry {string} 包对应的源,默认会根据当前用户选择的网络切换
  • options.stdio {string} 输入输出, 默认为 inherit
  • options.cwd {string} 执行目录, 默认为 process.cwd()
const api = require('fie-api');
const npm = api.npm;

yield npm.install('fie');
yield npm.install('fie@2.7.7');


uninstall(pkg, options)

Generator 函数,卸载一个 npm 包

  • pkg {string} 需要进行操作的包名
  • options {object} 可选项
  • options.stdio {string} 输入输出, 默认为 inherit
  • options.cwd {string} 执行目录, 默认为 process.cwd()

installDependencies(options)

Generator 函数,安装当前目录的 package.json 对应的依赖包

  • options {object} 可选项
  • options.registry {string} 包对应的源,默认会根据当前用户选择的网络切换
  • options.stdio {string} 输入输出, 默认为 inherit
  • options.cwd {string} 执行目录, 默认为 process.cwd()

latest(pkg, options)

Generator 函数,获取最新的 npm 包信息

  • pkg {string} 需要进行操作的包名
  • options {object} 可选项
  • options.registry {string} 包对应的源,默认会根据当前用户选择的网络切换
  • options.version {string} 需要获取信息的版本号或 tag ,默认为 latest
  • return: {object} 如果存在则返回对应的 json 对象 , 否则为 null

has(pkg, options)

Generator 函数,判断是否存在某个 npm 包

  • pkg {string} 需要进行操作的包名
  • options {object} 可选项
  • options.registry {string} 包对应的源,默认会根据当前用户选择的网络切换
  • return: {boolean} 是否存在

task

fie 任务流模块,用于执行fie的任务流

has(tasks, when)

是否存在当前时机的任务流

  • tasks {array} 任务列表
  • when {string} 时机

run(options)

Generator 函数,执行一串任务流, 直接传一对应指令的任务流,并指定进行时机

  • options {object} 选项
  • options.tasks {array} 任务流数组, 如果需要传入函数,仅支持 generator 函数
  • options.when {string} 时机, before 或 after
  • options.args {array} 如果任务流里面有函数,当组数为传给函数的参数
  • options.command {string} 当前正在运行的 fie 指令, 用于在控制台提示及对 $$ 参数进行替换

使用案例

const tasks = [{
  command: 'echo "$$"'
}, {
  * func(a, b) {
    console.log(a, b);
  }
}, {
  command: '__toolkitCommand__'
}, {
  comamnd: 'echo afterTask'
}];

// 调用前置任务
yield run({
  tasks,
  when: 'before',
  args: ['aaa', 'bbb'],
  command: 'test'
});

// 调用后置任务
yield run({
  tasks,
  when: 'after',
  command: 'test'
});

假设命令行里面输入的是 fie test x -y z , 那么上面的两次调用的输出结果分别是:

> x -y z
> aaa bbb
> afterTask

runFunction();

Generator 函数,执行一个函数, 支持 generator 及普通函数

  • options {object}
  • options.method {function} 需要被执行的函数
  • options.args {array} 需要传给 method 的参数
  • options.next {function} 下一步执行方法, 如果 method 是普通函数会自动拼到 args 里面,传给 method, 如果 method 是 generator 函数或 promise 可以不传, 里面会执行完该函数后才退出 runFunction函数

执行普通函数

yield runFunction({
  method(a, b, next) {
    setTimeout(() => {
      console.log(a, b);
      next();
    }, 10);
  },
  args: ['aaa', 'bbb'],
  next() {
    console.log('ccc');
  }
});

// 执行结果
// > aaa bbb
// > ccc

执行 generator 函数

yield runFunction({
  * method(a, b) {
    return new Promise(resolve => {
      setTimeout(() => {
        console.log(a, b);
        resolve();
      }, 10);
    });
  },
  args: ['aaa', 'bbb']
});
console.log('ccc');

// 执行结果
// > aaa bbb
// > ccc

user

根据用户当前 git 信息去获取用户相关信息

getUser()

获取git 用户名和邮箱地址

  • return: {object} 包含用户名和邮箱地址的对象
const fieUser = require('fie-user');
const user = fieUser.getUser();

console.log(user); // {name: 'xxx', email: 'xxx@xxx.xx'}

git

套件或插件,经常需要获取当前项目的git信息,该git工具集提供了一组获取git及项目信息的相关方法。

status([filePath])

获取当前git分支状态。

  • options {filePath} 可选项,默认为 process.cwd()
  • return: {object} 当前git的状态
const api = require('fie-api');
const git = fie.git;

const status = git.status();

// => console.log(status)
{ 
  local_branch: 'xxx',
  remote_branch: null,
  remote_diff: null,
  clean: true/false,
  files: []
}

repository([filePath])

获取项目的远程仓库地址。

  • options {filePath} 可选项,默认为 process.cwd()
  • return: {string} 当前git仓库地址
const api = require('fie-api');
const git = fie.git;

const repository = git.repository();

// => console.log(repository)
// => git@github.com:fieteam/fie.git

project([filePath])

获取当前项目的 NAMESPACE 和 PROJECT_NAME。注:云构建环境下,优先获取云构建提供的信息。

  • options {filePath} 可选项,默认为 process.cwd()
  • return: {string} 当前git仓库的 NAMESPACE/PROJECT_NAME
const api = require('fie-api');
const git = fie.git;

const project = git.project();

// => console.log(project)
// => fieteam/fie

long([filePath])

获取当前最新的一个commit id。注:云构建环境下,优先获取云构建提供的信息。

  • options {filePath} 可选项,默认为 process.cwd()
  • return: {string} commit id
const api = require('fie-api');
const git = fie.git;

const long = long();

// => console.log(long)
// => 5f6f63cf3a7f094c8041054e7092cd7a0e5d0aa5

short([filePath])

获取当前最新的一个commit id。注:云构建环境下,优先获取云构建提供的信息。

  • options {filePath} 可选项,默认为 process.cwd()
  • return: {string} commit id 的前7位
const api = require('fie-api');
const git = fie.git;

const short = short();

// => console.log(short)
// => 5f6f63c

branch([filePath])

获取当前项目的分支名称。注:云构建环境下,优先获取云构建提供的信息。

  • options {filePath} 可选项,默认为 process.cwd()
  • return: {string} branch
const api = require('fie-api');
const git = fie.git;

const branch = branch();

// => console.log(branch)
// => master

以下方法来自git-rev-sync

count()

  • return: {number}

return the count of commits across all branches; this method will fail if the git command is not found in PATH

date()

  • return: {Date}

returns the date of the current commit; this method will fail if the git command is not found in PATH

isTagDirty()

  • return: {boolean}

returns true if the current tag is dirty; this method will fail if the git command is not found in PATH

message

  • return: {string}

return the current commit message; this method will fail if the git command is not found in PATH

tag([markDirty])

  • return: {string}

return the current tag and mark as dirty if markDirty is truthful; this method will fail if the git command is not found in PATH

Support

使用过程中遇到的相关问题,及BUG反馈,可联系: hugohua baofen14787@gmail.com ,也可直接提issues

License

GNU GPLv3

Readme

Keywords

Package Sidebar

Install

npm i fie-api

Weekly Downloads

22

Version

3.1.12

License

ISC

Unpacked Size

67.8 kB

Total Files

5

Last publish

Collaborators

  • hugohua
  • xiaocong.hxc
  • zernmal
  • zhouxiong03
  • akirakai
  • mark-ck
  • channing_hyl