@egoo/cli
v2.3.9
Published
Egoo CLI. includes several tools to improve work efficiency.
Readme
egoo
egoo命令行。包含一些提高工作效率的工具。
安装
- 安装Node.js(v18.0+)。如已有node环境则跳过此步。
- 管理员方式打开命令行，安装 egoo 命令行工具。
npm i @egoo/cli -g。更新 egoo 也使用此命令。 - 输入
egoo -v，出现版本信息（类似2.0.0），表明 egoo 安装成功。 - 如果更新有问题，则使用
npm rm egoo -g。先卸载，然后重复步骤3再次安装。
使用
- 发布功能
- 分离功能
- docx转html功能(beta)
- 雪碧图功能(beta)
发布
将文件发布到内网或者外网。
发布到内网。主要方便本地无web server的开发同学，1.进行H5页面真机调试; 2.将地址给相应设计同学进行体验确认。
发布到外网。提供给需求方预览地址（主要是H5页面），供其扫描二维码体验确认。URL转二维码链接
egoo pub/publish [sources] [options]参数说明：
参数 | 说明 ----- | ------------ sources | 要上传的文件路径。支持多个路径，多个路径用空格分割线。
选项说明：
选项 | 说明
------------- | -------------
--mode | 上传的模式，可以是egoo/pinna，默认为egoo。egoo上传到egoodev.top，pinna上传到pinnadev.top。
-p --pinna | 等同于--mode pinna --ignore-injected --ignore-replaced
-e --egoo | 等同于--mode egoo
--ignore-cache | 忽略缓存，全量上传
--config-forcereload | 重新加载配置文件
--ignore-injected | 忽略文件注入
--ignore-replaced | 忽略文本替换
例如：
egoo pub E:\workspace\zoom_bug
egoo pub E:\workspace\zoom_bug -p上述命令表示发布zoom_bug文件夹。
命令行出现publish success.，表示发布成功。 preview url表示预览地址。
注意事项
- 重点：外网地址只是临时地址，仅用于预览体验，不能作为正式发布地址。如果接口人有分享该地址到朋友圈等公开地址的行为，要告知接口人不能这样做——就说是临时预览地址，不稳定，随时可能失效。
- 上传的文件夹（包括其下所有文件名、文件夹名）不能包含中文，否则可能会因乱码而无法访问。例如：
source为E:\workspace\201503\a20150312mweud可以。
source为E:\workspace\201503\a20150312mweud奖励不可以。 - 上传的文件名不能有大写字母，可能无法访问。例如：
source为E:\workspace\201503\SQ26659，不可以。
source为E:\workspace\201503\sq26659，可以。
分离
为了简化图片分离操作，实现此功能。
分离工具。做下列几件事情：
- 复制并重命名（项目名后面加“分离后”）整个包；
- 分离图片。将html文件(.htm,.html,.shtml,.inc)和css文件内的相对地址（ossweb-img/images）转换成cdn地址。查看分离规则。
- 去除协议（可选）。删除url中的 http(s): 部分。不包含嵌入data uri(data:image/...)内的http(s):部分
分离规则
分离html
只会处理html标签的href|src|poster属性。 注意
- 不会处理懒加载等场景下添加的自定义属性。如
<div data-lazy=url /> - 不会处理
<form action=url>、<button formaction=url>、<head profile=url>等
分离样式
只会处理样式的url()部分
所以，分离功能将创建一个分离后的版本。
egoo fenli [sources] [options]参数说明：
参数 | 说明 ----- | ------------ sources | 要分离的文件路径。支持多个路径，多个路径用空格分割线。
选项说明：
选项 | 说明 ------------- | ------------- -u --url | 指定分离路径。如（//game.gtimg.cn/images/dnf/cp/） -a --aliases | 项目所属产品的别名，根据产品找到对应分离路径，一般为产品官网缩写。具体别名请查看(https://fenli.egooidea.com/) ，如果别名未找到，请添加或使用-u选项。 --forcehttps | 强制https，会在分离地址前加上https:，同时，http: 地址会发出错误提示。-a dnf会默认开启强制https
例如：
egoo fenli E:\workspace\a20180108wish -a dnfegoo fenli E:\workspace\a20180108wish -u //game.gtimg.cn/images/dnf/cp/
上述命令会创建一个分离后的项目。
注意事项
- 分离工具，只分离html文件和CSS文件。如果其他文件（JS文件）有需要分离的路径，需自行单独处理。
- 只会分离ossweb-img|images目录下的图片
--
docx转html功能
将word文档(.docx)转换成html。
- 所有图片会导出到ossweb-img文件夹，并且给
<img>标签添加class="docx-img" - 所有以
-开头的段落文本（<p>），会添加class="docx-indent1" - 所有table，会添加
class="docx-table"
egoo docx2html <source>参数说明：
参数 | 说明 ----- | ------------ source | 要转换的word文档路径
注意事项
- beta阶段，谨慎使用。特别是比较复杂的word文档，使用后请和原始word进行对比，确保转换后的html和word内容一致。
- 仅支持单个word转换。
--
雪碧图功能
将图片文件夹内的所有图片导出为一张雪碧图和一个css/scss。
egoo spr <source>参数说明：
参数 | 说明 ----- | ------------ source | 要合成雪碧图的图片文件夹
选项说明：
选项 | 说明 ------------- | ------------- -t --template | css/scss，默认是css --unit_transform_function| scss单位转换函数。当--template为scss时，px单位使用的转换函数。主要用于2倍图等场景。格式如下：r2($$)，$$会转换为具体px单位。r2函数需在外部scss中定义。 -p --padding | 图片之间的间隙，默认为2 -a --algorithm | 雪碧图排列算法。"top-down", "left-right", "binary-tree", "diagonal", "alt-diagonal"。默认binary-tree
注意事项
- beta阶段，谨慎使用。
关于Windows命令行(cmd)使用技巧：
- 粘贴。（鼠标右键--粘贴）
- 复制。（鼠标右键--标记--选择文本）
- 文件路径可直接将文件拖入cmd来生成。