アプリ更新前の変更点を確認したくて、設定画面にチップを追加する「kintone Config Lens」を作りました

以前こちらでOSS Toolkitを紹介した河合です。コメントや改善案をいただき、ありがとうございました!

今回は、kintoneのアプリ設定画面での確認作業を少し楽にしたくて、「kintone Config Lens」を作りました。Toolkitとは別のツールとして、無料・MITライセンスで公開しています。

作ったきっかけ

「アプリを更新する前に、どこを変更したか確認したい」
「ルックアップの参照先や計算式を見るために、毎回フィールド設定を開くのが手間」

そんな確認を、いつもの設定画面の中で済ませられたら、というのが出発点です。

できること

1. 差分チップ
運用中の設定と、保存済みのプレビュー設定を比較します。フォーム項目の追加・変更、選択肢の並び順に加えて、一覧・グラフ・通知・アクセス権など、対応する全16カテゴリをまとめて確認します。タブや設定メニューにも「変更あり」を表示します。

※未保存の編集は比較対象外です。差分確認のために「アプリを更新」する必要はありません。

2. 設定チップ
チップにマウスを重ねると、選択肢や計算式、ルックアップの参照先・キー・コピー先・絞り込みなどを確認できます。ルックアップとコピー先は、同じ色・番号で対応を示します。

3. フィールドコード・要素ID
フォームを見ながらフィールドコードを確認できます。スペース・ラベル・罫線に設定した要素IDも表示します。

作ってみて、見直したこと

最初は概要を大きく表示したり、チップを重ねたりして、かえって標準の設定を開きにくくしてしまいました。

そこで、概要はチップへのホバーで表示し、表示切替を画面右下に常設しました。すべて非表示にすればチップ用の余白もなくなり、標準のフォーム配置を確認できます。設定の編集・保存には、引き続きkintone標準の操作を使います。

また、ページを開いただけでは設定取得APIを呼ばず、「設定を読み込む/再取得」を押したときに取得するようにしています。通常は34回のGETで、取得後のホバーや表示切替では追加取得しません。

開発には生成AIも活用し、検証用アプリで表示や差分の動作を確認しながら調整しました。

試す場合・開発に参加いただける場合

Tampermonkey用のユーザースクリプトで、現在はv0.9.0の公開ベータ版です。PC版のアプリ設定画面と、設定を閲覧できる権限が必要です。

スクリプト自体による設定の書き込み・アプリ更新・外部サーバーへの設定情報送信は行いません。ただし、APIトークンやWebhook、プラグイン内部の設定など、比較できないものもあります。また、標準画面のDOMを利用するため、kintoneの更新で補助表示が動かなくなる可能性があります。対応範囲や導入手順はREADMEにまとめています。

GitHub:ソースコード・導入手順

「設定画面ではここをよく確認する」「この表示は少し邪魔かも」など、実際の使い方からのご意見をいただけると嬉しいです。IssueやPull Requestでの改善も歓迎しています!

※個人で開発している非公式ツールです。利用環境のルールに沿って、まずは検証用アプリでお試しください。

とくに開発者にはめちゃくちゃうれしい機能ですね!!ありがとうございます!