Featured Image(Photo) by Sai Kiran Anagani on Unsplash
更新履歴
- 2021/6/28 cli-kintoneがkintone-labsに移動し、data-loaderが作られていたことを追加しました。
- 2020/10/18 「ツールの考え方」を追加しました。
はじめに
kintoneをカスタマイズするにあたってdeveloper networkなどを参考にしましたが、GitHubにしかないツールがあったりして、正直どれを使えばよいのか迷いました。今後開発を始める人が迷わないように勝手にまとめました。
推測で書いている部分も多いので、よくリンク先を確認してください。間違っているところがあればご指摘ください。
非公式ツールもまとめているので是非御覧ください。
potara.netツールの考え方
最近GitHubの構成が大きく変わっているようです。
github.com/kintoneとgithub.com/kintone-labsに分けられています。おそらくどちらもサイボウズさんのアカウントですが、利用を推奨しているのがgithub.com/kintone、まだ推奨できないものがgithub.com/kintone-labsのようです。
このページでは両方を紹介しますが、βとkintone-labsには注釈を入れています。利用する場合は注意してください。
開発環境
サクッと書きたい人はJSEdit for kintoneというプラグインがおすすめです。じっくり書きたい人はVisual Studio Codeが良いと思います。developer networkにもVisual Studio Codeを前提にした記事がいくつかあります。
kintoneはカスタマイズの適用が面倒なのですがこちらの記事も参考になりました。
Visual Studio Code Live Server Extensionを使ってkintoneカスタマイズ開発効率をあげよう！
他にもcustomize uploaderというツールもあります。
customize-uploaderでカスタマイズ用のJS/CSSファイルをコマンドラインからアップロードしよう！
こちらのブログにも開発環境構築の手順をまとめているので是非御覧ください。
REST API系
JavaScript/Node.jsライブラリ
kintoneのカスタマイズ言語がJavaScriptだからか更新頻度高いです。
kintone Utility Library for JavaScript、kintone API SDK(β) for Node.js、kintone JS SDKは非推奨です。@kintone/rest-api-clientを使いましょう。
- kintone Utility Library for JavaScript（非推奨）
- kintone API SDK(β) for Node.js（非推奨）
- kintone JS SDK（非推奨）
- @kintone/rest-api-client
Javaライブラリ
その他言語のライブラリ
kintone iOS SDKは非推奨ですが後継のツールはなさそうです。go-kintoneは他のライブラリと扱いが違いそうです。命名規則も違いますしdeveloper networkにも記事がありません。（たぶん）
- kintone iOS SDK（非推奨）
- go-kintone（kintone-labs）
UI
vue-kintone-componentはREADMEも記事もないので、まだ試していません。特別な理由がない限りはkintone UI Componentが良さそうです。
- 51-modern-default.css
- kintone UI component（kintone-labs）
- vue-kintone-component（kintone-labs）
プラグイン
プラグイン開発者には必須です。
- @kintone/create-plugin
- @kintone/plugin-packer
- @kintone/plugin-uploader
- @kintone/webpack-plugin-kintone-plugin
- @kintone/plugin-manifest-validator
plugin-packer内で利用しているので、これだけを利用する機会はなさそうです。
いろいろリンク貼りましたがプラグイン開発支援ツール群の案内にまとめられています。
インポート/エクスポート
cli-kintoneはアプリのレコードをエクスポート、インポートできるコマンドラインツールです。添付ファイルにも対応しています。タスクスケジューラーを使って定期的に実行もできます。素晴らしい！のですが、いつの間にかkintone-labsに移動し、data-loaderが作られていました。cli-kintoneもそのうち非推奨になるのでしょうか…
- cli-kintone（kintone-labs）
- @kintone/data-loader
開発補助
フォーマッター
jswatchdogはかなり古い書き方にしか対応していないので利用する機会はなさそうです。@cybozu/eslint-configはサイボウズさん推奨のESLintルール集です。愛用してます。
- jswatchdog（kintone-labs）
- @cybozu/eslint-config
TypeScript用型生成ツール
kintoneアプリのフィールド情報からTypeScript用の型情報を生成します。具体的にはこのようなことが可能になります。すごく便利です。
フォーム情報取得するツール
- config-helper（kintone-labs）
フィールドのラベル、コード、タイプのみが必要な場合は便利かもしれません。制限事項はこちらです。最初の頃はよく使っていたのですが、機能が足りないことが多く今は使わなくなりました。ルックアップフィールドが取得できないこと、別アプリのフォーム情報が取得できないこと、レコード番号など一部のフィールドはフォームに配置しないと取得できないこと、が辛かったです。
現在は@kintone/rest-api-clientでアプリのフォーム設定が取得できます。余計にconfig-helperの出番は少なそうです。
その他
以降のツールは使えてないので使って一言ぐらいはコメント添えられるようにできれば…