backlog-exporter 0.0.6 → 0.1.0

package/dist/commands/update/index.d.ts

@@ -0,0 +1,23 @@
+import { Command } from '@oclif/core';
+export default class Update extends Command {
+    static args: {
+        directory: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        apiKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        domain: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        issuesOnly: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+        projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        wikisOnly: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private confirmUpdate;
+    private determineUpdateTargets;
+    private findAndUpdateSettings;
+    private updateDirectory;
+    private updateIssues;
+    private updateWikis;
+}

package/dist/commands/update/index.js

@@ -0,0 +1,237 @@
+import { Args, Command, Flags } from '@oclif/core';
+import * as dotenv from 'dotenv';
+import { access, readdir } from 'node:fs/promises';
+import { join } from 'node:path';
+import { downloadIssues, downloadWikis } from '../../utils/backlog-api.js';
+import { validateAndGetProjectId } from '../../utils/backlog.js';
+import { createOutputDirectory, getApiKey } from '../../utils/common.js';
+import { FolderType, getSettingsFilePath, loadSettings, updateSettings } from '../../utils/settings.js';
+// .envファイルを読み込む
+dotenv.config();
+export default class Update extends Command {
+    static args = {
+        directory: Args.string({
+            description: '更新対象のディレクトリ（設定ファイルが保存されている場所）',
+            required: false,
+        }),
+    };
+    static description = 'Backlogから最新データを取得して更新する';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>
+カレントディレクトリの設定を使用して更新する
+`,
+        `<%= config.bin %> <%= command.id %> --force
+確認プロンプトをスキップする
+`,
+        `<%= config.bin %> <%= command.id %> --apiKey YOUR_API_KEY --domain example.backlog.jp --projectIdOrKey PROJECT_KEY
+指定したパラメータで更新する（設定ファイルが存在する場合は上書きされます）
+`,
+        `<%= config.bin %> <%= command.id %> ./my-project
+指定したディレクトリの設定を使用して更新する
+`,
+    ];
+    static flags = {
+        apiKey: Flags.string({
+            description: 'Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)',
+            required: false,
+        }),
+        domain: Flags.string({
+            description: 'Backlog domain (e.g. example.backlog.jp)',
+            required: false,
+        }),
+        force: Flags.boolean({
+            char: 'f',
+            description: '確認プロンプトをスキップする',
+            required: false,
+        }),
+        issuesOnly: Flags.boolean({
+            description: '課題のみを更新する',
+            required: false,
+        }),
+        projectIdOrKey: Flags.string({
+            description: 'Backlog project ID or key',
+            required: false,
+        }),
+        wikisOnly: Flags.boolean({
+            description: 'Wikiのみを更新する',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Update);
+        // 更新対象のディレクトリを決定（指定がなければカレントディレクトリ）
+        const targetDir = args.directory || process.cwd();
+        try {
+            // 設定ファイルを探索して更新を実行
+            await this.findAndUpdateSettings(targetDir, flags);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            this.error(`更新に失敗しました: ${errorMessage}`);
+        }
+    }
+    // 確認プロンプトの表示
+    async confirmUpdate(options) {
+        if (options.force)
+            return true;
+        this.log(`以下の設定で更新を実行します:`);
+        this.log(`- ディレクトリ: ${options.targetDir}`);
+        this.log(`- ドメイン: ${options.domain}`);
+        this.log(`- プロジェクト: ${options.projectIdOrKey}`);
+        if (options.folderType) {
+            this.log(`- フォルダタイプ: ${options.folderType}`);
+        }
+        this.log(`- 更新対象: ${options.updateIssues ? '課題' : ''}${options.updateIssues && options.updateWikis ? 'と' : ''}${options.updateWikis ? 'Wiki' : ''}`);
+        // 確認プロンプトを表示
+        this.log('更新を実行しますか？ (y/n)');
+        process.stdin.resume();
+        process.stdin.setEncoding('utf8');
+        const response = await new Promise((resolve) => {
+            process.stdin.once('data', (data) => {
+                const input = data.toString().trim().toLowerCase();
+                resolve(input === 'y' || input === 'yes');
+                process.stdin.pause();
+            });
+        });
+        if (!response) {
+            this.log('更新をキャンセルしました');
+        }
+        return response;
+    }
+    // 更新対象の決定
+    determineUpdateTargets(folderType, issuesOnly, wikisOnly) {
+        let updateIssues = !wikisOnly;
+        let updateWikis = !issuesOnly;
+        // フォルダタイプがISSUEの場合は課題のみ更新
+        if (folderType === FolderType.ISSUE) {
+            updateIssues = true;
+            updateWikis = false;
+        }
+        // フォルダタイプがWIKIの場合はWikiのみ更新
+        else if (folderType === FolderType.WIKI) {
+            updateIssues = false;
+            updateWikis = true;
+        }
+        return { updateIssues, updateWikis };
+    }
+    // 設定ファイルを探索して更新を実行
+    async findAndUpdateSettings(targetDir, flags) {
+        // 現在のディレクトリに設定ファイルがあるか確認
+        const settingsPath = getSettingsFilePath(targetDir);
+        let hasSettings = false;
+        try {
+            await access(settingsPath);
+            hasSettings = true;
+        }
+        catch {
+            // 設定ファイルが存在しない場合は何もしない
+        }
+        if (hasSettings) {
+            // 設定ファイルが存在する場合は更新を実行
+            await this.updateDirectory(targetDir, flags);
+        }
+        // サブディレクトリを探索
+        try {
+            const entries = await readdir(targetDir, { withFileTypes: true });
+            for (const entry of entries) {
+                if (entry.isDirectory()) {
+                    const subDir = join(targetDir, entry.name);
+                    // eslint-disable-next-line no-await-in-loop
+                    await this.findAndUpdateSettings(subDir, flags);
+                }
+            }
+        }
+        catch {
+            this.warn(`ディレクトリの読み取りに失敗しました: ${targetDir}`);
+        }
+    }
+    // 指定されたディレクトリの更新を実行
+    async updateDirectory(targetDir, flags) {
+        // 設定ファイルを読み込む
+        const settings = await loadSettings(targetDir);
+        // コマンドライン引数と設定ファイルを組み合わせて使用する値を決定
+        const apiKey = flags.apiKey || settings.apiKey || getApiKey(this);
+        const domain = flags.domain || settings.domain;
+        const projectIdOrKey = flags.projectIdOrKey || settings.projectIdOrKey;
+        const { folderType } = settings;
+        const { force, issuesOnly, wikisOnly } = flags;
+        // 必須パラメータの検証
+        if (!domain) {
+            this.warn(`${targetDir}: ドメインが指定されていません。スキップします。`);
+            return;
+        }
+        if (!projectIdOrKey) {
+            this.warn(`${targetDir}: プロジェクトIDまたはキーが指定されていません。スキップします。`);
+            return;
+        }
+        // 更新対象の決定
+        const { updateIssues, updateWikis } = this.determineUpdateTargets(folderType, issuesOnly, wikisOnly);
+        // 更新前の確認
+        const confirmed = await this.confirmUpdate({
+            domain,
+            folderType,
+            force: force || false,
+            projectIdOrKey,
+            targetDir,
+            updateIssues,
+            updateWikis,
+        });
+        if (!confirmed)
+            return;
+        // 出力ディレクトリの作成
+        await createOutputDirectory(targetDir);
+        // プロジェクトキーからプロジェクトIDを取得
+        const projectId = await validateAndGetProjectId(domain, projectIdOrKey, apiKey);
+        this.log(`プロジェクトID: ${projectId} を使用します`);
+        // 課題の更新
+        if (updateIssues) {
+            await this.updateIssues({
+                apiKey,
+                domain,
+                projectId,
+                projectIdOrKey,
+                targetDir,
+            });
+        }
+        // Wikiの更新
+        if (updateWikis) {
+            await this.updateWikis({
+                apiKey,
+                domain,
+                projectIdOrKey,
+                targetDir,
+            });
+        }
+        this.log(`${targetDir} の更新が完了しました！`);
+    }
+    // 課題の更新
+    async updateIssues(options) {
+        this.log('課題の更新を開始します...');
+        await downloadIssues(this, options.domain, options.projectId, options.apiKey, options.targetDir, 100);
+        // 設定ファイルを更新
+        await updateSettings(options.targetDir, {
+            apiKey: options.apiKey,
+            domain: options.domain,
+            folderType: FolderType.ISSUE,
+            lastUpdated: new Date().toISOString(),
+            outputDir: options.targetDir,
+            projectIdOrKey: options.projectIdOrKey,
+        });
+        this.log('課題の更新が完了しました');
+    }
+    // Wikiの更新
+    async updateWikis(options) {
+        this.log('Wikiの更新を開始します...');
+        await downloadWikis(this, options.domain, options.projectIdOrKey, options.apiKey, options.targetDir);
+        // 設定ファイルを更新
+        await updateSettings(options.targetDir, {
+            apiKey: options.apiKey,
+            domain: options.domain,
+            folderType: FolderType.WIKI,
+            lastUpdated: new Date().toISOString(),
+            outputDir: options.targetDir,
+            projectIdOrKey: options.projectIdOrKey,
+        });
+        this.log('Wikiの更新が完了しました');
+    }
+}

package/dist/commands/wiki/index.d.ts

@@ -1,14 +1,11 @@
 import { Command } from '@oclif/core';
-export default class DownloadWiki extends Command {
-    static args: {
-        url: import("@oclif/core/interfaces").Arg<string | undefined, Record<string, unknown>>;
-    };
+export default class Wiki extends Command {
     static description: string;
     static examples: string[];
     static flags: {
         apiKey: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         domain: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        output: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
     };
     run(): Promise<void>;

package/dist/commands/wiki/index.js

@@ -1,17 +1,18 @@
-import { Args, Command, Flags } from '@oclif/core';
+import { Command, Flags } from '@oclif/core';
 import * as dotenv from 'dotenv';
 import { downloadWikis } from '../../utils/backlog-api.js';
 import { createOutputDirectory, getApiKey } from '../../utils/common.js';
+import { FolderType, updateSettings } from '../../utils/settings.js';
 // .envファイルを読み込む
 dotenv.config();
-export default class DownloadWiki extends Command {
-    static args = {
-        url: Args.string({ description: 'URL to download from', required: false }),
-    };
-    static description = 'BacklogからWikiコンテンツをダウンロードする';
+export default class Wiki extends Command {
+    static description = 'Backlogから Wiki を取得してMarkdownファイルとして保存する';
     static examples = [
-        `<%= config.bin %> <%= command.id %> --domain cm1.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./wiki-data
-BacklogからAPIキーを使用してWikiコンテンツをダウンロードする
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY
+Wikiをダウンロードする
+`,
+        `<%= config.bin %> <%= command.id %> --domain example.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./my-project
+指定したディレクトリにWikiを保存する
 `,
     ];
     static flags = {
@@ -19,24 +20,44 @@ BacklogからAPIキーを使用してWikiコンテンツをダウンロードす
             description: 'Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)',
             required: false,
         }),
-        domain: Flags.string({ description: 'Backlog domain (e.g. example.backlog.jp)', required: true }),
-        output: Flags.string({ char: 'o', default: './backlog-wiki', description: '出力ディレクトリパス', required: false }),
-        projectIdOrKey: Flags.string({ description: 'Backlog project ID or key', required: true }),
+        domain: Flags.string({
+            description: 'Backlog domain (e.g. example.backlog.jp)',
+            required: true,
+        }),
+        output: Flags.string({
+            char: 'o',
+            description: '出力ディレクトリパス',
+            required: false,
+        }),
+        projectIdOrKey: Flags.string({
+            description: 'Backlog project ID or key',
+            required: true,
+        }),
     };
     async run() {
-        const { flags } = await this.parse(DownloadWiki);
-        const { domain, output: outputDir, projectIdOrKey } = flags;
-        const apiKey = getApiKey(this, flags.apiKey);
-        this.log(`Backlogから ${domain} のプロジェクト ${projectIdOrKey} のWikiを取得しています...`);
+        const { flags } = await this.parse(Wiki);
         try {
+            const { domain, projectIdOrKey } = flags;
+            const apiKey = flags.apiKey || getApiKey(this);
+            const outputDir = flags.output || './wiki';
             // 出力ディレクトリの作成
             await createOutputDirectory(outputDir);
-            // Wikiのダウンロード
+            // Wikiの取得と保存
             await downloadWikis(this, domain, projectIdOrKey, apiKey, outputDir);
-            this.log('ダウンロードが完了しました！');
+            // 設定ファイルを保存
+            await updateSettings(outputDir, {
+                apiKey,
+                domain,
+                folderType: FolderType.WIKI,
+                lastUpdated: new Date().toISOString(),
+                outputDir,
+                projectIdOrKey,
+            });
+            this.log('Wikiの取得が完了しました！');
         }
         catch (error) {
-            this.error(`ダウンロードに失敗しました: ${error instanceof Error ? error.message : String(error)}`);
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            this.error(`Wikiの取得に失敗しました: ${errorMessage}`);
         }
     }
 }

package/dist/utils/settings.d.ts

@@ -0,0 +1,42 @@
+/**
+ * フォルダタイプの定義
+ */
+export declare enum FolderType {
+    ISSUE = "issue",
+    WIKI = "wiki"
+}
+/**
+ * 設定ファイルの型定義
+ */
+export interface Settings {
+    apiKey?: string;
+    domain?: string;
+    folderType?: FolderType;
+    lastUpdated?: string;
+    outputDir?: string;
+    projectIdOrKey?: string;
+}
+/**
+ * 設定ファイルのパスを取得する
+ * @param directory 設定ファイルを保存するディレクトリ
+ * @returns 設定ファイルのパス
+ */
+export declare function getSettingsFilePath(directory: string): string;
+/**
+ * 設定ファイルを読み込む
+ * @param directory 設定ファイルが保存されているディレクトリ
+ * @returns 設定情報
+ */
+export declare function loadSettings(directory: string): Promise<Settings>;
+/**
+ * 設定ファイルを保存する
+ * @param directory 設定ファイルを保存するディレクトリ
+ * @param settings 保存する設定情報
+ */
+export declare function saveSettings(directory: string, settings: Settings): Promise<void>;
+/**
+ * 設定ファイルを更新する
+ * @param directory 設定ファイルを保存するディレクトリ
+ * @param newSettings 更新する設定情報
+ */
+export declare function updateSettings(directory: string, newSettings: Partial<Settings>): Promise<Settings>;

package/dist/utils/settings.js

@@ -0,0 +1,60 @@
+import * as fs from 'node:fs/promises';
+import { join } from 'node:path';
+/**
+ * フォルダタイプの定義
+ */
+export var FolderType;
+(function (FolderType) {
+    FolderType["ISSUE"] = "issue";
+    FolderType["WIKI"] = "wiki";
+})(FolderType || (FolderType = {}));
+/**
+ * 設定ファイルのパスを取得する
+ * @param directory 設定ファイルを保存するディレクトリ
+ * @returns 設定ファイルのパス
+ */
+export function getSettingsFilePath(directory) {
+    return join(directory, 'backlog-settings.json');
+}
+/**
+ * 設定ファイルを読み込む
+ * @param directory 設定ファイルが保存されているディレクトリ
+ * @returns 設定情報
+ */
+export async function loadSettings(directory) {
+    const settingsPath = getSettingsFilePath(directory);
+    try {
+        const data = await fs.readFile(settingsPath, 'utf8');
+        return JSON.parse(data);
+    }
+    catch {
+        // ファイルが存在しない場合や読み込みエラーの場合は空のオブジェクトを返す
+        return {};
+    }
+}
+/**
+ * 設定ファイルを保存する
+ * @param directory 設定ファイルを保存するディレクトリ
+ * @param settings 保存する設定情報
+ */
+export async function saveSettings(directory, settings) {
+    const settingsPath = getSettingsFilePath(directory);
+    // ディレクトリが存在しない場合は作成
+    await fs.mkdir(directory, { recursive: true });
+    // 設定ファイルを保存
+    await fs.writeFile(settingsPath, JSON.stringify(settings, null, 2), 'utf8');
+}
+/**
+ * 設定ファイルを更新する
+ * @param directory 設定ファイルを保存するディレクトリ
+ * @param newSettings 更新する設定情報
+ */
+export async function updateSettings(directory, newSettings) {
+    // 既存の設定を読み込む
+    const currentSettings = await loadSettings(directory);
+    // 新しい設定で更新
+    const updatedSettings = { ...currentSettings, ...newSettings };
+    // 更新した設定を保存
+    await saveSettings(directory, updatedSettings);
+    return updatedSettings;
+}