rgui-tools

Developer Tools for Regular UI

Usage no npm install needed!

<script type="module">
  import rguiTools from 'https://cdn.skypack.dev/rgui-tools';
</script>

README

rgui-tools

Developer Tools for Regular UI

NPM Version Dependencies NPM Download

Install

npm install -g rgui-tools

QuickStart

rgui-tools init -c ListView,Item ui-listview
cd ui-listview
rgui-tools dev
open docs/listView/index.html

Commands

  • rgui-tools help:查看帮助
  • rgui-tools init -c <components> <repo>:初始化一个仓库(只支持以ui-开头的仓库,暂不支持多组件)。示例:rgui-tools init -c Uploader ui-uploader

以下命令在仓库目录下(如./ui-sample)运行:

  • rgui-tools docs:生成文档
  • rgui-tools gh-pages:重新生成文档,并将./docs目录下的文档发布到该仓库的gh-pages中。
  • rgui-tools dist:打包当前目录下的index文件
    • -o, --output <output>:库的文件名(不带后缀)。默认为index
    • --library <library>:库的命名空间。默认为RGUI
    • --devtool <devtool>:webpack的devtool参数
  • rgui-tools test:运行测试
    • --browsers <browsers>:测试浏览器。多个以逗号隔开,默认为PhantomJS
    • --reporters <reporters>:测试报告。多个以逗号隔开,默认为nyan,coverage
  • rgui-tools lint:验证代码风格
    • -f, --fix:验证时自动修复
  • rgui-tools publish:修改version,提交代码,打tag,然后发布npm版本。
  • -w, --watch:监听文件变更。以上命令都可以配置该选项(默认不会监听)。
  • -O, --online-mode:线上模式。test命令配置该选项后,会设置测试报告为mocha,coverage,coveralls
  • -v, --verbose:输出详细信息
  • -V, --version:当前版本

集成命令:

  • rgui-tools dev:生成文档+验证代码风格,始终监听文件,自动修复lint问题。相当于rgui-tools docs,lint --watch --fix
  • rgui-tools clean:手动清理所有rgui-tools命令生成的文件(以上命令默认在初始运行时也会清理生成的文件)。相当于rgui-tools docs-clean,cache-clean,dist-clean,test-clean