📔 金山办公产品帮助中心

wpsjs工具包使用

文档由 黄泺璇 于 2022-09-27 21:59 创建,由 黄泺璇 于 2022-09-27 21:59 更新
文档标签:
文档分类:
337

wpsjs工具包使用

npm包管理器安装

https://blog.csdn.net/zhuchunyan_aijia/article/details/81143516

全局安装wpsjs包

 为了让npm使用更加畅快,可以将淘宝源设置为默认,命令行中执行:
 `npm config set registry https://registry.npm.taobao.org`
 之后全局安装wpsjs工具,方法如下:
 `npm install wpsjs -g`
如果已经安装,需要更新,则使用 `npm update wpsjs -g`

wpsjs 基本命令

wpsjs 为命令行工具包,主要用于WPS加载项的创建,打包,publish模式打包,取消publish模式,将普通项目转换成加载项项目。具体命令使用,可查看wpsjs --help。

wpsjs create 项目名

创建一个名为demo的WPS加载项

选择加载项的类型选择加载项项目使用的语言

选择之后,会将wpsjs包中的对应类型和对应ui框架在加载项模板复制到demo目录下,完成WPS加载项demo的创建。

wpsjs join

如果不是wpsjs create命令创建的项目,想让它变成WPS加载项,可以通过以下命令:

>npm init  //(如果该项目根目录下有package.json文件,则忽略该步骤)
>wpsjs join   //(指定该加载项项目的类型)

wpsjs debug

该命令是用户开发调试时,启动加载项的命令,wpsjs debug采用jsplugins.xml会自动修改oem.ini配置,并在本地生成jsplugins.xml文件,命令执行后会调起wps,并执行加载项加载。

wpsjs build

该命令是为了打包加载项,主要针对jsplugins.xml模式。

选择WPS加载项模式

image.png

部署加载项

image.png

配置jsplugins.xml

加载项部署成功后,将加载项的地址配置到原有的jsplugins.xml文件中,如果没有,新建一个jsplugins.xml文件,将加载项的地址配置到该文件。部署jsplugins.xml文件。将wps安装目录下的oem.ini文件中的JSPluginsServer的值写成jsplugins.xml文件的部署地址。
jsplugins.xml配置参考:
https://kdocs.cn/l/cBk8tsBIf
[金山文档] 加载项在线模式和离线模式.docx

wpsjs publish(不推荐)

使用wpsjs publish命令前,需要保证package.json文件中有addonType(加载项类型)属性,其值只能为wps,et,wpp。如果没有,可以手动加上,或者使用wpsjs join命令。

image.png

输入项目部署地址

image.png

选择加载项模式

image.png

根据提示,部署加载项项目

image.png

publish模式打包WPS加载项项目,会将项目进行打包,将打包好的文件部署到你写入的服务器地址后。

  • 检测是否部署成功:
  • 在线模式:查看部署地址下的ribbon.xml是否可以访问,可以访问,则部署成功。
  • 离线模式:查看该服务地址是否可以下载加载项包,可以下载,则部署成功。
  • 部署publish.html文件

将publish.html文件部署到服务器上,用户访问服务器上的publish.html进行本地的publish.xml文件更改,实现加载项的加载和卸载操作。

多个加载项部署

当存在多个加载项时,在每一个加载项项目下都执行一次wpsjs publish,并且将每个加载项单独部署。
每一次的publish操作都会进行记录到本地,下一个项目做publish模式打包时,会读取本地记录,将上一次publish的项目加入到本次的publish.html中,部署最后一次打包生成的publish.html文件即可。
如果想去掉某一次publish的记录时,去该加载项项目下执行wpsjs unpublish命令

wpsjs unpublish

取消发布,将该项目从publish.html的记录中清除掉。

清除publish.html中的本项目记录

image.png

部署publish.html文件