@kintone/plugin-packer
v8.1.3
Published
Package your kintone plugin with pure JavaScript
Downloads
2,087
Readme
kintone-plugin-packer
kintone plugin package.sh in JavaScript
It's written in pure JavaScript, so
- The CLI works with Node.js in Mac/Windows/Linux
- The web page works in any modern browsers
- Validate your
manifest.json
with JSON Schema
How to install
$ npm install -g @kintone/plugin-packer
Usage: CLI
$ kintone-plugin-packer [OPTIONS] PLUGIN_DIR
Options
--ppk PPK_FILE
: The path of input private key file. If omitted, it is generated automatically into<Plugin ID>.ppk
in the same directory ofPLUGIN_DIR
or--out
if specified.--out PLUGIN_FILE
: The path of generated plugin file. The default isplugin.zip
in the same directory ofPLUGIN_DIR
.--watch
,-w
: Watch PLUGIN_DIR for the changes.
How to use with npm run
If your private key is ./private.ppk
and the plugin directory is ./plugin
, edit package.json
:
{
"scripts": {
"package": "kintone-plugin-packer --ppk private.ppk plugin"
}
}
and then
$ npm run package
Usage: Node.js API
const packer = require("@kintone/plugin-packer");
const fs = require("fs");
const buffer = createContentsZipBufferInYourSelf();
packer(buffer).then((output) => {
console.log(output.id);
fs.writeFileSync("./private.ppk", output.privateKey);
fs.writeFileSync("./plugin.zip", output.plugin);
});
License
MIT License