kintone Plug-in Examples

This is a repository for kintone plugin-in examples.

package.sh is now deprecated!

package.sh has been deprecated.

Please use @kintone/plugin-packer instead. It requires Node.js.

Requirement

Node.js v12 or later

How to Use

$ npm install -g @kintone/plugin-packer
$ kintone-plugin-packer <plug-in dir> [--ppk <key file>]

For more information, please check the following pages.

Output Files

Plug-in Package

plugin.zip

Private Key

<plug-in id>.ppk

Do not lose the private key! Keep the .ppk file secret and in a safe place. You'll need it later if you want to update the plug-in.

Example

$ cd /tmp
$ git clone https://github.com/kintone/plugin-examples
$ cd plugin-examples
$ npm install -g @kintone/plugin-packer
$ kintone-plugin-packer examples/colorcell
Succeeded: /tmp/plugin-examples/examples/plugin.zip
$ ls examples/*.ppk
examples/dhcpcmonencgafiddfaofdfednmjnbem.ppk

Install Plug-in

See the following document.

https://help.cybozu.com/en/k/admin/plugin.html

https://help.cybozu.com/ja/k/admin/plugin.html

How to Lint

The source code of some plugins applies ESLint. Please run ESLint manually as below after making changes. The Ignored files are see .eslintignore.

Run ESLint:

npm install
npm run lint -- examples/<plug-in dir>

# Example
# npm run eslint -- examples/autonum

Run ESLint with --fix option to fix some wrong styles automatically:

npm install
npm run fix -- examples/<plug-in dir>

# Example
# npm run fix -- examples/autonum

Licence

MIT License

kintone-samples/plugin-samples