@goqoo/trunks 0.1.0 → 0.3.0

package/README.ja.md

@@ -0,0 +1,214 @@
+# trunks
+
+[![Node.js](https://img.shields.io/badge/Node.js-20+-339933?style=flat&logo=node.js)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+[English](/README.md) | 日本語
+
+[@kintone/dts-gen](https://github.com/kintone/js-sdk/tree/main/packages/dts-gen) のラッパー CLI ツール。設定ファイル1つで複数の kintone アプリの TypeScript 型定義を一括生成します。
+
+## 特徴
+
+- 1コマンドで複数アプリの型定義を生成
+- TypeScript 設定ファイルで型安全な設定（`trunks.config.ts`）
+- 複数の認証方式に対応（パスワード、API トークン、OAuth）
+- Prettier による自動フォーマット（オプション）
+- プレビュー環境・ゲストスペースに対応
+
+## クイックスタート
+
+1. プロジェクトルートに設定ファイル `trunks.config.ts` を作成：
+
+```typescript
+import { defineConfig } from '@goqoo/trunks';
+
+export default defineConfig({
+  host: 'your-subdomain.cybozu.com',
+  apps: {
+    customer: 123,
+    order: 456,
+    product: 789,
+  },
+  auth: { type: 'oauth' },
+});
+```
+
+2. コマンドを実行：
+
+グローバルインストールあり：
+
+```bash
+npm install -g @goqoo/trunks
+trunks
+```
+
+グローバルインストールなし：
+
+```bash
+npx @goqoo/trunks
+```
+
+3. `dts/` ディレクトリに型定義ファイルが生成されます：
+   - `dts/customer-fields.d.ts`
+   - `dts/order-fields.d.ts`
+   - `dts/product-fields.d.ts`
+
+## 設定
+
+### 基本設定
+
+```typescript
+import { defineConfig } from '@goqoo/trunks';
+
+export default defineConfig({
+  // 必須
+  host: 'your-subdomain.cybozu.com',
+  apps: {
+    customer: 123,  // { アプリ名: アプリID }
+    order: 456,
+  },
+  auth: { type: 'oauth' },
+
+  // オプション
+  outDir: 'dts',           // 出力ディレクトリ（デフォルト: "dts"）
+  preview: false,          // プレビュー環境を使用（デフォルト: false）
+  guestSpaceId: 5,         // ゲストスペース ID（該当する場合）
+  namespace: 'kintone.types', // TypeScript の namespace（デフォルト: "kintone.types"）
+  format: true,            // Prettier でフォーマット（デフォルト: false）
+});
+```
+
+### 認証方式
+
+環境変数はプロジェクトルートの `.env` ファイルに設定できます：
+
+```bash
+# .env
+KINTONE_USERNAME=your-username
+KINTONE_PASSWORD=your-password
+KINTONE_API_TOKEN=your-api-token
+```
+
+> **注意**: 設定ファイルに認証情報を直書きする場合は、設定ファイルを `.gitignore` に追加して、バージョン管理に機密情報がコミットされないようにしてください。環境変数（`.env` ファイル）または標準入力の使用を推奨します。
+
+#### パスワード
+
+認証情報は設定ファイル、環境変数 `KINTONE_USERNAME` と `KINTONE_PASSWORD`、または標準入力から取得します（この優先順位）。
+
+```typescript
+auth: { type: 'password' },
+// または直書き（非推奨）
+auth: { type: 'password', username: 'user', password: 'pass' },
+```
+
+#### API トークン
+
+トークンは設定ファイル、環境変数 `KINTONE_API_TOKEN`、または標準入力から取得します（この優先順位）。
+
+```typescript
+auth: { type: 'api-token' },
+// または直書き（非推奨）
+auth: { type: 'api-token', token: 'your-token' },
+```
+
+複数アプリの場合は `.env` でカンマ区切りで指定：
+
+```bash
+KINTONE_API_TOKEN=token1,token2,token3
+```
+
+#### OAuth
+
+[Gyuma](https://github.com/nicecai/gyuma) を使用した OAuth 認証。ブラウザが開いて認証を行います。
+
+```typescript
+auth: {
+  type: 'oauth',
+  scope: 'k:app_settings:read',  // オプション: カスタムスコープ
+},
+```
+
+### その他のオプション
+
+#### Basic 認証
+
+Basic 認証が必要な環境の場合：
+
+```typescript
+basicAuth: {
+  username: 'basic-user',
+  password: 'basic-password',
+},
+```
+
+#### プロキシ
+
+```typescript
+proxy: {
+  host: 'proxy.example.com',
+  port: 8080,
+},
+```
+
+#### クライアント証明書（OAuth 用）
+
+```typescript
+pfx: {
+  filepath: '/path/to/cert.pfx',
+  password: 'certificate-password',
+},
+```
+
+## CLI オプション
+
+```bash
+trunks [options]
+
+Options:
+  -c, --config <path>  設定ファイルのパス（デフォルト: 自動検出）
+  -h, --help           ヘルプを表示
+  -V, --version        バージョンを表示
+```
+
+## 生成される出力
+
+アプリ名 `customer`（ID: 123）の場合、以下のファイルが生成されます：
+
+```typescript
+// dts/customer-fields.d.ts
+declare namespace kintone.types {
+  interface CustomerFields {
+    companyName: kintone.fieldTypes.SingleLineText;
+    email: kintone.fieldTypes.Link;
+    // ...
+  }
+  interface SavedCustomerFields extends CustomerFields {
+    $id: kintone.fieldTypes.Id;
+    $revision: kintone.fieldTypes.Revision;
+    // ...
+  }
+}
+```
+
+## 開発
+
+```bash
+# ビルド
+yarn build
+
+# テスト
+yarn test
+
+# ウォッチモード
+yarn dev
+```
+
+## 関連プロジェクト
+
+- [@kintone/dts-gen](https://github.com/kintone/js-sdk/tree/main/packages/dts-gen) - 型定義生成の本体
+- [Gyuma](https://github.com/nicecai/gyuma) - kintone の OAuth 認証
+- [gotenks](https://github.com/goqoo-on-kintone/gotenks) - kintone TypeScript 型を Go 型に変換
+
+## ライセンス
+
+MIT License - 詳細は [LICENSE](LICENSE) を参照してください。

package/README.md

@@ -0,0 +1,214 @@
+# trunks
+
+[![Node.js](https://img.shields.io/badge/Node.js-20+-339933?style=flat&logo=node.js)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+English | [日本語](/README.ja.md)
+
+A CLI wrapper for [@kintone/dts-gen](https://github.com/kintone/js-sdk/tree/main/packages/dts-gen) that generates TypeScript type definitions for multiple Kintone apps with a single configuration file.
+
+## Features
+
+- Generate type definitions for multiple apps in one command
+- TypeScript configuration file with type safety (`trunks.config.ts`)
+- Multiple authentication methods (Password, API Token, OAuth)
+- Optional Prettier formatting for generated files
+- Support for preview environments and guest spaces
+
+## Quick Start
+
+1. Create a configuration file `trunks.config.ts` in your project root:
+
+```typescript
+import { defineConfig } from '@goqoo/trunks';
+
+export default defineConfig({
+  host: 'your-subdomain.cybozu.com',
+  apps: {
+    customer: 123,
+    order: 456,
+    product: 789,
+  },
+  auth: { type: 'oauth' },
+});
+```
+
+2. Run the command:
+
+With global installation:
+
+```bash
+npm install -g @goqoo/trunks
+trunks
+```
+
+Without global installation:
+
+```bash
+npx @goqoo/trunks
+```
+
+3. Type definition files will be generated in the `dts/` directory:
+   - `dts/customer-fields.d.ts`
+   - `dts/order-fields.d.ts`
+   - `dts/product-fields.d.ts`
+
+## Configuration
+
+### Basic Configuration
+
+```typescript
+import { defineConfig } from '@goqoo/trunks';
+
+export default defineConfig({
+  // Required
+  host: 'your-subdomain.cybozu.com',
+  apps: {
+    customer: 123,  // { appName: appId }
+    order: 456,
+  },
+  auth: { type: 'oauth' },
+
+  // Optional
+  outDir: 'dts',           // Output directory (default: "dts")
+  preview: false,          // Use preview environment (default: false)
+  guestSpaceId: 5,         // Guest space ID (if applicable)
+  namespace: 'kintone.types', // TypeScript namespace (default: "kintone.types")
+  format: true,            // Format with Prettier (default: false)
+});
+```
+
+### Authentication Methods
+
+Environment variables can be set in a `.env` file in your project root:
+
+```bash
+# .env
+KINTONE_USERNAME=your-username
+KINTONE_PASSWORD=your-password
+KINTONE_API_TOKEN=your-api-token
+```
+
+> **Warning**: If you write credentials directly in the config file, make sure to add the config file to `.gitignore` to avoid committing sensitive information to version control. Using environment variables (`.env` file) or stdin prompts is recommended.
+
+#### Password
+
+Credentials are read from the config file, environment variables `KINTONE_USERNAME` and `KINTONE_PASSWORD`, or prompted via stdin (in that order of priority).
+
+```typescript
+auth: { type: 'password' },
+// Or with direct credentials (not recommended)
+auth: { type: 'password', username: 'user', password: 'pass' },
+```
+
+#### API Token
+
+Token is read from the config file, environment variable `KINTONE_API_TOKEN`, or prompted via stdin (in that order of priority).
+
+```typescript
+auth: { type: 'api-token' },
+// Or with direct token (not recommended)
+auth: { type: 'api-token', token: 'your-token' },
+```
+
+For multiple apps, use comma-separated tokens in `.env`:
+
+```bash
+KINTONE_API_TOKEN=token1,token2,token3
+```
+
+#### OAuth
+
+Uses [Gyuma](https://github.com/nicecai/gyuma) for OAuth authentication. A browser window will open for authentication.
+
+```typescript
+auth: {
+  type: 'oauth',
+  scope: 'k:app_settings:read',  // Optional: custom scope
+},
+```
+
+### Additional Options
+
+#### Basic Authentication
+
+For environments that require basic authentication:
+
+```typescript
+basicAuth: {
+  username: 'basic-user',
+  password: 'basic-password',
+},
+```
+
+#### Proxy
+
+```typescript
+proxy: {
+  host: 'proxy.example.com',
+  port: 8080,
+},
+```
+
+#### Client Certificate (for OAuth)
+
+```typescript
+pfx: {
+  filepath: '/path/to/cert.pfx',
+  password: 'certificate-password',
+},
+```
+
+## CLI Options
+
+```bash
+trunks [options]
+
+Options:
+  -c, --config <path>  Path to config file (default: auto-detect)
+  -h, --help           Display help
+  -V, --version        Display version
+```
+
+## Generated Output
+
+For an app named `customer` (ID: 123), the following file is generated:
+
+```typescript
+// dts/customer-fields.d.ts
+declare namespace kintone.types {
+  interface CustomerFields {
+    companyName: kintone.fieldTypes.SingleLineText;
+    email: kintone.fieldTypes.Link;
+    // ...
+  }
+  interface SavedCustomerFields extends CustomerFields {
+    $id: kintone.fieldTypes.Id;
+    $revision: kintone.fieldTypes.Revision;
+    // ...
+  }
+}
+```
+
+## Development
+
+```bash
+# Build
+yarn build
+
+# Test
+yarn test
+
+# Watch mode
+yarn dev
+```
+
+## Related Projects
+
+- [@kintone/dts-gen](https://github.com/kintone/js-sdk/tree/main/packages/dts-gen) - The underlying type definition generator
+- [Gyuma](https://github.com/nicecai/gyuma) - OAuth authentication for Kintone
+- [gotenks](https://github.com/goqoo-on-kintone/gotenks) - Convert kintone TypeScript types to Go types
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.

package/dist/cli.js

@@ -1,13 +1,20 @@
 #!/usr/bin/env node
+import { createRequire } from 'module';
+import { config as loadEnv } from 'dotenv';
 import { Command } from 'commander';
 import chalk from 'chalk';
 import { loadConfig } from './config.js';
 import { generate } from './generate.js';
+// package.jsonからバージョンを取得
+const require = createRequire(import.meta.url);
+const { version } = require('../package.json');
+// .envファイルがあれば環境変数として読み込む
+loadEnv({ quiet: true });
 const program = new Command();
 program
     .name('trunks')
     .description('Generate TypeScript type definitions for multiple Kintone apps')
-    .version('0.1.0');
+    .version(version);
 program
     .command('generate', { isDefault: true })
     .description('Generate type definitions for all configured apps')

package/dist/generate.js

@@ -1,9 +1,32 @@
-import { spawn } from 'child_process';
+import { spawn, spawnSync } from 'child_process';
 import { mkdirSync } from 'fs';
 import * as readline from 'readline';
 import chalk from 'chalk';
 import { kebabCase, pascalCase } from 'change-case';
 import { getOauthToken } from './oauth.js';
+// npx prettierが実行可能かチェック
+function isPrettierAvailable() {
+    const result = spawnSync('npx', ['prettier', '--version'], {
+        stdio: 'pipe',
+        encoding: 'utf-8',
+    });
+    return result.status === 0;
+}
+// Prettierでファイルをフォーマット
+function formatWithPrettier(filePath) {
+    return new Promise((resolve) => {
+        const proc = spawn('npx', ['prettier', '--write', filePath], {
+            cwd: process.cwd(),
+            stdio: 'pipe',
+        });
+        proc.on('close', (code) => {
+            resolve(code === 0);
+        });
+        proc.on('error', () => {
+            resolve(false);
+        });
+    });
+}
 // 標準入力からテキストを取得
 function prompt(question) {
     const rl = readline.createInterface({
@@ -67,9 +90,10 @@ async function buildAuthArgs(config) {
     const args = {};
     switch (config.auth.type) {
         case 'password': {
-            let username = process.env.KINTONE_USERNAME;
-            let password = process.env.KINTONE_PASSWORD;
-            // 環境変数が未設定の場合は標準入力で取得
+            // 設定ファイル → 環境変数 → 標準入力の優先順位
+            let username = config.auth.username ?? process.env.KINTONE_USERNAME;
+            let password = config.auth.password ?? process.env.KINTONE_PASSWORD;
+            // 未設定の場合は標準入力で取得
             if (!username) {
                 username = await prompt('Kintone Username: ');
             }
@@ -93,9 +117,18 @@ async function buildAuthArgs(config) {
             args['oauth-token'] = oauthToken;
             break;
         }
-        case 'api-token':
-            args['api-token'] = config.auth.token;
+        case 'api-token': {
+            // 設定ファイル → 環境変数 → 標準入力の優先順位
+            let token = config.auth.token ?? process.env.KINTONE_API_TOKEN;
+            if (!token) {
+                token = await promptPassword('Kintone API Token: ');
+            }
+            if (!token) {
+                throw new Error('API token is required for api-token auth');
+            }
+            args['api-token'] = token;
             break;
+        }
     }
     // Basic認証
     if (config.basicAuth) {
@@ -186,12 +219,18 @@ export async function generate(config) {
     mkdirSync(outDir, { recursive: true });
     const authArgs = await buildAuthArgs(config);
     const apps = Object.entries(config.apps);
+    // format: trueの場合のみPrettierを使用
+    const usePrettier = config.format === true && isPrettierAvailable();
     console.info(chalk.cyan(`Generating type definitions for ${apps.length} app(s)...`));
     // 順次実行（並列だとコンソール出力が混在する）
     const results = [];
     for (const [appName, appId] of apps) {
         const result = await generateForApp(appName, appId, config, authArgs, outDir);
         results.push(result);
+        // 成功したファイルをPrettierでフォーマット
+        if (result.success && usePrettier) {
+            await formatWithPrettier(result.output);
+        }
     }
     const successCount = results.filter((r) => r.success).length;
     const failCount = results.length - successCount;

package/dist/types.d.ts

@@ -1,5 +1,7 @@
 export type PasswordAuth = {
     type: 'password';
+    username?: string;
+    password?: string;
 };
 export type OAuthAuth = {
     type: 'oauth';
@@ -7,7 +9,7 @@ export type OAuthAuth = {
 };
 export type ApiTokenAuth = {
     type: 'api-token';
-    token: string;
+    token?: string;
 };
 export type Auth = PasswordAuth | OAuthAuth | ApiTokenAuth;
 export type ProxyConfig = {
@@ -37,5 +39,6 @@ export type Config = {
     preview?: boolean;
     guestSpaceId?: number;
     namespace?: string;
+    format?: boolean;
 };
 export declare const defineConfig: (config: Config) => Config;

package/package.json

@@ -1,9 +1,20 @@
 {
   "name": "@goqoo/trunks",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "A CLI wrapper for @kintone/dts-gen that generates type definitions for multiple Kintone apps",
   "type": "module",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
   "bin": {
     "trunks": "dist/cli.js"
   },
@@ -37,6 +48,7 @@
     "chalk": "^5.4.0",
     "change-case": "^5.4.0",
     "commander": "^13.0.0",
+    "dotenv": "^17.3.1",
     "gyuma": "^0.6.1",
     "jiti": "^2.4.0"
   }

package/.claude/settings.local.json

@@ -1,7 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(yarn test)"
-    ]
-  }
-}

package/.prettierignore

@@ -1 +0,0 @@
-*.md

package/.prettierrc.js

@@ -1,5 +0,0 @@
-module.exports = {
-  singleQuote: true,
-  printWidth: 120,
-  quoteProps: 'consistent',
-}

package/CLAUDE.md

@@ -1,71 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## プロジェクト概要
-
-@goqoo/trunks - `@kintone/dts-gen`のラッパーCLIツール。
-
-### 背景・目的
-
-`@kintone/dts-gen`は優れた型定義ファイルを生成するが、CLIとしての使い勝手に課題がある（特に複数アプリの一括生成ができない）。このツールは設定ファイルベースで複数アプリの型定義を一括生成する。
-
-### 参考実装
-
-[goqoo/src/generator/dts/index.ts](https://github.com/goqoo-on-kintone/goqoo/blob/main/src/generator/dts/index.ts) の機能を単独抽出したもの。
-
-goqooでの処理フロー:
-1. 設定ファイルから対象環境を特定
-2. OAuth or ユーザー名/パスワード認証を設定
-3. `appId`オブジェクトをループして各アプリに対し`npx kintone-dts-gen`を実行
-4. 出力ファイル名はkebab-case、型名はPascalCaseで自動生成
-
-### 設定ファイル構造
-
-```typescript
-type Config = {
-  host: string                      // Kintone環境のホスト（例: "example.cybozu.com"）
-  apps: Record<string, number>      // { appName: appId }
-  auth:
-    | { type: 'password' }                           // 環境変数 KINTONE_USERNAME, KINTONE_PASSWORD
-    | { type: 'oauth'; scope?: string }              // OAuth認証
-    | { type: 'api-token'; token: string }           // APIトークン
-  proxy?: { host: string; port: number }             // プロキシ設定（任意）
-  basicAuth?: { username: string; password: string } // Basic認証（任意）
-}
-```
-
-## 開発コマンド
-
-```bash
-yarn install             # パッケージインストール
-yarn build               # TypeScriptビルド
-yarn dev                 # ウォッチモードでビルド
-yarn test                # テスト実行（Jest + ESM）
-yarn test:watch          # ウォッチモードでテスト
-yarn prettier --write .  # コードフォーマット
-```
-
-## ソース構造
-
-```
-src/
-├── cli.ts       # CLIエントリーポイント（Commander.js）
-├── config.ts    # 設定ファイル読み込み（jiti使用）
-├── generate.ts  # dts-gen実行処理
-├── index.ts     # エクスポート
-└── types.ts     # 型定義・defineConfig
-
-test/
-├── config.test.ts   # configのテスト
-├── generate.test.ts # generateのテスト
-└── types.test.ts    # typesのテスト
-```
-
-## 技術スタック
-
-- **ランタイム:** Node.js >= 20
-- **パッケージマネージャー:** Yarn
-- **主要依存:** @kintone/dts-gen, Commander.js, jiti, change-case, chalk
-- **テスト:** Jest + ts-jest（ESMモード）
-- **フォーマッタ:** Prettier（シングルクォート、120文字/行）