Cybozuがkintoneアプリのカスタマイズ開発者向けに提供しているcustomize-uploaderを簡単に使えるようにしたスクリプトを作成しました。
普段、kintoneアプリのカスタマイズ開発をする中で、開発環境のアプリと本番環境アプリの2つを用意して、通常業務に影響が出ないようにカスタマイズ開発を進めています。このような使い方でkintoneアプリを使っている方はほとんどいないと思いますが、普段の業務で必要があったのでスクリプトを作りました。
カスマイズファイルをgitで管理して、開発環境で動作確認をしながら本番環境に反映させることを想定しています。
Githubのソースコードはこちらから
kintone-customize-uploader
customize-uploaderについての詳しい情報はこちらから
customize-uploaderでカスタマイズ用のJS/CSSファイルをコマンドラインからアップロードしよう！
使い方
基本的な使い方はcustomize-uploaderと同じです。
-
プロジェクトを任意の場所にcloneもしくはダウンロードして展開します。
-
destディレクトリ直下にあるcustomize-manifest-dev.jsonに開発環境のアプリIDを、customize-manifest-prd.jsonに本番環境のアプリIDを入力します。
{
"app": "{アプリID}",
"scope": "ALL",
...
}
3. customize-uploaderと同様に、kintoneアプリにアップロードするJavaScriptとCSSファイルを開発環境と本番環境の両方のマニフェストに追記します。
4. 以下のコマンドを使うことで開発環境と本番環境へのアップロードを簡単に行うことができます。
コマンド
npm runの後に以下のスクリプト名を入れて実行すると、customize-uploaderの各スクリプトを実行できます。
| scripts | 実行内容 |
|---|---|
install |
customize-uploaderをインストールします。 |
init |
マニフェストファイルを作成します。 |
import-dev |
開発環境のアプリのカスタマイズ情報を取得します。 |
import-prd |
本番環境のアプリのカスタマイズ情報を取得します。 |
dev |
作成したカスタマイズファイルを開発環境のアプリにアップロードします。 |
prd |
作成したカスタマイズファイルを本番環境のアプリにアップロードします。 |
dev-watch |
ファイルの更新を監視して、開発環境のアプリに都度アップロードします。 |
prd-watch |
ファイルの更新を監視して、本番環境のアプリに都度アップロードします。 |
例えば、開発環境のアプリにカスタマイズファイルをアップロードする場合は、
$ npm run dev
と入力します。
※import-dev, import-prdコマンドはcustomize-uploaderの仕様上、新しいマニフェストファイルが生成されてしまいます。
短時間で作成したので間違いなどありましたらご指摘ください！