@kintone/customize-uploader のサンプル

sample-kintone-customize-uploader.md

kintone-customize-uploader

次のようなディレクトリの構成を前提とします

 +- src/index.js <-- アップロード対象のJS
 +- conf/secret.json <-- ログインに必要な情報を管理
 +- customize-manifest.json <-- アップロードに必要な情報を入れる
 +- package.json <-- npm の設定ファイル

準備

1. kintone-customize-uploaderの実行には node.jsが必要です。node.jsのページからダウンロードしてくる
2. cmd.exeを立ち上げて node --version を実行してインストールされていることを確認
3. プログラムを書いているディレクトリに移動する

node,npmとは?

node.jsはJavaScriptをコマンドラインで実行するためのプログラムです。npmはNode Package Managerの略で、プログラム開発を 行うために必要なライブラリや便利なツールを管理する仕組みです。

package.jsonを作成する

package.jsonとはプログラム開発に利用するライブラリやツールを管理する設定ファイルです。

{
  "name": "<案件名などのプロジェクト名>",
  "version": "<Version>",
  "description": "<プロジェクトの補足的な説明>",
  "scripts": {
    "test": "test" 
  },
  "devDependencies": {
    "@kintone/customize-uploader": "^1.1.0"
  }
}

devDependencies に kintone-customize-uploader を設定します。

コマンドプロンプトで次のコマンドを実行すると、自動でkintone-customize-uploaderがダウンロードされます。

npm install

kintone-customize-uploaderは、node_modules下に配置されます。

customize-manifest.json の設定

{
    "app": "<APP_ID>",
    "scope": "<ALL|ADMIN|NONE>",
    "desktop": {
        "js": [
            // 通常画面のカスタマイズで利用するjsの一覧
            "src/index.js"
        ],
        "css": [
        ]
    },
    "mobile": {
        "js": [
            // モバイル画面のカスタマイズで利用するjsの一覧
        ]
    }
}

認証情報の設定

認証情報を設定ファイルに書き込みます。このファイルが他人に知られてしまうとなりすましのログインができてしまうので、アップロードしないように気を付けてください。次のファイルを conf/secret.json として保存します。

{
    "domain": "<アップロード対象のドメイン名>.cybozu.com",
    "username" : "<ユーザー名>",
    "password" : "<パスワード>"
}

Powershell,バッチファイルを配置する

認証情報を読み取ってkintone-customize-uploaderのツールを実行するスクリプトを実行します。 upload.ps1という名前で保存してください。

なおkintone-customize-uploaderにはコマンドラインオプションがいくつか用意されているので、マニュアル を参照して、必要におうじて編集してください

$confPath = Join-Path (Get-Location) conf\secret.json 
$secretJson = Get-Content $confPath -Encoding UTF8 -Raw | ConvertFrom-Json

node .\node_modules\@kintone\customize-uploader\bin\cli.js `
    customize-manifest.json `
    --domain $secretJson.domain `
    --username $secretJson.username `
    --password $secretJson.password

Powershellを実行するバッチファイルです。これをダブルクリックするとJSをアップロードできます。 upload.bat という名前で保存してください。

powershell  -ExecutionPolicy RemoteSigned -File .\upload.ps1

upload.bat をダブルクリックで実行するか、コマンドプロンプトから実行するとアップロードが行えます。