Index

• 概要

• 所谓plugin-packer

• 安装方法

• 基本使用方法

• 选项功能

• Web版

• 最后

• 注意事项

概要

为了能更加方便地开发kintone的插件，插件开发辅助工具群发布了！

本次就其中之一的plugin-packer进行说明。

※关于其他工具请参考此处。

所谓plugin-packer

plugin-packer是CLI工具，用于将插件目录下的文件打包成zip格式的插件文件。

可支持npm，因此可在Windows/macOS/Linux等任意环境下轻松运行。

代码发布在GitHub里。

※以前用package.sh的打包方法已不推荐。推荐使用此处介绍的使用命令行工具打包。

※ 使用此工具需要安装Node，其版本要求请参考仓库package.json下的engines属性。
例如：engines下注明如下时，表示需要Node.js版本10以上。

"engines": {
  "node": ">=10"
 },

安装方法

安装plugin-packer。

※ 此处以通过npm进行全局安装的方法为例进行说明。

$ npm install -g @kintone/plugin-packer

执行此命令即可安装plugin-packer。

基本使用方法

首先，按照下图目录结构保存做好的插件程序。
关于文件内容以及目录结构请参考此文档。

执行以下命令，即可开始自动打包。

$ cd sample_project
$ kintone-plugin-packer plugin_dir

※ 以下范例中，“plugin_dir”改为“src”后再执行。

执行范例

# 执行前确认目录结构    
$ tree    
.    
└── src    
    ├── css    
    │   ├── 51-modern-default.css    
    │   ├── config.css    
    │   └── desktop.css    
    ├── html    
    │   └── config.html    
    ├── image    
    │   └── icon.png    
    ├── js    
    │   ├── config.js    
    │   └── desktop.js    
    └── manifest.json

# 执行plugin-packer    
$ kintone-plugin-packer src    
Succeeded: dir_path/plugin-packer/plugin.zip

# 确认执行结果    
# => 生成plugin.zip和ppk    
$ tree    
.    
├── faabchdodajloackbgnipilddblmkejp.ppk    
├── plugin.zip    
└── src    
    ├── css    
    │   ├── 51-modern-default.css    
    │   ├── config.css    
    │   └── desktop.css    
    ├── html    
    │   └── config.html    
    ├── image    
    │   └── icon.png    
    ├── js    
    │   ├── config.js    
    │   └── desktop.js    
    └── manifest.json

执行命令，即生成plugin.zip和密钥文件。

将此plugin.zip导入到kintone中即可使用插件。

选项功能

再次打包时

再次打包时请使用--ppk选项指定密钥文件。

$ kintone-plugin-packer --ppk plugin_key plugin_dir

zip文件的生成目录、文件名指定

用--out命令指定<要生成插件的目录/zip文件名＞，即可对插件zip文件的生成目录和文件名进行更改。

$ kintone-plugin-packer --out ../zip_dir/test.zip plugin_dir

※ 如不指定--out选项，将默认在插件文件(src)的目录下生成名字为plugin.zip的插件文件。

监控文件

使用--watch可以对目录的更改进行监视，并每次更改都生成zip文件。

$ kintone-plugin-packer --watch plugin_dir

※ 如要停止监视，请用“ctrl + c”命令取消。

Web版

还有plugin-packer for Web版，可以将整个src目录拖进去即可进行打包。

https://plugin-packer.kintone.dev/

最后

用以前的package.sh进行打包时，Windows的话需要准备Cygwin等可运行Shell的环境。
但使用此plugin-packer的话，可非常方便地使用命令行及PowerShell进行打包。

另外，和plugin-uploader一起组合使用的话，kintone插件开发会变得更加简单哦！

注意事项

根据许可协议可以对代码进行更改、重新发布以及用于商业目的。