常用命名 #

generate 构建项目 #

构建小程序，将 install 过的模块及当前开发模块，打包合并到 dist 目录下。在小程序开发工具上选择项目目录为 dist，即可打开小程序。

ykit g|generate [-w | --watch]
                [-M [port] | --mock [port]]
                [-e <envs> | --env <envs>]
                [-n <path> | --entrance <path>]
                [--debug]
                [-m | --min]

选项与参数 #

-w | --watch #

开启 watch 模式，实时监听文件变化，自动构建。

-M [port] | --mock [port] #

开启 mock 模式，根据用户配置请求 mock 数据。例：

ykit g -M 4000

将开启 mock 服务，并监听在端口 4000。[prot] 为空，默认监听端口 3000。[Mock 配置]

-e <envs> | --env <envs> #

配置环境。参数 envs 格式 env[,biz:env,biz:env,...]。例：

ykit g -e beta,hotel:beta,train:prod

global.__envType = 'beta';
global.__env = {
    "server": "https://some.com",
    "hotel": {
        "envType": "beta"
    },
    "train": {
        "envType": "prod"
    },
    "common": {
        "envType": "prod"
    }
};

全局对象 global 上可能生成以上环境属性。实际生成环境属性值，依赖用户在 app.json 中 env 的配置。[环境配置]

-n <path> | --entrance <path> #

配置开发环境小程序首页显示页面，便于开发具体页面。例：

ykit g -n common/pages/my/my

打开小程序首页默认跳到『我的页面』

--debug #

开启 debug 模式。可通过上传预览版，手机扫码上进入小程序后，通过摇一摇进入 debug 页面。

debug 模式，暂时提供查看环境配置、切换环境配置、跳转任意页面 功能。切换环境配置后，需要关闭小程序（通过关闭微信，关闭小程序）重新进入，切换的环境配置才能完全生效。否则已经加载生效的环境配置无法切换。

-m | --min #

开启压缩

pack 打包代码 #

打包压缩小程序代码文件，合并 js 文件到 bundle.js， 并去掉无用文件和空目录。

ykit pack [-m | --min]
          [--publish]
          [-e <envs> | --env <envs>]
          [--debug]

选项与参数 #

-m | --min #

pack 完成后，会进一步使用微信上传逻辑打包代码，计算并显示最终小程序 size 大小。例：

--publish #

在 ./prd 目录下生成微信上传文件 origin.wx。后续可通过 upload 命令进行微信上传操作。

-m 时 --publish 才生效

-e | --env #

环境配置，同 generate

--debug #

开启 debug 模式。同 generate

install 安装模块 #

安装模块。

ykit install [module_name[@version],module_name[@version],...]

选项与参数 #

module_name[@version] #

• module_name：模块名
• version 支持：
  • 数字版本，例如：0.1.0。注意，同时会更新 package.json
  • btag，例如：b-170405-222222-ming.xiao
  • Git 分支，例如：#release（# 开头）
  • '0.0.0'，下载最新 btag 版本
  • version 省略，下载 package.json 里 modules 指定的该模块版本。如果 modules 没有配置该模块，下载最新版本。

如果直接 ykit install 后面不加模块参数，则安装 package.json 文件里 modules 字段配置的模块及指定版本。例：modules 配置

"modules": {
    "home_xxx": "^0.1.8",
    "common": "^0.2.0",
    "xxx1": "^0.1.2",
    "xxx2": "^0.1.0",
    "xxx3": "^0.1.6"
}

clean 清除恢复 #

清除打包目录和缓存目录（.ykit_cache, prd, dev, dist）等。恢复忽略的模块，去掉 libs 里文件名带有的 .ignore 后缀。

ykit clean

env 环境信息 #

打印环境配置信息

ykit e|env [-e <envs> | --env <envs>]

打印信息：

{
    "server": "https://wxapp.qunar.com",
    "hotel": {
        "envType": "prod"
    },
    "common": {
        "envType": "prod"
    }
}

list 查询模块 #

打印当前项目 libs 目录下已经安装模块及版本

ykit list [-s | --short]

打印信息：

[Wmp] • Module List :
> home_qunar : 0.1.8
> hotel : b-170525-175847-ming.xiao
> train : 0.1.6

size 查看大小 #

打印当前小程序及各模块占用 size 情况。

ykit size [-o|--output]

选项与参数 #

-o|--output #

输出 size 信息到 prd/size.json。

高级命名 #

pkg 打包压缩 #

打包压缩当前项目到 moduleName-version.w 文件。.w 文件即模块安装文件格式，可以直接放在模块安装目录 libs 下使用。

ykit pkg|k [-v <version>| --version <version>]

不指定 -v <version>，则为 package.json 中指定版本。

选项与参数 #

-v | --version #

如果 -v <version> 指定了版本，文件名优先使用此版本。版本参数省略使用 package.json 的 version。

publish 发布模块 #

命令行打包，qdr 发布 job。

ykit publish

info 详细信息 #

生成小程序详细信息到 prd/info.html。

ykit info [-i|--appid <appid>]
          [-T|--title <title>]
          [-t|--tag <tag>]
          [-e <envs> | --env <envs>]

选项与参数 #

-i|--appid <appid> #

配置小程序 appID。

-T|--title <title> #

项目名称。

-t|--tag <tag> #

项目当前 tag 名。

-e <envs> | --env <envs> #

环境参数仅支持主程序参数配置。例：

ykit info -e beta

upload 上传项目 #

微信上传。

ykit upload -i|--appid <appid>
            [-d|--desc [description]]
            [-p|--preview]

注意：需要首先执行 ykit pack -m --publish，生成 prd/origin.wx 上传代码包。

选项与参数 #

-p|--preview #

上传预览版。同时会在项目 prd 目录下生成带预览版二维码的 preview.html, preview.png。