AdventCalendar
kintone
kintoneRestApi
kintoneplugin
kintoneDay 20

kintone pluginを作る上で気を付けるべき8つのポイント

この記事は
kintone Advent Calendar 20日目 の記事になります。

時は師走。もう年末はそこまで来ています。
松〇一代さんも師走だから離婚を決断したとの事です。

簡単に自己紹介

kintone Café 埼玉の事務局メンバーとして活動してたりします。
kintone Café Japan 2017 でも活動してました。

現在は個人事業主として、kintoneでの業務改善活動の推進や提案、
またkintoneを活用してのCRM、SFAの構築なんかをしてたりします。
あと5日もすると法人になったりします。

前提

これからkintone pluginを作ろうと思ってる人が対象の内容です。

本題

早速ではありますが、先日現場作業していた際にpluginの作成を依頼され、
その際に色々手間取ったので、その時に得られた気づきを今日は共有させて下さい。

注意ポイント(1)

事前にどんな作業が必要になりそうか、把握しておきましょう。
https://developer.cybozu.io/hc/ja/articles/203283794
https://developer.cybozu.io/hc/ja/articles/203302214
https://developer.cybozu.io/hc/ja/articles/203455680

何もわからない状態から始めるとハマリやすいです。
※経験者は語る

注意ポイント(2)

何が必要かわかったら、1度お試しでsampleのプラグインを自分の開発環境などに入れてみましょう。

例えば、
https://github.com/kintone/plugin-sdk
plugin-sdkを落としたらsampleのpluginが入っているので、
試しにpackage.shを叩いて、実際にzipファイルを作ってみる。

ディレクトリ構成や、package.shによって作られるものや必要なものが把握できるので、
まずは試してみるのが良いです。

注意ポイント(3)

jsのファイル名やcssのファイル名などはわかりやすい名前を付けましょう。

manifest.jsonに書くのですが、実際に実装しているとどのjsファイルが
設定画面で動くjsでどのjsが画面で動作するものだっけ?と困ったりします。
(私だけ...?)

注意ポイント(4)

出来るだけテンプレートエンジンを入れて実装することを検討しましょう。

日本語、英語、中国語に対応出来るようになっているので、それらを考慮した作りにしましょう。
(中国語はわからない...)

注意ポイント(5)

確認作業が面倒でもめげない心を持ちましょう。
pluginが出来て、パッケージングをし実際に環境に反映させたけど動かない....

そんな事は良くあります。
(私は100回以上この作業繰り返しました...)

それでもpluginを作って今のkintoneの環境をより良くするんだ!という強い気持ちを持ってpluginを作りましょう。

注意ポイント(6)

設定画面の実装が終わっただけで一息つかないようにしましょう。
設定画面から設定値を取得し実際の画面で動くようになってから一息つきましょう。

注意ポイント(7)

pluginで実装する前に、kintoneの画面にjsを組み込んで動かしておこう。
注意ポイント(6)と似ているのですが、先にkintoneの画面で動く仕組みだけ作っておくと
それをpluginに組み込むだけになるので、圧倒的に楽になります。
(個人の感想)

注意ポイント(8)

作り終わってもゴールだと思わないようにしましょう。
pluginも日々進化なので、自分で入れたい機能を入れながら、
実際に入れて頂いた人にヒアリングなどをし、FBを貰いながらアップデートしていきましょう。

まとめ

多分、1番最初のplugin開発が1番大変だと思います。
2度目、3度目は最初に苦労した知見があるので、そんなに大変な思いはしないはずです。
これを機にplugin開発したいと思ってくれると嬉しいです。

appendix

一緒に業務改善とかを楽しんでやれる人募集中してます。
一緒に業務hackしましょー\(^o^)/