@zygapp/kintone-customizer-cli v0.2.2

kintoneカスタマイズCLIツール

このCLIツールは、kintoneのカスタマイズを簡単かつ効率的に開発するためのものです！

🎯 特徴

• リアルタイム開発: ローカル環境で変更が即座にkintoneに反映されます。
• 柔軟なビルド: Viteの高速ビルドを活用。
• 簡単なデプロイ: コマンド1発で本番環境に反映。
• プラグイン対応: Viteプラグインを手軽に追加できます。

🔧 コマンド一覧

kintone-customizer <command>

🛠️ 機能

1. Viteプラグインを簡単追加

プロジェクトルートにあるvite.plugins.jsにプラグインを追加するだけで、カスタマイズできます。

例：

// vite.plugins.js
import vue from '@vitejs/plugin-vue';

export default [
  vue(),
];

2. ReactやVueにも対応

ReactやVueなどのフレームワークを組み合わせて柔軟に開発可能！

🚀 始め方

1. インストール

   npm install -g @zygapp/kintone-customizer-cli

2. プロジェクトを初期化 各種ファイルが生成されます。

   create-kintone-customizer <ディレクトリ名|kintone-customizer>

3. 設定ファイル修正 ./config.jsonの各項目を書き換えます。

   {
     "app": "<APP ID>",
     "name": "app",
     "mainJsPath": "src/main.js",
     "desktop": true,
     "mobile": true,
     "scope": "<ALL|ADMIN|NONE>",
     "baseUrl": "https://<KINTONE SUBDOMAIN>.cybozu.com",
     "auth": {
       "username": "<KINTONE USERNAME>",
       "password": "<KINTONE PASSWORD>"
     }
   }

   プロパティ	型	必須	説明
   app	String|Number	✅️	kintoneアプリID
   name	String	✅️	出力されるファイル名を設定します。※ 半角英数字
   mainJsPath	String	✅️	ビルド対象のJSファイルのパスを指定します。
   desktop	Boolean|Array	✅️	デスクトップ用カスタマイズの設定true/false: デスクトップ用としてアップロードするか否かArray: プロジェクト内のアップロードしたいディレクトリパスを配列で指定します。※1
   mobile	Boolean|Array	✅️	モバイル用カスタマイズの設定true/false: モバイル用としてアップロードするか否かArray: プロジェクト内のアップロードしたいディレクトリパスを配列で指定します。※1
   scope	String(enum)	✅️	カスタマイズの適用範囲ALL：すべてのユーザーの場合ADMIN：アプリの管理者だけの場合NONE：適用しない場合
   baseUrl	String	✅️	デプロイ対象のkintone環境URL
   auth	Object	✅️	認証情報
   auth.username	String	🔼	【条件必須】アプリ設定権限をもつkintoneユーザーのアカウントIDauth.apiKeyを設定する場合は必須
   auth.password	String	🔼	【条件必須】アプリ設定権限をもつkintoneユーザーのパスワードauth.apiKeyを設定する場合は必須
   auth.apiKey	String	🔼	【条件必須】アプリ設定権限をもつアプリのAPIキーauth.usernameおよびauth.passwordを設定する場合は必須

   ※1 入力例:

   {
     "desktop": [
       "path/to/script.js",
       "path/to/style.css"
     ]
   }

4. ローカル環境で開発

   # npm
   npm run kintone-customizer --dev
   or
   npm run dev
   
   #yarn
   yarn kintone-customizer --dev
   or
   yarn dev

5. ローカル環境でビルドし、逐次デプロイ

   # npm
   npm run kintone-customizer --dev --deploy
   or
   npm run dev:deploy
   
   #yarn
   yarn kintone-customizer --dev --deploy
   or
   yarn dev:deploy

6. ローカル環境でビルド

   # npm
   npm run kintone-customizer --build
   or
   npm run build
   
   #yarn
   yarn kintone-customizer --build
   or
   yarn build

7. 本番環境にデプロイ

   # npm
   npm run kintone-customizer --deploy
   or
   npm run deploy
   
   #yarn
   yarn kintone-customizer --deploy
   or
   yarn deploy

8. ローカル環境でビルドし、本番環境にデプロイ

   # npm
   npm run kintone-customizer --build --deploy
   or
   npm run build:deploy
   
   #yarn
   yarn kintone-customizer --build --deploy
   or
   yarn build:deploy

📝 ライセンス

このプロジェクトはMITライセンスのもとで提供されています。

👨‍💻 開発者情報

加藤@合同会社ZYG https://www.zyg.jp