ksp

Kissy Simple Pie

npm install ksp
80 downloads in the last month

KSP - 0.1.0

Kissy Simple Pie

KSP是一个针对KISSY 1.2+的JS模块打包工具,如果你需要对KISSY模块进行打包,又无法忍受Ant复杂的配置,那么你可以尝试一下KSP。

KSP具有如下特点:

  • 使用JSON文件进行灵活的配置.
  • 自动检测文件编码/支持制定编码输出(再也不用纠结编码问题了^0^)
  • 使用UglifyJS进行代码压缩.
  • 基于moduleCompiler,非常感谢@紫英.
  • 使用npmlog进行信息输出.
  • 除了进行普通的打包外,还提供小众模式,让你的包配置和脚本合并到一起,降低对页面的污染。
  • 可以结合强大的Build工具Grunt一起使用,具体请参考grunt-ksp
  • 支持多任务

WIKI

如何开始

安装

KSP是基于nodeJS编写的模块,因此在使用KSP之前,您需要先确保您的电脑中已经安装好了nodeJS,要安装nodeJS,只需要在其官网上下载对应您的平台(Mac/Win/Linux)的安装包就可以了.

安装完毕后,可以简单地使用node预装的包管理工具NPM来安装KSP,在控制台中,输入如下命令:

$ npm install ksp -g

安装完成之后,可以在控制台中输入ksp --version,如果正确地输出了版本号,那么恭喜你,安装成功了:

$ 0.1.0

配置ksp.json

KSP需要一个配置文件ksp.json来告诉它需要打包哪些文件。我们可以通过KSP提供的init命令来生成配置文件。

比如我有一个项目,其结构如下,并且我希望将配置文件放置在项目的根目录中:

path/to/project/app
    ├ build
    ├ source
        ├ js

于是我在控制台中cd path/to/project/app,到达项目根目录中,然后在当前目录下,输入下面的命令:

$ ksp init

接下来KSP将问你几个问题,然后根据你的回答在当前目录下创建一个ksp.json文件,如:

{
    "name": "pkgName",
    "pub": 20130111,
    "charset": "utf8",
    "main": ["./index.js","./base.js"],
    "output": "./build/{{pub}}/{{filename}}.js",
    "backup": true,
    "origin": true,
    "compress": "-min",
    "unicode": true
}

配置文件各字段的详细说名请参考:配置文件说明.

打包

一旦确保你的配置文件配置完毕(好吧,配置是最难的一步)后,你就可以开始打包。显然,打包的命令比构建配置文件简单得多!

在控制台中进入你的配置文件所在的目录,然后输入:

$ ksp

仅此而已,如果没有出现错误,KSP应该已经完成了打包工作,打包后的项目目录如下:

path/to/project/app
    ├ build
        ├ 20121026
            ├ js
                ├ index.js
                ├ index-min.js
                ├ index.source.js
                ├ list.js
                ├ list-min.js
                ├ list.source.js
    ├ source
        ├ js
            ├ index.js
            ├ list.js
            ├ mods
                ├ mod_index.js
                ├ mod_list.js
    ├ ksp.json

License

KSP 遵守 "MIT": https://github.com/neekey/KSP/blob/master/LICENSE 协议

npm loves you