create-pluginを使ってプラグインの雛形を作成しよう！

Index

はじめに

kintoneのプラグイン開発をもっと簡単にできるようにしたプラグイン開発支援ツール群を公開しました。

今回はその中のcreate-pluginについて説明します。

※その他のツールについてはこちら。

create-pluginとは

対話形式でkintoneプラグインの雛形を作成することができるCLIツールです。

npmに対応しているため、Windows/macOS/Linuxどの環境でも簡単に実行することができます。

ソースコードはGitHubに公開しています。

※ こちらのツールの利用に必要な Node.js のバージョンは、リポジトリの package.json にある enginesプロパティをご参照ください。
例：次の記載の場合、Node.js のバージョンは 10 以上が必要です。

"engines": {
 "node": ">=10"
 },

インストール方法

create-pluginをインストールします。

※ ここでは、npmによるグローバルインストールを例にあげます。

こちらのコマンドを実行することで、create-pluginをインストールすることができます。

基本の使い方

dir_name に作成したいディレクトリ名を入力すると、自動でディレクトリが作成されます。

本記事では、sampleというディレクトリ名で雛形を作ります。

sampleディレクトリが生成され、
その中にプラグインの雛形となるsrcディレクトリ/ファイルが生成されています。

※ package-lock.jsonはnpm5以上で実行すると生成されるファイルです。

詳細

雛形の詳細

生成される雛形 (srcディレクトリ) は以下のような構成になっています。それぞれのファイルの詳細はこちらの記事をご覧ください。

生成されたプラグインの内容

生成された雛形にはレコード一覧画面の上部に任意の文字を表示する処理が書かれています。
表示させる文字はプラグインの設定画面で入力できます。

プラグイン設定画面

オプション機能

このcreate-pluginには雛形を作成する以外にも便利な機能が搭載されています。

ESLintを利用したソースコードチェック

ESLintを使ってJavaScriptのソースコードをチェックすることができます。

自動パッケージング & 自動アップロード

作成したプラグインディレクトリに対して、下記のコマンドを実行することでプラグインzipファイルを作成します。

また、create-plugin実行時に「@kintone/plugin-uploaderを使う」を選んだ場合、
そのままplugin-uploaderが実行されます。

※plugin-uploaderを利用するためには kintoneの管理者権限を持ったユーザー で実行する必要があります。

その後監視モードになるため、そのまま実行した状態でソースコードを修正すると
パッケージングとアップロードが実行されてkintoneへ適用されるようになります。

※ 監視を中止する場合は、「ctrl + c」でコマンドをキャンセルしてください。

おわりに

このツール1つでプラグインの雛形作成からエラーチェック、パッケージング、アップロードを全てを行うことができます。

これからプラグイン開発を始めたいという方はぜひご活用ください。

注意事項

ソースコードの変更および再配布、商用利用等はライセンスに従ってご利用可能です。