@uyun/cli-command-widget

优云前端 widget 打包工具

安装

在已安装@uyun/cli的项目中安装@uyun/cli-command-widget，然后就可以在项目package.json中scripts里使用了

安装@uyun/cli-command-widget

yarn add @uyun/cli-command-widget -D

编辑package.json，在scripts字段中添加如下命令

{
  "scripts": {
    "itsmfield:build": "everest itsmfield:build ./src/widgets",
    "itsmfield:create": "everest itsmfield:create ./src/widgets",
    "itsmfield:inspect": "everest itsmfield:inspect ./src/widgets"
  }
}

 # 打包widget
yarn itsmfield:build

# 审查widget开发配置
yarn itsmfield:inspect

命令

everest itsmfield:build <folder>

打包指定文件夹下的文件为可发布部件

everest itsmfield:build [folder]
打包指定文件夹下的文件为可发布部件

位置：
  folder  widgets文件夹                       [字符串] [默认值: "./src/widgets"]

选项：
  --help           显示帮助信息                                           [布尔]
  --version        显示版本号                                             [布尔]
  --mode, -m       加载 .env 环境变量文件                               [字符串]
  --output, -o     自定义打包输出文件夹           [字符串] [默认值: "./widgets"]
  --staticPath, -sp     自定义静态资源文件夹           [字符串] [默认值: "./static"]
  --sourcemap, -s  是否生成source map                     [布尔] [默认值: false]

everest itsmfield:create <dirname>

在指定目录下创建新 widget，产品名称支持自定义，但必须符合规则/^[a-z][a-z0-9-]*$/，部件名称也必须符合/^[a-z][a-z0-9-]*$/

everest itsmfield:create <dirname>

在指定目录下创建新widget

位置：
  dirname  widget的父目录                                        [字符串] [必需]

选项：
  --help     显示帮助信息                                                 [布尔]
  --version  显示版本号                                                   [布尔]

everest itsmfield:inspect <folder>

审查 widget 打包配置信息

everest itsmfield:inspect [folder]

审查widget打包配置信息

位置：
  folder  widgets文件夹                       [字符串] [默认值: "./src/widgets"]

选项：
  --help           显示帮助信息                                           [布尔]
  --version        显示版本号                                             [布尔]
  --mode, -m       加载 .env 环境变量文件                               [字符串]
  --output, -o     自定义打包输出文件夹           [字符串] [默认值: "./widgets"]
  --staticPath, -sp     自定义静态资源文件夹           [字符串] [默认值: "./static"]
  --sourcemap, -s  是否生成source map                     [布尔] [默认值: false]

widget.json 文件

{
  "name": "cmdb/calendar",
  "path": "/cmdb",
  "dependencies": ["cmdb"],
  "category": [],
  "lang": {
    "zh_CN": {
      "title": "日历组件",
      "desc": "这是一个日程组件"
    },
    "en_US": {
      "title": "calendar",
      "desc": "this is a calendar"
    }
  },
  "css": true,
  "height": 500
}

字段	描述	类型	规范	备注
name	widget 标识，用于区分不同的 widget	string	必选，名称必须为”产品名/部件名“，如"cmdb/timeline"，产品名支持指定以，但必须符合正则`/^[a-z][a-z0-9-]\/[a-z][a-z0-9-]$/`
path	widget 打包部署之后访问的目录路径	string	必选 ]
dependencies	组件依赖的环境	array	可选	数组的元素必须为枚举的字符串，枚举范围暂未定
category	widget 类别信息	array	必选	为枚举值，枚举范围未定
lang	语言信息	object	必选，键值为语言信息 key，如`zh_CN`、`en_US`等	语言对象子对象见后面 lang 字段部分
css	widget 打包后是否有生成 css 文件	boolean	注意：本字段不需要用户填写，打包工具会自动处理，本字段只是用来告诉 portal 是否去加载 widget 样式
height	widget 的高度值	number	必选，高度为大于 0 的整数

lang 字段说明

lang 下语言中定义的字段，例如 lang.zh_CN，后续可能还会有其他字段

字段	描述	类型	规范	备注
title	widget 的标题	string	必选
desc	widget 的说明信息	string	必选

Current Tags

0.0.9 ... latest (5 years ago)