fekit-extension-kami v0.4.0

Kami构建工具

依赖于fekit，当前版本已支持组件的多版本管理

如何安装

$ [sudo] npm install fekit-extension-kami -g

运行 fekit kami ,如果显示 kami 命令，说明安装成功。

如果提示：请确认是否有 xxx 这个命令 则说明安装失败，请执行以下命令，然后在执行安装。

$ [sudo] chmod 777 ~/.fekit/.extensions

如何使用

初始化组件

$ fekit kami init [组件名]

其中 组件名 可选。

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

初始化的结构如下（以初始化 alert 组件为例）：

    ...
    ├── HISTORY.md
    ├── README.md
    ├── index.js
    ├── kami.config
    ├── test
    └── src
        ├── alert.js
        └── tpl
    ...

注：此命令使用的场景是针对 组件开发者， 组件的使用者 请忽略。

安装组件

以下三种安装方式，在多版本情况下，均不会更改入口文件 index.js 的指向。如果想更改入口 index.js 文件的指向，请使用 fekit kami update 命令。

1. 安装 kami.config 中已指定的组件

$ fekit kami install

注：

• 请确保目录下，已存在 kami.config 文件
• 请确保 kami.config 内容格式合法正确。kami.config 请参见 kami.config配置文件示例

2. 安装线上所有组件

$ fekit kami install --all

注：将会忽略根目录下的 kami.config。安装完成后，会改写 kami.config 内容。

3. 安装指定组件

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

支持的命令格式如下，以安装 alert 组件为例：

$ fekit kami install alert
$ fekit kami install alert@0.0.4
$ fekit kami install alert --save

注： --save 参数意义是，安装组件的同时，将组件信息写入kami.config中。

比如，运行之前 kami.config 内容如下：

{
    "scripts": {}
}

加入 --save 参数，运行之后，内容如下：

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

显示安装组件

1. 显示本地已安装组件

$ fekit kami list

2. 显示线上所有组件列表

$ fekit kami list --remote

3. 显示某个组件所有版本列表

$ fekit kami list [组件名] --remote

4. 显示某个组件被哪些组件所依赖

$ fekit kami list [组件名] --remote --reverse

移除组件

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

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

注：

• 执行 fekit kami remove alert 会删除整个 alert 目录，请 谨慎 操作。
• 执行 fekit kami remove alert@0.0.3 只会删除 alert 目录下的 0.0.3 版本。删除后，请注意入口 index.js 文件的指向。

更新组件入口文件（index.js）

$ fekit kami reset-entry 组件名/组件名@版本号

注：只更新入口文件。如果组件不存在，返回更新失败。

以 alert 示例说明，此组件已安装 0.0.1 那么文件结构如下

├── alert
    ├── 0.0.1
    └── index.js

此时的 index.js 指向 0.0.1 版本。现在，我们执行 fekit kami install alert@0.0.2 安装命令， 此时的文件结构如下

├── alert
    ├── 0.0.1
    ├── 0.0.2
    └── index.js

这时的 index.js 同样指向 0.0.1 ，如果想更改 index.js 指向 0.0.2 版本，执行 fekit kami reset-entry alert@0.0.2 命令即可。

更新组件

$ fekit kami update 组件名/组件名@版本号

注：更新组件分两步操作，第一，先安装组件（存在则删除）；第二，更新入口文件，指向更新的版本。

打包组件

$ fekit kami pack [--debug]

执行以上命令，将在当前目录下生成 kami-x.x.x.css 和 kami-x.x.x.min.js 两个文件。

注：JS文件默认是压缩过的。如果需要打包未压缩的文件，请加入 --debug 参数。

kami.config配置文件示例

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

或者

{
    "scripts": {
        "alert": "*"
    }
}

注：版本号指定 * 会安装最新版本。