backlog-exporter 0.0.6

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

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class Hello extends Command {
+    static args: {
+        person: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        from: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/hello/index.js

@@ -0,0 +1,19 @@
+import { Args, Command, Flags } from '@oclif/core';
+export default class Hello extends Command {
+    static args = {
+        person: Args.string({ description: 'Person to say hello to', required: true }),
+    };
+    static description = 'Say hello';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> friend --from oclif
+hello friend from oclif! (./src/commands/hello/index.ts)
+`,
+    ];
+    static flags = {
+        from: Flags.string({ char: 'f', description: 'Who is saying hello', required: true }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Hello);
+        this.log(`hello ${args.person} from ${flags.from}! (./src/commands/hello/index.ts)`);
+    }
+}

package/dist/commands/hello/world.d.ts

@@ -0,0 +1,8 @@
+import { Command } from '@oclif/core';
+export default class World extends Command {
+    static args: {};
+    static description: string;
+    static examples: string[];
+    static flags: {};
+    run(): Promise<void>;
+}

package/dist/commands/hello/world.js

@@ -0,0 +1,14 @@
+import { Command } from '@oclif/core';
+export default class World extends Command {
+    static args = {};
+    static description = 'Say hello world';
+    static examples = [
+        `<%= config.bin %> <%= command.id %>
+hello world! (./src/commands/hello/world.ts)
+`,
+    ];
+    static flags = {};
+    async run() {
+        this.log('hello world! (./src/commands/hello/world.ts)');
+    }
+}

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

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+export default class DownloadIssue extends Command {
+    static args: {
+        url: 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>;
+        count: import("@oclif/core/interfaces").OptionFlag<number, 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>;
+        projectIdOrKey: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        statusId: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/issue/index.js

@@ -0,0 +1,53 @@
+import { Args, Command, Flags } from '@oclif/core';
+import * as dotenv from 'dotenv';
+import { downloadIssues } from '../../utils/backlog-api.js';
+import { validateAndGetProjectId } from '../../utils/backlog.js';
+import { createOutputDirectory, getApiKey } from '../../utils/common.js';
+// .envファイルを読み込む
+dotenv.config();
+export default class DownloadIssue extends Command {
+    static args = {
+        url: Args.string({ description: 'URL to download from', required: false }),
+    };
+    static description = 'Backlogから課題をダウンロードする';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> --domain cm1.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./issue-data
+BacklogからAPIキーを使用して課題をダウンロードする
+`,
+    ];
+    static flags = {
+        apiKey: Flags.string({
+            description: 'Backlog API key (環境変数 BACKLOG_API_KEY からも自動読み取り可能)',
+            required: false,
+        }),
+        count: Flags.integer({ char: 'c', default: 100, description: '一度に取得する課題数', required: false }),
+        domain: Flags.string({ description: 'Backlog domain (e.g. example.backlog.jp)', required: true }),
+        output: Flags.string({
+            char: 'o',
+            default: './backlog-issues',
+            description: '出力ディレクトリパス',
+            required: false,
+        }),
+        projectIdOrKey: Flags.string({ description: 'Backlog project ID or key', required: true }),
+        statusId: Flags.string({ description: 'Filter issues by status ID', required: false }),
+    };
+    async run() {
+        const { flags } = await this.parse(DownloadIssue);
+        const { count, domain, output: outputDir, projectIdOrKey, statusId } = flags;
+        const apiKey = getApiKey(this, flags.apiKey);
+        this.log(`Backlogから ${domain} のプロジェクト ${projectIdOrKey} の課題を取得しています...`);
+        try {
+            // プロジェクトキーからプロジェクトIDを取得
+            const projectId = await validateAndGetProjectId(domain, projectIdOrKey, apiKey);
+            this.log(`プロジェクトID: ${projectId} を使用します`);
+            // 出力ディレクトリの作成
+            await createOutputDirectory(outputDir);
+            // 課題のダウンロード
+            await downloadIssues(this, domain, projectId, apiKey, outputDir, count, statusId);
+            this.log('ダウンロードが完了しました！');
+        }
+        catch (error) {
+            this.error(`ダウンロードに失敗しました: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+}

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

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+export default class DownloadWiki extends Command {
+    static args: {
+        url: 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, import("@oclif/core/interfaces").CustomOptions>;
+        output: import("@oclif/core/interfaces").OptionFlag<string, 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

@@ -0,0 +1,42 @@
+import { Args, Command, Flags } from '@oclif/core';
+import * as dotenv from 'dotenv';
+import { downloadWikis } from '../../utils/backlog-api.js';
+import { createOutputDirectory, getApiKey } from '../../utils/common.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コンテンツをダウンロードする';
+    static examples = [
+        `<%= config.bin %> <%= command.id %> --domain cm1.backlog.jp --projectIdOrKey PROJECT_KEY --apiKey YOUR_API_KEY --output ./wiki-data
+BacklogからAPIキーを使用してWikiコンテンツをダウンロードする
+`,
+    ];
+    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: true }),
+        output: Flags.string({ char: 'o', default: './backlog-wiki', 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を取得しています...`);
+        try {
+            // 出力ディレクトリの作成
+            await createOutputDirectory(outputDir);
+            // Wikiのダウンロード
+            await downloadWikis(this, domain, projectIdOrKey, apiKey, outputDir);
+            this.log('ダウンロードが完了しました！');
+        }
+        catch (error) {
+            this.error(`ダウンロードに失敗しました: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/utils/backlog-api.d.ts

@@ -0,0 +1,21 @@
+import { Command } from '@oclif/core';
+/**
+ * Backlogから課題をダウンロードする
+ * @param command コマンドインスタンス
+ * @param domain Backlogドメイン
+ * @param projectId プロジェクトID
+ * @param apiKey APIキー
+ * @param outputDir 出力ディレクトリ
+ * @param count 一度に取得する課題数
+ * @param statusId ステータスID（オプション）
+ */
+export declare function downloadIssues(command: Command, domain: string, projectId: number, apiKey: string, outputDir: string, count: number, statusId?: string): Promise<void>;
+/**
+ * BacklogからWikiをダウンロードする
+ * @param command コマンドインスタンス
+ * @param domain Backlogドメイン
+ * @param projectIdOrKey プロジェクトIDまたはキー
+ * @param apiKey APIキー
+ * @param outputDir 出力ディレクトリ
+ */
+export declare function downloadWikis(command: Command, domain: string, projectIdOrKey: string, apiKey: string, outputDir: string): Promise<void>;

package/dist/utils/backlog-api.js

@@ -0,0 +1,141 @@
+import ky from 'ky';
+import * as fs from 'node:fs/promises';
+import path from 'node:path';
+import { sanitizeFileName, sanitizeWikiFileName } from './common.js';
+/**
+ * Backlogから課題をダウンロードする
+ * @param command コマンドインスタンス
+ * @param domain Backlogドメイン
+ * @param projectId プロジェクトID
+ * @param apiKey APIキー
+ * @param outputDir 出力ディレクトリ
+ * @param count 一度に取得する課題数
+ * @param statusId ステータスID（オプション）
+ */
+export async function downloadIssues(command, domain, projectId, apiKey, outputDir, count, statusId) {
+    const baseUrl = `https://${domain}/api/v2`;
+    command.log('課題の取得を開始します...');
+    // APIパラメータの構築
+    const params = new URLSearchParams({
+        apiKey,
+        count: count.toString(),
+        'projectId[]': projectId.toString(),
+    });
+    // ステータスIDが指定されている場合は追加
+    if (statusId) {
+        params.append('statusId[]', statusId);
+    }
+    const issues = await ky.get(`${baseUrl}/issues?${params.toString()}`).json();
+    command.log(`${issues.length}件の課題が見つかりました。`);
+    // 各課題の詳細情報を取得して保存
+    command.log('課題を保存しています...');
+    // Promise.allを使用して並列処理
+    const issuePromises = issues.map(async (issue) => {
+        try {
+            // 課題の詳細情報をJSONファイルとして保存
+            const issueFileName = `${sanitizeFileName(issue.summary)}.md`;
+            const issueFilePath = path.join(outputDir, issueFileName);
+            // BacklogのIssueへのリンクを作成
+            const backlogIssueUrl = `https://${domain}/view/${issue.issueKey}`;
+            // コメント一覧を取得
+            command.log(`課題 ${issue.issueKey} のコメントを取得しています...`);
+            const commentsParams = new URLSearchParams({
+                apiKey,
+                count: '100', // 最大100件のコメントを取得
+                order: 'asc', // 古い順に取得
+            });
+            const comments = await ky.get(`${baseUrl}/issues/${issue.issueKey}/comments?${commentsParams.toString()}`).json();
+            // コメントセクションを作成
+            let commentsSection = '';
+            if (comments.length > 0) {
+                commentsSection = '\n\n## コメント\n';
+                let commentIndex = 1;
+                for (const comment of comments) {
+                    const commentDate = new Date(comment.created).toLocaleString('ja-JP');
+                    commentsSection += `\n### コメント ${commentIndex}\n- **投稿者**: ${comment.createdUser.name}\n- **日時**: ${commentDate}\n\n${comment.content || '(内容なし)'}\n\n---\n`;
+                    commentIndex++;
+                }
+                // 最後の区切り線を削除
+                commentsSection = commentsSection.slice(0, -5);
+            }
+            // Markdownファイルに書き込む
+            const assigneeName = issue.assignee ? issue.assignee.name : '未割り当て';
+            const markdownContent = `# ${issue.summary}
+
+## 基本情報
+- 課題キー: ${issue.issueKey}
+- ステータス: ${issue.status.name}
+- 優先度: ${issue.priority.name}
+- 担当者: ${assigneeName}
+- 作成日時: ${new Date(issue.created).toLocaleString('ja-JP')}
+- 更新日時: ${new Date(issue.updated).toLocaleString('ja-JP')}
+- [Backlog Issue Link](${backlogIssueUrl})
+
+## 詳細
+${issue.description || '詳細情報なし'}${commentsSection}`;
+            await fs.writeFile(issueFilePath, markdownContent);
+            command.log(`課題 "${issue.issueKey}: ${issue.summary}" を ${issueFilePath} に保存しました`);
+        }
+        catch (error) {
+            command.warn(`課題 ${issue.issueKey} の保存に失敗しました: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    });
+    await Promise.all(issuePromises);
+    command.log('課題のダウンロードが完了しました！');
+}
+/**
+ * BacklogからWikiをダウンロードする
+ * @param command コマンドインスタンス
+ * @param domain Backlogドメイン
+ * @param projectIdOrKey プロジェクトIDまたはキー
+ * @param apiKey APIキー
+ * @param outputDir 出力ディレクトリ
+ */
+export async function downloadWikis(command, domain, projectIdOrKey, apiKey, outputDir) {
+    const baseUrl = `https://${domain}/api/v2`;
+    command.log('Wikiの取得を開始します...');
+    // Wiki一覧の取得
+    command.log('Wiki一覧を取得しています...');
+    const wikis = await ky
+        .get(`${baseUrl}/wikis?apiKey=${apiKey}&projectIdOrKey=${projectIdOrKey}`)
+        .json();
+    command.log(`${wikis.length}件のWikiが見つかりました。`);
+    // 各Wikiの詳細情報を取得
+    command.log('Wiki詳細を取得しています...');
+    // Promise.allを使用して並列処理
+    const wikiPromises = wikis.map(async (wiki) => {
+        const wikiId = wiki.id;
+        command.log(`Wiki: ${wiki.name} (ID: ${wikiId}) を取得しています`);
+        try {
+            const wikiDetail = await ky
+                .get(`${baseUrl}/wikis/${wikiId}?projectIdOrKey=${projectIdOrKey}&apiKey=${apiKey}`)
+                .json();
+            // Wikiの名前をファイルパスとして使用
+            const wikiName = wiki.name;
+            // ファイル名のサニタイズ
+            const sanitizedName = sanitizeWikiFileName(wikiName);
+            // ファイル名の拡張子を追加
+            const wikiFileName = `${sanitizedName}.md`;
+            // ディレクトリ構造を作成（必要な場合）
+            const dirPath = path.dirname(wikiFileName);
+            if (dirPath !== '.') {
+                await fs.mkdir(path.join(outputDir, dirPath), { recursive: true });
+            }
+            // Markdownファイルを保存
+            const wikiFilePath = path.join(outputDir, wikiFileName);
+            // JSONからcontentフィールドを取得
+            const content = wikiDetail.content || '';
+            // BacklogのWikiへのリンクを作成
+            const backlogWikiUrl = `https://${domain}/alias/wiki/${wikiId}`;
+            // Markdownファイルに書き込む（タイトルとBacklogリンクを追加）
+            const markdownContent = `# ${wiki.name}\n\n[Backlog Wiki Link](${backlogWikiUrl})\n\n${content}`;
+            await fs.writeFile(wikiFilePath, markdownContent);
+            command.log(`Wiki "${wiki.name}" を ${wikiFilePath} に保存しました`);
+        }
+        catch (error) {
+            command.warn(`Wiki ID ${wikiId} の取得に失敗しました: ${error instanceof Error ? error.message : String(error)}`);
+        }
+    });
+    await Promise.all(wikiPromises);
+    command.log('Wikiのダウンロードが完了しました！');
+}

package/dist/utils/backlog.d.ts

@@ -0,0 +1,16 @@
+/**
+ * プロジェクトキーからプロジェクトIDを取得する
+ * @param domain Backlogドメイン (例: example.backlog.jp)
+ * @param projectKey プロジェクトキー
+ * @param apiKey BacklogのAPIキー
+ * @returns プロジェクトID
+ */
+export declare function getProjectIdFromKey(domain: string, projectKey: string, apiKey: string): Promise<number>;
+/**
+ * プロジェクトIDまたはキーを検証し、必要に応じてキーからIDを取得する
+ * @param domain Backlogドメイン
+ * @param projectIdOrKey プロジェクトIDまたはキー
+ * @param apiKey BacklogのAPIキー
+ * @returns プロジェクトID
+ */
+export declare function validateAndGetProjectId(domain: string, projectIdOrKey: string, apiKey: string): Promise<number>;

package/dist/utils/backlog.js

@@ -0,0 +1,34 @@
+import ky from 'ky';
+/**
+ * プロジェクトキーからプロジェクトIDを取得する
+ * @param domain Backlogドメイン (例: example.backlog.jp)
+ * @param projectKey プロジェクトキー
+ * @param apiKey BacklogのAPIキー
+ * @returns プロジェクトID
+ */
+export async function getProjectIdFromKey(domain, projectKey, apiKey) {
+    try {
+        const baseUrl = `https://${domain}/api/v2`;
+        const projectUrl = `${baseUrl}/projects/${projectKey}?apiKey=${apiKey}`;
+        const projectData = await ky.get(projectUrl).json();
+        return projectData.id;
+    }
+    catch (error) {
+        throw new Error(`プロジェクトキー "${projectKey}" からプロジェクトIDの取得に失敗しました: ${error instanceof Error ? error.message : String(error)}`);
+    }
+}
+/**
+ * プロジェクトIDまたはキーを検証し、必要に応じてキーからIDを取得する
+ * @param domain Backlogドメイン
+ * @param projectIdOrKey プロジェクトIDまたはキー
+ * @param apiKey BacklogのAPIキー
+ * @returns プロジェクトID
+ */
+export async function validateAndGetProjectId(domain, projectIdOrKey, apiKey) {
+    // 数値の場合はそのままプロジェクトIDとして返す
+    if (!Number.isNaN(Number(projectIdOrKey))) {
+        return Number(projectIdOrKey);
+    }
+    // 文字列の場合はプロジェクトキーとして扱い、IDを取得する
+    return getProjectIdFromKey(domain, projectIdOrKey, apiKey);
+}

package/dist/utils/common.d.ts

@@ -0,0 +1,25 @@
+import { Command } from '@oclif/core';
+/**
+ * APIキーを取得する（優先順位: コマンドライン引数 > 環境変数）
+ * @param command コマンドインスタンス
+ * @param providedApiKey コマンドライン引数から提供されたAPIキー
+ * @returns APIキー
+ */
+export declare function getApiKey(command: Command, providedApiKey?: string): string;
+/**
+ * ファイル名に使用できない文字を置換する関数
+ * @param name 元のファイル名
+ * @returns サニタイズされたファイル名
+ */
+export declare function sanitizeFileName(name: string): string;
+/**
+ * Wikiファイル名のサニタイズ（スラッシュはディレクトリ区切りとして使用するため残す）
+ * @param name 元のWiki名
+ * @returns サニタイズされたWikiファイル名
+ */
+export declare function sanitizeWikiFileName(name: string): string;
+/**
+ * 出力ディレクトリを作成する
+ * @param outputDir 出力ディレクトリパス
+ */
+export declare function createOutputDirectory(outputDir: string): Promise<void>;

package/dist/utils/common.js

@@ -0,0 +1,54 @@
+import * as fs from 'node:fs/promises';
+/**
+ * APIキーを取得する（優先順位: コマンドライン引数 > 環境変数）
+ * @param command コマンドインスタンス
+ * @param providedApiKey コマンドライン引数から提供されたAPIキー
+ * @returns APIキー
+ */
+export function getApiKey(command, providedApiKey) {
+    // コマンドライン引数からのAPIキー
+    if (providedApiKey) {
+        return providedApiKey;
+    }
+    // 環境変数からのAPIキー
+    const envApiKey = process.env.BACKLOG_API_KEY;
+    if (envApiKey) {
+        command.log('環境変数 BACKLOG_API_KEY からAPIキーを使用します');
+        return envApiKey;
+    }
+    // APIキーが見つからない場合はエラー
+    command.error('APIキーが見つかりません。--apiKey フラグまたは BACKLOG_API_KEY 環境変数で提供してください');
+    return ''; // この行は実行されないが、TypeScriptのエラーを回避するために必要
+}
+/**
+ * ファイル名に使用できない文字を置換する関数
+ * @param name 元のファイル名
+ * @returns サニタイズされたファイル名
+ */
+export function sanitizeFileName(name) {
+    return name
+        .replaceAll(/[\\/:*?"<>|]/g, '_') // Windowsで使用できない文字を置換
+        .replaceAll(/\s+/g, '_') // スペースをアンダースコアに置換
+        .replaceAll('.', '_') // ドットを置換
+        .slice(0, 200); // 長すぎるファイル名を防ぐために200文字に制限
+}
+/**
+ * Wikiファイル名のサニタイズ（スラッシュはディレクトリ区切りとして使用するため残す）
+ * @param name 元のWiki名
+ * @returns サニタイズされたWikiファイル名
+ */
+export function sanitizeWikiFileName(name) {
+    const invalidChars = ['\\', ':', '*', '?', '"', '<', '>', '|'];
+    let sanitizedName = name;
+    for (const char of invalidChars) {
+        sanitizedName = sanitizedName.replaceAll(char, '_');
+    }
+    return sanitizedName;
+}
+/**
+ * 出力ディレクトリを作成する
+ * @param outputDir 出力ディレクトリパス
+ */
+export async function createOutputDirectory(outputDir) {
+    await fs.mkdir(outputDir, { recursive: true });
+}