Kami

Kami组件构建工具（Kami Builder） #

安装构建工具 #

$ (sudo) npm install fekit-extension-kami -g

注：当前构建工具版本为 0.4.0，如果工具版本小于 0.4.0 请升级。

版本查看方法：

$ fekit kami

==================== Kami 构建工具 0.4.0 ====================

init            # 初始化组件(供组件开发者使用)
install         # 安装组件
list            # 显示已安装组件
pack            # 打包组件     
publish         # 发布组件(供组件开发者使用)
remove          # 删除指定组件
reset-entry     # 更新指定组件入口文件
update          # 更新指定组件

用户指南 #

1. 安装组件 #

类似 npm，kami 也有自己的组件配置文件 kami.config。示例如下：

{
    "scripts": {
        "alert": "0.0.4"
    }
}

1.1 安装单个组件 #

如果项目里有 kami.config，会优先安装配置文件中指定的版本。

$ fekit kami install [组件名/组件名@版本号] [--save]

1.2 批量安装组件 #

安装配置文件中的所有组件

$ fekit kami install

安转 kami 的所有组件

$ fekit kami install --all

2. 列出已安装组件 #

$ fekit kami list [--remote]

注：加入 --remove 参数，直接显示线上所有组件。

3. 移除组件 #

$ fekit kami remove [组件名/组件名@版本号] [--save]

注：加入 --save 参数，移除组件的同时，也从kami.config的依赖项中移除（只针对组件，删除包含版本号的组件不起作用）

4. 更新组件 #

由于 kami 组件在同一个项目中可能存在多个版本，如果需要更新某个组件，不仅需要安装最新版本，还需要手动将入口文件更新。

# 安装新版本
$ fekit kami install [组件名/组件名@版本号]

# 更新入口文件
$ fekit kami update [组件名/组件名@版本号]

开发者指南 #

1. 初始化组件 #

$ fekit kami init [组件名]

其中 组件名 是可选。如果不加 组件名 ，则在当前目录下初始化组件目录及文件。否则，在当前目录下，会创建一个新的名为 组件名 的目录，在它下面初始化目录及文件。

初始化的结构如下：

{widget}
├── HISTORY.md
├── README.md
├── build.sh
├── index.js
├── kami.config
├── test
└── src
    ├── {widget}.js
    └── tpl
        ├── {widget}.string

2. 打包组件 #

$ fekit kami pack

3. 发布组件 #

$ fekit kami publish