@hasaki-ui/hsk-ryze

    1.0.16 • Public • Published

    hsk-ryze

    作者:joyer,邮箱:972325584@qq.com,最后修改时间:2017年9月7日星期四

    作者是个菜逼,有什么错误,欢迎指正。

    HskUI的cli命令行工具,支持使用命令执行一些常用功能

    使用

    下载:

    sudo npm i -g @hasaki-ui/hsk-ryze
    

    使用

    // 构建dev环境
    ryze build dev
    

    指令

    指令名字为ryze,别名rz,hsk

    指令的格式为

    ryze [options] [command]
    

    下文将会详细介绍各个命令

    ryze build [env]

    别名:b

    构建HskUI项目

    env 为构建环境,用于指定项目build-config的配置环境

    选项:

    • disable_build 是否不开启编译器

    例:

    ryze build dev
    // or
    ryze build prod
    

    ryze create <type> <name>

    别名:c

    根据模版创建代码

    type:类型

    name:名字

    ryze create project <name>

    按照指定的模版创建一个HskUI项目

    project可以简写为P

    该命令支持的选项有:

    • -t, --tpl:项目模版名字
    • -u, --url:项目模板地址,该地址不是http地址,而是github中user(organization)/repository,如HasakiUI/hsk-tpl-blank

    如:

    ryze create project first-project --tpl blank
    // or
    ryze create project first-project --url 'HasakiUI/hsk-tpl-blank'
    

    ryze create page <name>

    page可以简写为p

    根据模版创建一个页面

    该命令支持的选项有:

    • -d, --dir 目标目录,该目录是相对于项目页面目录,不配置会直接在项目页面目录下生成页面
    • -w, --wrapper 是否生成页面的同名目录

    如:

    ryze create page student
    // or
    ryze create page student --dir 'path/to/student'
    

    在模版中能使用的模版参数:

    • name: 命令中指定的name
    • pageName:页面名,页面名字是解析页面文件名后形成,解析的规则请见路由的生成
    • fileName:页面的文件名
    • filePath:页面的相对路径,相对于src/page

    ryze create component <name>

    component可以简写为comp

    根据模版创建一个组件

    该命令支持的选项有:

    • -p, --prefix 组件的前缀
    • -f, --force 是否强制创建组件,强制创建组件时,如果组件已经存在,删除原有重建

    如:

    ryze create component test-comp
    ryze create component test-comp --prefix tk
    

    在模版中能使用的模版参数:

    • name: 命令中指定的name
    • fullPath:组件的绝对路径
    • path:组件的相对路径
    • componentName:组件名名

    ryze create mod <name>

    mod可以简写为m

    根据模版创建一个模块

    该命令支持的选项有:

    • -d, --dir 目标目录,该目录是相对于项目页面目录,不配置会直接在项目页面目录下生成页面
    ryze create page test-mod
    // or
    ryze create page test-mod --dir 'path/to/student'
    

    在模版中能使用的模版参数:

    • name: 命令中指定的name
    • fileName:文件名
    • filePath:文件路径,相对于src/page
    • pageName:页面名字,解析当前模版的文件夹名字而来,所以不是特别靠谱,如果使用在生成后的模块中注意检查

    ryze init

    别名:i

    初始化一个HskUI项目

    该指令会执行npm install,如果当前环境中支持cnpm,会自动使用cnpm install

    选项:

    • --disa--disable_delete 是否不删除node_modules

    如:

    ryze init
    

    ryze make <type>

    别名:mk

    使用脚本生成代码

    type:代码类型

    ryze make api

    生成api mock或者api 原文件的代理文件,支持ajax和webSocket类型api

    该命令支持的选项有:

    • -m, --model 生成模式,有mock,proxy选项
    • -w, --workspace 工作目录
    • -t, --time mock时间,单位毫秒
    • -i, --interval mock webSocket间隔时间,单位毫秒
    • -M, --mockFolderName mock目录
    • -P, --proxyFolderName proxy目录

    如:

    ryze make api --model mock --workspace workspace --time 10 --mockFolderName mock
    

    ryze make icon

    根据阿里图标库的css样式地址,下载图标的资源文件

    该命令支持的选项有:

    • -u, --aliUrl 阿里图标库样式表url,注意不能以协议开头
    • -d, --dir 存放生成的资源文件的目录

    如:

    ryze make icon --aliUrl '//at.alicdn.com/t/font_llegsn6q453tyb9.css' --dir my-icon
    

    ryze make idx

    生成一个目录的index.js文件,该文件会导入该文件夹下其它文件导出的default,并且导出(不是作为default)

    该命令支持的选项有:

    • -T, --targetPath 需要自动index.js的文件夹

    如:

    ryze make idx --targetPath target
    

    ryze make router

    根据项目中页面的目录结构,自动生成路由

    如:

    ryze make router
    

    ryze make wrapper

    生成指定目录下次级文件和文件夹的代理文件,代理文件导入目标文件的default,也是以default导出

    该命令支持的选项有:

    • -S, --sourcePath 需要生成代理的目录
    • -T, --targetPath 生成的代理文件存放目录
    • -p, --prefix 前缀
    • -s, --suffix 后缀

    如:

    ryze make wrapper --sourcePath source --targetPath target --prefix hsk --suffix tk
    

    ryze -V

    或者 ryze --version

    查看版本

    ryze -h

    或者 ryze --help

    查看帮助信息

    配置

    在项目的根目录下配置.ryzerc或者ryze.config.js配置指令的配置项

    配置项的内容和要求可以查看说明文件

    测试

    下载换吗后,进入根目录后执行

    npm run test
    

    进行测试

    参考文档

    如何使用模版快速开发

    Keywords

    none

    Install

    npm i @hasaki-ui/hsk-ryze

    DownloadsWeekly Downloads

    107

    Version

    1.0.16

    License

    MIT

    Last publish

    Collaborators

    • avatar
    • avatar