gvp-plugin-cli

this is a tool for 敏捷BI build external component 详细文档

整体流程

使用步骤

0 下载工具(require)

// 全局安装cli工具
npm install -g gvp-plugin-cli

// 安装gvp-plugin-cli后，就可以在任何目录使用gvp命令
gvp

Usage: gvp-plugin-cli [command] [options]

Options:
  -V, --version              output the version number
  -h, --help                 output usage information

Commands:
  init [options] <app-name>  Generate a template for project
  generate                   Generate componets json
  sync [options]             Updata componnet Info to platform
  serve [entry]              server a .js file in production mode with zero config
  build [entry]              build a .js file in production mode with zero config

1 初始化项目(require)

// 生成项目文件夹自动下载依赖
gvp init project-test2

? name:(project-test2) 
? description: (This is a component)
downloading template
installing dependens

2 本地开发(rquire)

// 开启本地服务进行本地调试开发
gvp serve

具体的可以参见组件开发及调试

3 打包组件

上传组件之前，需要将组件打包，在组件包根目录执行命令：

gvp build

打包成功后会在根目录下生成dist文件夹。

5 上传插件

上传插件前，需要对dist目录下的package.json文件添加如下字段

{
  "name": "demo-03-tsy",     // 名字 
  "author": "jjc",           // 作者
  "groupId": "com.gridsum",  // 所在组空间
  "artifactId": "demo.03",   // 插件id
  "version": "3.0.0",        // 版本
  "comment": "描述"           // 插件描述
}

把dist目录里的文件打包为一个zip包，通过GVP的插件功能进行上传

(1) 自定义插件
通过仪表盘页面的项目功能菜单里的插件应用功能，上传自定义插件。自定义插件只供单个项目使用

(2) 预置插件
通过管理中心里的插件管理页面，上传预置插件。预置插件可以供指定的多个项目使用

6 组件使用

详细参见组件使用